diff --git a/docs/src/details/xml/editor/hotkeys.rst b/docs/src/details/xml/editor/hotkeys.rst new file mode 100644 index 0000000000..bfc7219535 --- /dev/null +++ b/docs/src/details/xml/editor/hotkeys.rst @@ -0,0 +1,22 @@ +.. _editor_hotkeys: + +======== +Overview +======== + +TODO: describe the purpose and advantages, it's related to XML, has tools (CLI, online share, figma), 3-4 paragraph + +Getting started +*************** + +TODO Work on Windows, Linux, MacOS and VSCode. Link the guides. + +Check out the examples (Learn by examples page) +or laern more about XML + +Project +******* + +What is a project? What can you describe in project.xml? How does nested projects work? + + diff --git a/docs/src/details/xml/editor/index.rst b/docs/src/details/xml/editor/index.rst new file mode 100644 index 0000000000..a3b78041eb --- /dev/null +++ b/docs/src/details/xml/editor/index.rst @@ -0,0 +1,14 @@ +.. _editor: + +========= +UI Editor +========= + +.. toctree:: + :class: toctree-1-deep + :maxdepth: 2 + + overview + install + vscode + hotkeys diff --git a/docs/src/details/xml/editor/install.rst b/docs/src/details/xml/editor/install.rst new file mode 100644 index 0000000000..5aade8cb39 --- /dev/null +++ b/docs/src/details/xml/editor/install.rst @@ -0,0 +1,28 @@ +.. _editor_install: + +============ +Installation +============ + +Works on Windows, Linux, MacOS and VSCode (Link the guides). + + +Windows +******* + +Instructions + +Troubleshooting +--------------- + +Linux +***** + +Troubleshooting +--------------- + +MacOS +***** + +Troubleshooting +--------------- diff --git a/docs/src/details/xml/editor/overview.rst b/docs/src/details/xml/editor/overview.rst new file mode 100644 index 0000000000..12cf53e7c3 --- /dev/null +++ b/docs/src/details/xml/editor/overview.rst @@ -0,0 +1,63 @@ +.. _editor_overview: + +======== +Overview +======== + +TODO: describe the purpose and advantages, it's related to XML, has tools (CLI, online share, figma), 3-4 paragraph + +Getting started +*************** + +TODO Work on Windows, Linux, MacOS and VSCode. Link the guides. + +Login and Licences (trial, buy licence on pro.lvgl.io, read more on the licences page) + +Check out the examples (Learn by examples page) +or learn more about XML + +User Interface +************** + +Screen shot, briefly describe the main parts + +XML Editor +---------- + +Autocomplete, validation + +Inspector +--------- + +- What is it? (show the rendered content, the user click on it to try out) +- How to use? (Press Ctrl or turn on by the button) + + - visualise bounding box, padding, maring and click area + - chege size and position by dragging + - measurement + - double click jumps to the XML file + - single click focuses the matching XML + +20 sec video to show all these + + +How does it work? +***************** + +- LVGL has a built-in XML parser that can create UIs at runtime +- the inspector uses LVGL as it is +- the editor sends the XML files to LVGL +- the editor ask LVGL to create an instance of the opened XML file +- when the xml changes only the opened XML file is uploaded, the screen is cleared, and a new instance is created +- the XML editor parses the XML files of the LVGL widgets and the user's XML files to validate the XMLs +- code is also exported by parsing the XML files + +Project +******* + +- What is a project? +- What can you describe in project.xml? +- How does nested projects work? + + + diff --git a/docs/src/details/xml/editor/vscode.rst b/docs/src/details/xml/editor/vscode.rst new file mode 100644 index 0000000000..e809171744 --- /dev/null +++ b/docs/src/details/xml/editor/vscode.rst @@ -0,0 +1,19 @@ +.. _editor_vscode: + +================ +VSCode extension +================ + + +Overview +********* + +General overview + +Works on Windows, Linux, MacOS too (Link the guides). + +Usage +***** + +Troubleshooting +*************** diff --git a/docs/src/details/xml/index.rst b/docs/src/details/xml/index.rst index 24022471e3..ea4bfd961e 100644 --- a/docs/src/details/xml/index.rst +++ b/docs/src/details/xml/index.rst @@ -1,16 +1,21 @@ -.. _xml_main: +.. _editor_and_xml: -==================== -XML - Declarative UI -==================== +================= +UI Editor and XML +================= .. toctree:: :class: toctree-1-deep :maxdepth: 2 - overview/index + intro + learn_by_examples + editor/index + xml/index + integration/index ui_elements/index assets/index features/index - license + tools/index + license/index diff --git a/docs/src/details/xml/integration/c_code.rst b/docs/src/details/xml/integration/c_code.rst new file mode 100644 index 0000000000..a0ee7a688c --- /dev/null +++ b/docs/src/details/xml/integration/c_code.rst @@ -0,0 +1,7 @@ +.. _editor_integration_c: + +======================= +Use the exported C code +======================= + + diff --git a/docs/src/details/xml/integration/index.rst b/docs/src/details/xml/integration/index.rst new file mode 100644 index 0000000000..60dc1eb491 --- /dev/null +++ b/docs/src/details/xml/integration/index.rst @@ -0,0 +1,13 @@ +.. _editor_integration: + +=========== +Integration +=========== + +.. toctree:: + :class: toctree-1-deep + :maxdepth: 2 + + overview + c_code + xml diff --git a/docs/src/details/xml/integration/overview.rst b/docs/src/details/xml/integration/overview.rst new file mode 100644 index 0000000000..f7a94f631d --- /dev/null +++ b/docs/src/details/xml/integration/overview.rst @@ -0,0 +1,7 @@ +.. _editor_integration_overview: + +======== +Overview +======== + + diff --git a/docs/src/details/xml/integration/xml.rst b/docs/src/details/xml/integration/xml.rst new file mode 100644 index 0000000000..b1d1d5fe28 --- /dev/null +++ b/docs/src/details/xml/integration/xml.rst @@ -0,0 +1,7 @@ +.. _editor_integration_xml: + +==================== +Load XMLs at runtime +==================== + + diff --git a/docs/src/details/xml/intro.rst b/docs/src/details/xml/intro.rst new file mode 100644 index 0000000000..23a3489966 --- /dev/null +++ b/docs/src/details/xml/intro.rst @@ -0,0 +1,8 @@ +.. _xml_intro: + +============ +Introduction +============ + +3-4 paragraph about what is the Editor and XML, for what it can be used, why is it good, +tools, etc. All with link. No subsections. diff --git a/docs/src/details/xml/learn_by_examples.rst b/docs/src/details/xml/learn_by_examples.rst new file mode 100644 index 0000000000..2a5c3b98dd --- /dev/null +++ b/docs/src/details/xml/learn_by_examples.rst @@ -0,0 +1,11 @@ +.. _editor_learn_by_examples: + +================= +Learn by Examples +================= + +TODO + +Add 1 paragraph of description for each folder in lvgl/examples/xml +and button to open them in the online preview + diff --git a/docs/src/details/xml/license/editor.rst b/docs/src/details/xml/license/editor.rst new file mode 100644 index 0000000000..1e3ee4dde8 --- /dev/null +++ b/docs/src/details/xml/license/editor.rst @@ -0,0 +1,7 @@ +.. _editor_license: + +============== +Editor license +============== + +TODO: describe the pricing models and conditions diff --git a/docs/src/details/xml/license/index.rst b/docs/src/details/xml/license/index.rst new file mode 100644 index 0000000000..78d4d67310 --- /dev/null +++ b/docs/src/details/xml/license/index.rst @@ -0,0 +1,13 @@ +.. _xml_editor_licences: + +======== +Licenses +======== + + +.. toctree:: + :class: toctree-1-deep + :maxdepth: 1 + + xml + editor diff --git a/docs/src/details/xml/license.rst b/docs/src/details/xml/license/xml.rst similarity index 99% rename from docs/src/details/xml/license.rst rename to docs/src/details/xml/license/xml.rst index 77535820e2..1d23d2e8a8 100644 --- a/docs/src/details/xml/license.rst +++ b/docs/src/details/xml/license/xml.rst @@ -1,8 +1,8 @@ .. _lvgl_xml_license: -======= -License -======= +=========== +XML License +=========== **Version 1.0 – June 2025** diff --git a/docs/src/details/xml/tools/cli.rst b/docs/src/details/xml/tools/cli.rst new file mode 100644 index 0000000000..5c08a1a63b --- /dev/null +++ b/docs/src/details/xml/tools/cli.rst @@ -0,0 +1,23 @@ + +.. _editor_cli: + +=== +CLI +=== + +Overview +******** + +Usage +***** + +Arguments +--------- + +Using locally +------------- + +Using in CI/CD +-------------- + + diff --git a/docs/src/details/xml/tools/figma.rst b/docs/src/details/xml/tools/figma.rst new file mode 100644 index 0000000000..c81afd36c7 --- /dev/null +++ b/docs/src/details/xml/tools/figma.rst @@ -0,0 +1,24 @@ + +.. _editor_figma: + +================= +Figma integration +================= + +Overview +******** + +Usage +***** + + +LVGL Figma plugin +----------------- + +Connect Figma to the Editor +--------------------------- + + +Sync data +--------- + diff --git a/docs/src/details/xml/tools/index.rst b/docs/src/details/xml/tools/index.rst new file mode 100644 index 0000000000..aaa2575217 --- /dev/null +++ b/docs/src/details/xml/tools/index.rst @@ -0,0 +1,14 @@ +.. _xml_tool: + +===== +Tools +===== + + +.. toctree:: + :class: toctree-1-deep + :maxdepth: 2 + + cli + online_share + figma diff --git a/docs/src/details/xml/tools/online_share.rst b/docs/src/details/xml/tools/online_share.rst new file mode 100644 index 0000000000..335bf801f9 --- /dev/null +++ b/docs/src/details/xml/tools/online_share.rst @@ -0,0 +1,12 @@ + +.. _editor_online_share: + +============ +Online Share +============ + +Overview +******** + +Usage +***** diff --git a/docs/src/details/xml/overview/index.rst b/docs/src/details/xml/xml/index.rst similarity index 53% rename from docs/src/details/xml/overview/index.rst rename to docs/src/details/xml/xml/index.rst index fb6595e184..1ea079966b 100644 --- a/docs/src/details/xml/overview/index.rst +++ b/docs/src/details/xml/xml/index.rst @@ -1,13 +1,13 @@ -.. _xml_overview: +.. _xml_main: + +============ +XML Overview +============ -======== -Overview -======== .. toctree:: :class: toctree-1-deep :maxdepth: 2 - intro + overview syntax - diff --git a/docs/src/details/xml/overview/intro.rst b/docs/src/details/xml/xml/overview.rst similarity index 99% rename from docs/src/details/xml/overview/intro.rst rename to docs/src/details/xml/xml/overview.rst index 827cd64a32..0ff3e3b3a7 100644 --- a/docs/src/details/xml/overview/intro.rst +++ b/docs/src/details/xml/xml/overview.rst @@ -1,8 +1,9 @@ -.. _xml_intro: +.. _xml_overview: + +======== +Overview +======== -============ -Introduction -============ .. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE :trim: diff --git a/docs/src/details/xml/overview/syntax.rst b/docs/src/details/xml/xml/syntax.rst similarity index 100% rename from docs/src/details/xml/overview/syntax.rst rename to docs/src/details/xml/xml/syntax.rst