Add docs for ShowIcons and TitleIndex macros (#1604)

moinwiki · Feb 16, 2024 · 85707b9 · 85707b9
1 parent ef5d93a
commit 85707b9
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 20 deletions.
diff --git a/docs/user/moinwiki.rst b/docs/user/moinwiki.rst
@@ -799,9 +799,9 @@ extra features. The following is a table of MoinMoin's macros.
 +-------------------------------------------+------------------------------------------------------------+
 | ``<<FootNote(Note here)>>``               | Inserts a footnote saying "Note here"                      |
 +-------------------------------------------+------------------------------------------------------------+
-| ``<<FontAwesome(name,color,size)>>``      | displays Font Awsome icon, color and size are optional     |
+| ``<<FontAwesome(name,color,size)>>``      | Displays Font Awsome icon, color and size are optional     |
 +-------------------------------------------+------------------------------------------------------------+
-| ``<<Icon(my-icon.png)>>``                 | displays icon from /static/img/icons                       |
+| ``<<Icon(my-icon.png)>>``                 | Displays icon from /static/img/icons                       |
 +-------------------------------------------+------------------------------------------------------------+
 | ``<<Include(ItemOne/SubItem)>>``          | Embeds the contents of ``ItemOne/SubItem`` inline          |
 +-------------------------------------------+------------------------------------------------------------+
@@ -818,10 +818,15 @@ extra features. The following is a table of MoinMoin's macros.
 +-------------------------------------------+------------------------------------------------------------+
 | ``<<RandomItem(3)>>``                     | Inserts names of 3 random items                            |
 +-------------------------------------------+------------------------------------------------------------+
-| ``<<ShowIcons()>>``                       | displays all icons in /static/img/icons directory          |
+| ``<<ShowIcons()>>``                       | Displays all icons in /static/img/icons directory          |
++-------------------------------------------+------------------------------------------------------------+
+| ``<<ShowSmileys()>>``                     | Displays available smileys and the corresponding markup    |
 +-------------------------------------------+------------------------------------------------------------+
 | ``<<TableOfContents(2)>>``                | Shows a table of contents up to level 2                    |
 +-------------------------------------------+------------------------------------------------------------+
+| ``<<TitleIndex()>>``                      | Lists all itemnames for the namespace of the current item, |
+|                                           | grouped by initials                                        |
++-------------------------------------------+------------------------------------------------------------+
 | ``<<Verbatim(`same` __text__)>>``         | Inserts text as entered, no markup rendering               |
 +-------------------------------------------+------------------------------------------------------------+
 

diff --git a/src/moin/help/help-en/MoinWikiMacros.data b/src/moin/help/help-en/MoinWikiMacros.data
@@ -443,18 +443,6 @@ Displayed using "UnCameled":
 
 <<ItemList(item="OtherTextItems", regex="PlainText", display="UnCameled")>>
 
-=== MonthCalendar ===
-
-The MonthCalendar macro is for those who need a calendar wiki integration or want to use MoinMoin as a Personal Information Manager.
-
-'''Markup:'''
-
-{{{
-<<MonthCalendar(item,year,month,month_offset,fixed_height,anniversary)>>
-}}}
-
-For more details see [[/MonthCalendar]]
-
 === RandomItem ===
 
 '''Markup:'''
@@ -479,6 +467,34 @@ Five random items:
 
 <<RandomItem(5)>>
 
+=== TitleIndex ===
+
+TitleIndex gives a List of all Itemnames in the current namespace grouped by initials.
+
+'''Markup:'''
+
+{{{
+
+<<TitleIndex()>>
+
+}}}
+
+'''Result:'''
+
+<<TitleIndex()>>
+
+=== MonthCalendar ===
+
+The MonthCalendar macro is for those who need a calendar wiki integration or want to use MoinMoin as a Personal Information Manager.
+
+'''Markup:'''
+
+{{{
+<<MonthCalendar(item,year,month,month_offset,fixed_height,anniversary)>>
+}}}
+
+For more details see [[/MonthCalendar]]
+
 === Verbatim ===
 
 '''Markup:'''

diff --git a/src/moin/help/help-en/MoinWikiMacros.meta b/src/moin/help/help-en/MoinWikiMacros.meta
@@ -3,7 +3,7 @@
   "address": "127.0.0.1",
   "comment": "",
   "contenttype": "text/x.moin.wiki;charset=utf-8",
-  "dataid": "e002de0b8a6a4d369075971a8cf104f3",
+  "dataid": "ab509237fd3d4be9976f961da142d5b5",
   "externallinks": [
     "https://fontawesome.com/search?o=r&m=free",
     "https://moinmo.in/HelpOnMacros/Include"
@@ -18,16 +18,16 @@
     "help-common/logo.png"
   ],
   "itemtype": "default",
-  "mtime": 1682022938,
+  "mtime": 1707909302,
   "name": [
     "MoinWikiMacros"
   ],
   "name_old": [],
   "namespace": "help-en",
   "rev_number": 1,
-  "revid": "fcd66fcbbe74449384cc1226ff7e2d1e",
-  "sha1": "f1ef15739ba259fad3a473bfc89784ee95b5f5c5",
-  "size": 12247,
+  "revid": "397c78f382924549bda167b7639d1078",
+  "sha1": "406b9ead3b66237e9d3452f3bc99b2f9d281a92c",
+  "size": 12447,
   "summary": "",
   "tags": [
     "macros",