From 23f64e5414052e287a3e249bd613d4e18901eb7f Mon Sep 17 00:00:00 2001 From: Victor Wheeler Date: Thu, 30 Oct 2025 10:16:46 -0600 Subject: [PATCH] docs: factor out repeated substitution definitions (#9125) --- .../boards/manufacturers/toradex.rst | 3 +- .../integration/chip_vendors/nxp/overview.rst | 3 +- .../chip_vendors/renesas/glcdc.rst | 14 +- .../chip_vendors/renesas/ra_family.rst | 3 +- .../chip_vendors/renesas/rx_family.rst | 3 +- .../chip_vendors/renesas/rza_family.rst | 3 +- .../integration/chip_vendors/stm32/ltdc.rst | 4 +- docs/src/details/libs/gif.rst | 3 +- docs/src/details/libs/libjpeg_turbo.rst | 3 +- docs/src/details/libs/libpng.rst | 3 +- docs/src/details/libs/lodepng.rst | 3 +- .../main-modules/draw/draw_descriptors.rst | 2 +- docs/src/details/main-modules/font.rst | 11 +- docs/src/details/widgets/image.rst | 3 +- docs/src/details/widgets/index.rst | 7 +- docs/src/details/widgets/label.rst | 3 +- docs/src/details/widgets/scale.rst | 3 +- docs/src/details/xml/assets/fonts.rst | 4 +- docs/src/details/xml/assets/images.rst | 4 +- docs/src/details/xml/editor/index.rst | 1 - docs/src/details/xml/editor/install.rst | 2 +- docs/src/details/xml/editor/overview.rst | 2 +- docs/src/details/xml/editor/substitutions.txt | 4 - .../src/details/xml/editor/user_interface.rst | 2 +- docs/src/details/xml/tools/figma.rst | 2 +- docs/src/details/xml/ui_elements/preview.rst | 4 +- docs/src/details/xml/ui_elements/screens.rst | 4 +- docs/src/details/xml/ui_elements/widgets.rst | 4 +- docs/src/details/xml/xml/overview.rst | 13 +- docs/src/details/xml/xml/syntax.rst | 4 +- docs/src/include/substitutions.txt | 194 ++++++++++++++++++ 31 files changed, 239 insertions(+), 79 deletions(-) delete mode 100644 docs/src/details/xml/editor/substitutions.txt create mode 100644 docs/src/include/substitutions.txt diff --git a/docs/src/details/integration/boards/manufacturers/toradex.rst b/docs/src/details/integration/boards/manufacturers/toradex.rst index e6bda0e1a2..e199df4096 100644 --- a/docs/src/details/integration/boards/manufacturers/toradex.rst +++ b/docs/src/details/integration/boards/manufacturers/toradex.rst @@ -1,7 +1,6 @@ +.. include:: /include/substitutions.txt .. _toradex: -.. |reg| unicode:: U+000AE .. REGISTERED SIGN - ======= Toradex ======= diff --git a/docs/src/details/integration/chip_vendors/nxp/overview.rst b/docs/src/details/integration/chip_vendors/nxp/overview.rst index 305f2677ea..92b6ea9d47 100644 --- a/docs/src/details/integration/chip_vendors/nxp/overview.rst +++ b/docs/src/details/integration/chip_vendors/nxp/overview.rst @@ -1,9 +1,8 @@ +.. include:: /include/substitutions.txt ======== Overview ======== -.. |deg| unicode:: U+000B0 .. DEGREE SIGN - NXP has integrated LVGL into the MCUXpresso SDK packages for several of our microcontrollers as an optional software component, allowing easy evaluation and migration into your product design. LVGL is a free and open-source embedded diff --git a/docs/src/details/integration/chip_vendors/renesas/glcdc.rst b/docs/src/details/integration/chip_vendors/renesas/glcdc.rst index 1a9c3ac85d..394867f64d 100644 --- a/docs/src/details/integration/chip_vendors/renesas/glcdc.rst +++ b/docs/src/details/integration/chip_vendors/renesas/glcdc.rst @@ -1,13 +1,12 @@ +.. include:: /include/substitutions.txt .. _renesas_glcdc: ============= Renesas GLCDC ============= -.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO - Overview --------- +******** .. image:: /_static/images/renesas/glcdc.png :alt: Architectural overview of Renesas GLCDC @@ -34,14 +33,17 @@ Check out the following repositories for ready-to-use examples: - `RX72N Envision Kit `__ + Prerequisites -------------- +************* - This driver relies on code generated by e\ |sup2| studio. Missing the step while setting up the project will cause a compilation error. - Activate the driver by setting :c:macro:`LV_USE_RENESAS_GLCDC` to ``1`` in your ``lv_conf.h``. + + Usage ------ +***** There is no need to implement any platform-specific functions. @@ -70,7 +72,7 @@ Buffer swapping can be activated by passing a second buffer of same size instead Screen rotation -""""""""""""""" +--------------- Software based screen rotation is supported in partial mode. It uses the common API, no extra configuration is required: diff --git a/docs/src/details/integration/chip_vendors/renesas/ra_family.rst b/docs/src/details/integration/chip_vendors/renesas/ra_family.rst index 2869f77e6d..38ae72770c 100644 --- a/docs/src/details/integration/chip_vendors/renesas/ra_family.rst +++ b/docs/src/details/integration/chip_vendors/renesas/ra_family.rst @@ -1,9 +1,8 @@ +.. include:: /include/substitutions.txt ========= RA Family ========= -.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO - .. |img_debug_btn| image:: /_static/images/renesas/debug_btn.png :alt: Debug button diff --git a/docs/src/details/integration/chip_vendors/renesas/rx_family.rst b/docs/src/details/integration/chip_vendors/renesas/rx_family.rst index 0d095f8558..e1d688c5e1 100644 --- a/docs/src/details/integration/chip_vendors/renesas/rx_family.rst +++ b/docs/src/details/integration/chip_vendors/renesas/rx_family.rst @@ -1,9 +1,8 @@ +.. include:: /include/substitutions.txt ========= RX Family ========= -.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO - .. |img_debug_btn| image:: /_static/images/renesas/debug_btn.png :alt: Debug button diff --git a/docs/src/details/integration/chip_vendors/renesas/rza_family.rst b/docs/src/details/integration/chip_vendors/renesas/rza_family.rst index aeb05fc24d..a5ab5128f1 100644 --- a/docs/src/details/integration/chip_vendors/renesas/rza_family.rst +++ b/docs/src/details/integration/chip_vendors/renesas/rza_family.rst @@ -1,9 +1,8 @@ +.. include:: /include/substitutions.txt =========== RZ/A Family =========== -.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO - Supported boards in the RZ/A Family: - **RZ/A3M** diff --git a/docs/src/details/integration/chip_vendors/stm32/ltdc.rst b/docs/src/details/integration/chip_vendors/stm32/ltdc.rst index 107da9602c..ffbffcab6c 100644 --- a/docs/src/details/integration/chip_vendors/stm32/ltdc.rst +++ b/docs/src/details/integration/chip_vendors/stm32/ltdc.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _stm32 ltdc driver: ========================= @@ -100,9 +101,6 @@ a single buffer if :c:macro:`LV_ST_LTDC_USE_DMA2D_FLUSH` is enabled. Linker Script ************* -.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN -.. |divide| unicode:: U+000F7 .. DIVISION SIGN - You should ensure the LTDC framebuffer memory is actually reserved in the linker script. This is a file that normally has the extension ``.ld``. In the below example, ``1125K`` is specified because the color depth is 24 (3 bytes per pixel), diff --git a/docs/src/details/libs/gif.rst b/docs/src/details/libs/gif.rst index 51406a35ce..ce494d3cb1 100644 --- a/docs/src/details/libs/gif.rst +++ b/docs/src/details/libs/gif.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _gif: =========== @@ -78,8 +79,6 @@ from files. To do so, follow the instructions in :ref:`file_system`. Memory Requirements ******************* -.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN - To decode and display a GIF animation ~25 kB of RAM is needed plus (color format pixel size + 1) |times| image width |times| image height. RGB565 has a pixel size of 2, RGB888 has a pixel size of 3, and diff --git a/docs/src/details/libs/libjpeg_turbo.rst b/docs/src/details/libs/libjpeg_turbo.rst index cb0c438096..e338f040f4 100644 --- a/docs/src/details/libs/libjpeg_turbo.rst +++ b/docs/src/details/libs/libjpeg_turbo.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _libjpeg: ===================== @@ -51,8 +52,6 @@ Set :c:macro:`LV_USE_LIBJPEG_TURBO` in ``lv_conf.h`` to ``1``. See the examples below. -.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN - It should be noted that each image decoded needs to consume: image width |times| image height |times| 3 diff --git a/docs/src/details/libs/libpng.rst b/docs/src/details/libs/libpng.rst index 7a4cf34b3f..1f0e9bbed4 100644 --- a/docs/src/details/libs/libpng.rst +++ b/docs/src/details/libs/libpng.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _libpng: ============== @@ -43,8 +44,6 @@ Set :c:macro:`LV_USE_LIBPNG` in ``lv_conf.h`` to ``1``. See the examples below. -.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN - It should be noted that each image of this decoder needs to consume width |times| height |times| 4 diff --git a/docs/src/details/libs/lodepng.rst b/docs/src/details/libs/lodepng.rst index 899c5ef7e4..13a4526b2c 100644 --- a/docs/src/details/libs/lodepng.rst +++ b/docs/src/details/libs/lodepng.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _lodepng_rst: =============== @@ -19,8 +20,6 @@ image source. A file system driver needs to be registered to open images from files. To do so, follow the instructions in :ref:`file_system`. -.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN - The whole PNG image is decoded, so width |times| height |times| 4 diff --git a/docs/src/details/main-modules/draw/draw_descriptors.rst b/docs/src/details/main-modules/draw/draw_descriptors.rst index b314122b13..6021e33a8a 100644 --- a/docs/src/details/main-modules/draw/draw_descriptors.rst +++ b/docs/src/details/main-modules/draw/draw_descriptors.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _draw_descriptors: ================ @@ -412,7 +413,6 @@ The following functions are used for box shadow drawing: :language: c -.. |deg| unicode:: U+000B0 .. DEGREE SIGN Image Draw Descriptor ********************* diff --git a/docs/src/details/main-modules/font.rst b/docs/src/details/main-modules/font.rst index 282732c07e..e6435203e0 100644 --- a/docs/src/details/main-modules/font.rst +++ b/docs/src/details/main-modules/font.rst @@ -1,11 +1,4 @@ -.. |check| unicode:: U+02713 .. CHECK MARK -.. |Aacute| unicode:: U+000C1 .. LATIN CAPITAL LETTER A WITH ACUTE -.. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE -.. |otilde| unicode:: U+000F5 .. LATIN SMALL LETTER O WITH TILDE -.. |Utilde| unicode:: U+00168 .. LATIN CAPITAL LETTER U WITH TILDE -.. |uuml| unicode:: U+000FC .. LATIN SMALL LETTER U WITH DIAERESIS -.. |uml| unicode:: U+000A8 .. DIAERESIS - +.. include:: /include/substitutions.txt .. _font: ============== @@ -77,7 +70,7 @@ Languages like Arabic, Persian, and Hebrew, which use Right-to-Left (RTL) or mixed writing directions, are also supported in LVGL. Learn more :ref:`here `. -For characters such as '|eacute|', '|uuml|', '|otilde|', '|Aacute|', and '|Utilde|', +For characters such as '|eacute|', '|uuml|', '|otilde|', '|Aacute|', and '|Uacute|', it is recommended to use the single Unicode format (NFC) rather than decomposing them into a base letter and diacritics (e.g. ``u`` + |uml|). diff --git a/docs/src/details/widgets/image.rst b/docs/src/details/widgets/image.rst index bac3a7189e..a09c8fa904 100644 --- a/docs/src/details/widgets/image.rst +++ b/docs/src/details/widgets/image.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _lv_image: ================ @@ -7,8 +8,6 @@ Image (lv_image) Overview ******** -.. |deg| unicode:: U+000B0 .. DEGREE SIGN - Images are Widgets that display images from flash (as arrays) or from files. Images can also display symbols (``LV_SYMBOL_...``). diff --git a/docs/src/details/widgets/index.rst b/docs/src/details/widgets/index.rst index eb0d8ec4d6..e7e1723e2b 100644 --- a/docs/src/details/widgets/index.rst +++ b/docs/src/details/widgets/index.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _widgets: =========== @@ -9,7 +10,7 @@ All Widgets base_widget -|hr_left_250| +|hr| .. toctree:: :class: toctree-1-deep @@ -50,7 +51,3 @@ All Widgets tileview win new_widget - -.. |hr_left_250| raw:: html - -
diff --git a/docs/src/details/widgets/label.rst b/docs/src/details/widgets/label.rst index 1874718281..04ee16dd2b 100644 --- a/docs/src/details/widgets/label.rst +++ b/docs/src/details/widgets/label.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _lv_label: ================ @@ -198,8 +199,6 @@ the :ref:`font` section to learn more about symbols. Data binding ------------ -.. |deg| unicode:: U+000B0 .. DEGREE SIGN - To get familiar with observers, subjects, and data bindings in general visit the :ref:`Observer ` page. diff --git a/docs/src/details/widgets/scale.rst b/docs/src/details/widgets/scale.rst index 8f81cb952f..a3474c7436 100644 --- a/docs/src/details/widgets/scale.rst +++ b/docs/src/details/widgets/scale.rst @@ -1,11 +1,10 @@ +.. include:: /include/substitutions.txt .. _lv_scale: ================ Scale (lv_scale) ================ -.. |deg| unicode:: U+000B0 .. DEGREE SIGN - Overview ******** diff --git a/docs/src/details/xml/assets/fonts.rst b/docs/src/details/xml/assets/fonts.rst index 641665207b..6732d55546 100644 --- a/docs/src/details/xml/assets/fonts.rst +++ b/docs/src/details/xml/assets/fonts.rst @@ -1,12 +1,10 @@ +.. include:: /include/substitutions.txt .. _xml_fonts: ===== Fonts ===== -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - Overview ******** diff --git a/docs/src/details/xml/assets/images.rst b/docs/src/details/xml/assets/images.rst index 3f80fa0c11..aea14e78eb 100644 --- a/docs/src/details/xml/assets/images.rst +++ b/docs/src/details/xml/assets/images.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _xml_images: ====== @@ -7,9 +8,6 @@ Images Overview ******** -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - In XML, images are considered external resources that need to be named in order to be referenced in XML files. Below is how to map images with names. diff --git a/docs/src/details/xml/editor/index.rst b/docs/src/details/xml/editor/index.rst index 6f416a1e21..803d60cbdd 100644 --- a/docs/src/details/xml/editor/index.rst +++ b/docs/src/details/xml/editor/index.rst @@ -1,4 +1,3 @@ -.. include:: substitutions.txt .. _editor: ====== diff --git a/docs/src/details/xml/editor/install.rst b/docs/src/details/xml/editor/install.rst index 1a892fbb3a..8182f82002 100644 --- a/docs/src/details/xml/editor/install.rst +++ b/docs/src/details/xml/editor/install.rst @@ -1,4 +1,4 @@ -.. include:: substitutions.txt +.. include:: /include/substitutions.txt .. _editor_install: ============ diff --git a/docs/src/details/xml/editor/overview.rst b/docs/src/details/xml/editor/overview.rst index 87ffe6429e..529bf3bdea 100644 --- a/docs/src/details/xml/editor/overview.rst +++ b/docs/src/details/xml/editor/overview.rst @@ -1,5 +1,5 @@ .. include:: /include/external_links.txt -.. include:: substitutions.txt +.. include:: /include/substitutions.txt .. _editor_overview: ======== diff --git a/docs/src/details/xml/editor/substitutions.txt b/docs/src/details/xml/editor/substitutions.txt deleted file mode 100644 index 2b4ba085e1..0000000000 --- a/docs/src/details/xml/editor/substitutions.txt +++ /dev/null @@ -1,4 +0,0 @@ -.. -------- Custom Substitutions -------- -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: -.. |lvglpro| replace:: LVGL |nbsp| Pro diff --git a/docs/src/details/xml/editor/user_interface.rst b/docs/src/details/xml/editor/user_interface.rst index c5cdeaa303..4c3965defb 100644 --- a/docs/src/details/xml/editor/user_interface.rst +++ b/docs/src/details/xml/editor/user_interface.rst @@ -1,4 +1,4 @@ -.. include:: substitutions.txt +.. include:: /include/substitutions.txt .. _user interface: ============== diff --git a/docs/src/details/xml/tools/figma.rst b/docs/src/details/xml/tools/figma.rst index ca1d3b906a..4edddc78cf 100644 --- a/docs/src/details/xml/tools/figma.rst +++ b/docs/src/details/xml/tools/figma.rst @@ -1,4 +1,4 @@ -.. include:: ../editor/substitutions.txt +.. include:: /include/substitutions.txt .. _editor_figma: ================= diff --git a/docs/src/details/xml/ui_elements/preview.rst b/docs/src/details/xml/ui_elements/preview.rst index 6c117d3c91..2a7357b993 100644 --- a/docs/src/details/xml/ui_elements/preview.rst +++ b/docs/src/details/xml/ui_elements/preview.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _xml_preview: ======= @@ -7,9 +8,6 @@ Preview Overview ******** -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - In ```` and ````, it is possible to define ```` tags. These are **not** exported to code and are **not** loaded from XML. diff --git a/docs/src/details/xml/ui_elements/screens.rst b/docs/src/details/xml/ui_elements/screens.rst index 3f07005eab..e473744198 100644 --- a/docs/src/details/xml/ui_elements/screens.rst +++ b/docs/src/details/xml/ui_elements/screens.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _xml_screens: ======= @@ -7,9 +8,6 @@ Screens Overview ******** -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - Screens work very similarly to Components. Both can be: - Loaded from XML diff --git a/docs/src/details/xml/ui_elements/widgets.rst b/docs/src/details/xml/ui_elements/widgets.rst index 4fd7870d3c..e5f1005b4a 100644 --- a/docs/src/details/xml/ui_elements/widgets.rst +++ b/docs/src/details/xml/ui_elements/widgets.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _xml_widgets: ======= @@ -7,9 +8,6 @@ Widgets Overview ******** -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - Besides Components and Screens, Widgets are the other main building blocks of UIs. The XML file of a Widget is wrapped in a ```` XML root element. diff --git a/docs/src/details/xml/xml/overview.rst b/docs/src/details/xml/xml/overview.rst index b4e117bb35..46ab845ad1 100644 --- a/docs/src/details/xml/xml/overview.rst +++ b/docs/src/details/xml/xml/overview.rst @@ -1,13 +1,10 @@ +.. include:: /include/substitutions.txt .. _xml_overview: ======== Overview ======== - -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - Introduction ************ @@ -38,11 +35,14 @@ providing features like: - Online share/preview for collaboration and testing - `Figma `__ integration to easily reimplement Figma designs + + UI Elements *********** It is important to distinguish between :dfn:`Widgets`, :dfn:`Components`, and :dfn:`Screens`. + Widgets ------- @@ -58,6 +58,7 @@ but rather compiled into the application as C code. The main characteristics of - They can be compound, containing other Widgets (e.g., ``Tabview``'s tabs, ``Dropdown``'s lists). - In the UI editor, they can also be described in XML to create visuals more quickly and export C code. + Components ---------- @@ -78,6 +79,7 @@ defining Components can be registered in LVGL, and after that, instances can be In other words, LVGL can read the XML files, "learn" the Components from them, and thereafter create children as part of Screens and other Components. + Screens ------- @@ -89,6 +91,8 @@ Screens - They do not have an API. - They can be referenced in screen load events. + + Global data *********** @@ -106,6 +110,7 @@ Multiple ``globals.xml`` files can be loaded if needed, but each will be saved i meaning duplicated items will be added only once. + Using the XML Files ******************* diff --git a/docs/src/details/xml/xml/syntax.rst b/docs/src/details/xml/xml/syntax.rst index 3d217400c9..55a0294c13 100644 --- a/docs/src/details/xml/xml/syntax.rst +++ b/docs/src/details/xml/xml/syntax.rst @@ -1,3 +1,4 @@ +.. include:: /include/substitutions.txt .. _xml_syntax: ====== @@ -9,9 +10,6 @@ Syntax Naming conventions ****************** -.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE - :trim: - - A standard XML syntax is used. - Lowercase letters with ``_`` separation are used for attribute names. - Tag names follow the usual variable-name rules: they must start with a letter or diff --git a/docs/src/include/substitutions.txt b/docs/src/include/substitutions.txt new file mode 100644 index 0000000000..0962f24ffe --- /dev/null +++ b/docs/src/include/substitutions.txt @@ -0,0 +1,194 @@ +.. ----------------------------------------------------- +.. Each substitution is sorted by its Unicode value +.. within each group, so you know where to put new ones. +.. The Latin1 Symbols group is the exception, which is +.. sorted alphabetically without regard for case. +.. -------- Custom Substitutions ----------------------- +.. |lvglpro| replace:: LVGL |nbsp| Pro +.. -------- Common Typographical Entities -------- +.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE + :trim: +.. |shy| unicode:: U+000AD .. SOFT HYPHEN + :trim: +.. |ensp| unicode:: U+02002 .. EN SPACE +.. |emsp| unicode:: U+02003 .. EM SPACE +.. |thinsp| unicode:: U+02009 .. THIN SPACE +.. |vthinsp| unicode:: U+0200A .. VERY THIN SPACE +.. |nbhyph| unicode:: U+02011 .. NO-BREAK HYPHEN + :trim: +.. |ndash| unicode:: U+02013 .. EN DASH +.. |mdash| unicode:: U+02014 .. EM DASH +.. -------- Common Symbols -------- +.. |cent| unicode:: U+000A2 .. CENT SIGN +.. |pound| unicode:: U+000A3 .. BRITISH POUNDS STERLING +.. |curren| unicode:: U+000A4 .. CURRENCY SIGN +.. |yen| unicode:: U+000A5 .. YEN SIGN +.. |brvbar| unicode:: U+000A6 .. BROKEN BAR +.. |sect| unicode:: U+000A7 .. SECTION SIGN +.. |copy| unicode:: U+000A9 .. COPYRIGHT +.. |ordf| unicode:: U+000AA .. FEMININE ORDINAL INDICATOR +.. |not| unicode:: U+000AC .. NOT SIGN +.. |reg| unicode:: U+000AE .. REGISTERED TRADEMARK +.. |macr| unicode:: U+000AF .. MACRON +.. |deg| unicode:: U+000B0 .. DEGREE SYMBOL +.. |plusmn| unicode:: U+000B1 .. PLUS-MINUS SIGN +.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO +.. |sup3| unicode:: U+000B3 .. SUPERSCRIPT THREE +.. |micro| unicode:: U+000B5 .. MICRO UNITS +.. |para| unicode:: U+000B6 .. PILCROW SIGN +.. |middot| unicode:: U+000B7 .. MIDDLE DOT +.. |sup1| unicode:: U+000B9 .. SUPERSCRIPT ONE +.. |ordm| unicode:: U+000BA .. MASCULINE ORDINAL INDICATOR +.. |frac14| unicode:: U+000BC .. VULGAR FRACTION ONE QUARTER (1/4) +.. |frac12| unicode:: U+000BD .. VULGAR FRACTION ONE HALF (1/2) +.. |half| unicode:: U+000BD .. 1/2 +.. |frac34| unicode:: U+000BE .. VULGAR FRACTION THREE QUARTERS (3/4) +.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN +.. |divide| unicode:: U+000F7 .. DIVISION SIGN +.. |ohm| unicode:: U+02126 .. OHM SIGN +.. |frac13| unicode:: U+02153 .. 1/3 +.. |frac23| unicode:: U+02154 .. 2/3 +.. |equiv| unicode:: U+02261 .. IDENTICAL TO +.. |check| unicode:: U+02713 .. CHECK MARK +.. -------- Latin1 Symbols -------- +.. |Aacute| unicode:: U+000C1 .. LATIN CAPITAL LETTER A WITH ACUTE +.. |aacute| unicode:: U+000E1 .. LATIN SMALL LETTER A WITH ACUTE +.. |Acirc| unicode:: U+000C2 .. LATIN CAPITAL LETTER A WITH CIRCUMFLEX +.. |acirc| unicode:: U+000E2 .. LATIN SMALL LETTER A WITH CIRCUMFLEX +.. |acute| unicode:: U+000B4 .. ACUTE ACCENT +.. |AElig| unicode:: U+000C6 .. LATIN CAPITAL LETTER AE +.. |aelig| unicode:: U+000E6 .. LATIN SMALL LETTER AE +.. |Agrave| unicode:: U+000C0 .. LATIN CAPITAL LETTER A WITH GRAVE +.. |agrave| unicode:: U+000E0 .. LATIN SMALL LETTER A WITH GRAVE +.. |Aring| unicode:: U+000C5 .. LATIN CAPITAL LETTER A WITH RING ABOVE +.. |aring| unicode:: U+000E5 .. LATIN SMALL LETTER A WITH RING ABOVE +.. |Atilde| unicode:: U+000C3 .. LATIN CAPITAL LETTER A WITH TILDE +.. |atilde| unicode:: U+000E3 .. LATIN SMALL LETTER A WITH TILDE +.. |Auml| unicode:: U+000C4 .. LATIN CAPITAL LETTER A WITH DIAERESIS +.. |auml| unicode:: U+000E4 .. LATIN SMALL LETTER A WITH DIAERESIS +.. |Ccedil| unicode:: U+000C7 .. LATIN CAPITAL LETTER C WITH CEDILLA +.. |ccedil| unicode:: U+000E7 .. LATIN SMALL LETTER C WITH CEDILLA +.. |cedil| unicode:: U+000B8 .. CEDILLA +.. |Eacute| unicode:: U+000C9 .. LATIN CAPITAL LETTER E WITH ACUTE +.. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE +.. |Ecirc| unicode:: U+000CA .. LATIN CAPITAL LETTER E WITH CIRCUMFLEX +.. |ecirc| unicode:: U+000EA .. LATIN SMALL LETTER E WITH CIRCUMFLEX +.. |Egrave| unicode:: U+000C8 .. LATIN CAPITAL LETTER E WITH GRAVE +.. |egrave| unicode:: U+000E8 .. LATIN SMALL LETTER E WITH GRAVE +.. |ETH| unicode:: U+000D0 .. LATIN CAPITAL LETTER ETH +.. |eth| unicode:: U+000F0 .. LATIN SMALL LETTER ETH +.. |Euml| unicode:: U+000CB .. LATIN CAPITAL LETTER E WITH DIAERESIS +.. |euml| unicode:: U+000EB .. LATIN SMALL LETTER E WITH DIAERESIS +.. |Iacute| unicode:: U+000CD .. LATIN CAPITAL LETTER I WITH ACUTE +.. |iacute| unicode:: U+000ED .. LATIN SMALL LETTER I WITH ACUTE +.. |Icirc| unicode:: U+000CE .. LATIN CAPITAL LETTER I WITH CIRCUMFLEX +.. |icirc| unicode:: U+000EE .. LATIN SMALL LETTER I WITH CIRCUMFLEX +.. |iexcl| unicode:: U+000A1 .. INVERTED EXCLAMATION MARK +.. |Igrave| unicode:: U+000CC .. LATIN CAPITAL LETTER I WITH GRAVE +.. |igrave| unicode:: U+000EC .. LATIN SMALL LETTER I WITH GRAVE +.. |iquest| unicode:: U+000BF .. INVERTED QUESTION MARK +.. |Iuml| unicode:: U+000CF .. LATIN CAPITAL LETTER I WITH DIAERESIS +.. |iuml| unicode:: U+000EF .. LATIN SMALL LETTER I WITH DIAERESIS +.. |laquo| unicode:: U+000AB .. LEFT-POINTING DOUBLE ANGLE QUOTATION MARK +.. |Ntilde| unicode:: U+000D1 .. LATIN CAPITAL LETTER N WITH TILDE +.. |ntilde| unicode:: U+000F1 .. LATIN SMALL LETTER N WITH TILDE +.. |Oacute| unicode:: U+000D3 .. LATIN CAPITAL LETTER O WITH ACUTE +.. |oacute| unicode:: U+000F3 .. LATIN SMALL LETTER O WITH ACUTE +.. |Ocirc| unicode:: U+000D4 .. LATIN CAPITAL LETTER O WITH CIRCUMFLEX +.. |ocirc| unicode:: U+000F4 .. LATIN SMALL LETTER O WITH CIRCUMFLEX +.. |Ograve| unicode:: U+000D2 .. LATIN CAPITAL LETTER O WITH GRAVE +.. |ograve| unicode:: U+000F2 .. LATIN SMALL LETTER O WITH GRAVE +.. |Oslash| unicode:: U+000D8 .. LATIN CAPITAL LETTER O WITH STROKE +.. |oslash| unicode:: U+000F8 .. LATIN SMALL LETTER O WITH STROKE +.. |Otilde| unicode:: U+000D5 .. LATIN CAPITAL LETTER O WITH TILDE +.. |otilde| unicode:: U+000F5 .. LATIN SMALL LETTER O WITH TILDE +.. |Ouml| unicode:: U+000D6 .. LATIN CAPITAL LETTER O WITH DIAERESIS +.. |ouml| unicode:: U+000F6 .. LATIN SMALL LETTER O WITH DIAERESIS +.. |raquo| unicode:: U+000BB .. RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK +.. |szlig| unicode:: U+000DF .. LATIN SMALL LETTER SHARP S +.. |THORN| unicode:: U+000DE .. LATIN CAPITAL LETTER THORN +.. |thorn| unicode:: U+000FE .. LATIN SMALL LETTER THORN +.. |Uacute| unicode:: U+000DA .. LATIN CAPITAL LETTER U WITH ACUTE +.. |uacute| unicode:: U+000FA .. LATIN SMALL LETTER U WITH ACUTE +.. |Ucirc| unicode:: U+000DB .. LATIN CAPITAL LETTER U WITH CIRCUMFLEX +.. |ucirc| unicode:: U+000FB .. LATIN SMALL LETTER U WITH CIRCUMFLEX +.. |Ugrave| unicode:: U+000D9 .. LATIN CAPITAL LETTER U WITH GRAVE +.. |ugrave| unicode:: U+000F9 .. LATIN SMALL LETTER U WITH GRAVE +.. |uml| unicode:: U+000A8 .. DIAERESIS +.. |Uuml| unicode:: U+000DC .. LATIN CAPITAL LETTER U WITH DIAERESIS +.. |uuml| unicode:: U+000FC .. LATIN SMALL LETTER U WITH DIAERESIS +.. |Yacute| unicode:: U+000DD .. LATIN CAPITAL LETTER Y WITH ACUTE +.. |yacute| unicode:: U+000FD .. LATIN SMALL LETTER Y WITH ACUTE +.. |yuml| unicode:: U+000FF .. LATIN SMALL LETTER Y WITH DIAERESIS +.. -------- Arrows -------- +.. |larr| unicode:: U+02190 .. LEFTWARDS ARROW +.. |rarr| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |lrarr| unicode:: U+02194 .. LEFT RIGHT ARROW +.. |lArr| unicode:: U+021D0 .. LEFTWARDS DOUBLE ARROW +.. |Leftarrow| unicode:: U+021D0 .. LEFTWARDS DOUBLE ARROW +.. |rArr| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |Implies| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |iff| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |Leftrightarrow| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |lAarr| unicode:: U+021DA .. LEFTWARDS TRIPLE ARROW +.. |Lleftarrow| unicode:: U+021DA .. LEFTWARDS TRIPLE ARROW +.. |rAarr| unicode:: U+021DB .. RIGHTWARDS TRIPLE ARROW +.. |Rrightarrow| unicode:: U+021DB .. RIGHTWARDS TRIPLE ARROW +.. |ldashedarrow| unicode:: U+021E0 .. LEFTWARDS DASHED ARROW +.. |rdashedarrow| unicode:: U+021E2 .. RIGHTWARDS DASHED ARROW +.. |lwhitearrow| unicode:: U+021E6 .. LEFTWARDS WHITE ARROW +.. |rwhitearrow| unicode:: U+021E8 .. RIGHTWARDS WHITE ARROW +.. |lindexblack| unicode:: U+0261A .. LEFT-POINTING INDEX FINGER, BLACK +.. |rindexblack| unicode:: U+0261B .. RIGHT-POINTING INDEX FINGER, BLACK +.. |lindexwhite| unicode:: U+0261C .. LEFT-POINTING INDEX FINGER, WHITE +.. |rindexwhite| unicode:: U+0261E .. RIGHT-POINTING INDEX FINGER, WHITE +.. -------- Symbols for Unprintable ASCII Range -------- +.. |nul| unicode:: U+02400 .. NUL +.. |soh| unicode:: U+02401 .. SOH START OF HEADER +.. |stx| unicode:: U+02402 .. STX START OF TEXT +.. |etx| unicode:: U+02403 .. ETX END OF TEXT +.. |eot| unicode:: U+02404 .. EOT END OF TRANSMISSION +.. |enq| unicode:: U+02405 .. ENQ ENQUIRY +.. |ack| unicode:: U+02406 .. ACK ACKNOWLEDGE +.. |bel| unicode:: U+02407 .. BEL BELL +.. |bs| unicode:: U+02408 .. BS BACKSPACE +.. |ht| unicode:: U+02409 .. HT HORIZONTAL TAB +.. |lf| unicode:: U+0240A .. LF LINE FEED +.. |vt| unicode:: U+0240B .. VT VERTICAL TAB +.. |ff| unicode:: U+0240C .. FF FORM FEED +.. |cr| unicode:: U+0240D .. CR CARRIAGE RETURN +.. |so| unicode:: U+0240E .. SO SHIFT OUT +.. |si| unicode:: U+0240F .. SI SHIFT IN +.. |dle| unicode:: U+02410 .. DLE DATA LINK ESCAPE +.. |dc1| unicode:: U+02411 .. DC1 DEVICE CONTROL 1 +.. |dc2| unicode:: U+02412 .. DC2 DEVICE CONTROL 2 +.. |dc3| unicode:: U+02413 .. DC3 DEVICE CONTROL 3 +.. |dc4| unicode:: U+02414 .. DC4 DEVICE CONTROL 4 +.. |nak| unicode:: U+02415 .. NAK NEGATIVE ACKNOWLEDGE +.. |syn| unicode:: U+02416 .. SYN SYNCHRONOUS IDLE +.. |etb| unicode:: U+02417 .. ETB END OF TRANSMISSION BLOCK +.. |can| unicode:: U+02418 .. CAN CANCEL +.. |em| unicode:: U+02419 .. EM END OF MEDIUM +.. |sub| unicode:: U+0241A .. SUB SUBSTITUTE +.. |esc| unicode:: U+0241B .. ESC ESCAPE +.. |fs| unicode:: U+0241C .. FS FILE SEPARATOR +.. |gs| unicode:: U+0241D .. GS GROUP SEPARATOR +.. |rs| unicode:: U+0241E .. RS RECORD SEPARATOR +.. |us| unicode:: U+0241F .. US UNIT SEPARATOR +.. |sp| unicode:: U+02420 .. SP SPACE +.. |del| unicode:: U+02421 .. DEL ASCII 0x7F +.. -------- UI Controls -------- +.. |rbchecked| unicode:: U+025C9 .. RADIO BUTTON CHECKED / FISHEYE +.. |rbunchecked| unicode:: U+025CB .. RADIO BUTTON UNCHECKED / WHITE CIRCLE +.. |cbunchecked| unicode:: U+02610 .. CHECKBOX UNCHECKED / BALLOT BOX EMPTY +.. |cbchecked| unicode:: U+02611 .. CHECKBOX CHECKED / BALLOT BOX WITH CHECK +.. |cbexed| unicode:: U+02612 .. CHECKBOX WITH X / BALLOT BOX WITH X +.. -------- Trigraphs -------- +.. |triheaven| unicode:: U+02630 .. HEAVEN (SOLID, SOLID, SOLID) (looks like menu icon) +.. -------- Raw HTML -------- +.. |br| raw:: html + +
+.. |hr| raw:: html + +