mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-08-27 16:12:24 +00:00
Code Issues Releases Wiki Activity

Documentation Macros doc tiddler updated

Browse Source
This commit is contained in:
pmario 2024-02-17 22:14:38 +01:00
parent a09106f33b
commit ba7cef14e6
1 changed files with 154 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

261
editions/tw5.com/tiddlers/styleguide/Documentation Macros.tid
View File

@ -1,5 +1,5 @@
created: 20150110182600000 created: 20150110182600000
modified: 20230325161424684 modified: 20240217204557302
tags: [[Improving TiddlyWiki Documentation]] tags: [[Improving TiddlyWiki Documentation]]
title: Documentation Macros title: Documentation Macros
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -8,167 +8,188 @@ The following macros are used throughout ~TiddlyWiki's documentation. Their name
! General ! General
|!Macro |!Used for |!Example | |Macro |Used for |Example |Rendered|h
|.def |the defining instance of a term |<<.def widget>> | |.def |the defining instance of a term |`<<.def widget>>` |<<.def widget>> |
|.em |minor emphasis within a sentence |<<.em not>> | |.em |minor emphasis within a sentence |`<<.em not>>` |<<.em not>> |
|.place |a placeholder for the user to fill in |<<.place tagname>> | |.place |a placeholder for the user to fill in |`<<.place tagname>>` |<<.place tagname>> |
|.strong |major emphasis within a tiddler |<<.strong Important!>> | |.strong |major emphasis within a tiddler |`<<.strong Important!>>` |<<.strong Important!>> |
|.word |a mention of an ordinary word or phrase |<<.word "hello world">> | |.word |a mention of an ordinary word or phrase |`<<.word "hello world">>` |<<.word "hello world">> |
|.icon |an icon, sized to match the surrounding text |<<.icon "$:/core/images/globe">> | |.icon |an icon, sized to match the surrounding text |`<<.icon "$:/core/images/globe">>` |<<.icon "$:/core/images/globe">> |
!Advice ! Textboxes
|!Macro |!Used for |!Example | |Macro |Used for |Example |Renderd |h
|^.tip |^hints and tips |<<.tip "Turn your screen on, otherwise<br>you won't be able to see much.">> | |^.infoBox |^Text-box with an icon |`<<.infoBox text:"A generic ...">>` |<<.infoBox "A generic text box, with an optional title and a custom icon">> |
|^.warning |^warning advice |<<.warning "Make a backup of your file<br>before you upgrade.">> | |^.note|^Infos with a title |`<<.note text:"Some text ...">>` |<<.note "Some text in a box with a title by default">> |
|^.tip |^hints and tips |`<<.tip text:"Eg: Turn ...">>` |<<.tip "Eg: Turn your screen on, otherwise<br>you won't be able to see much.">> |
|^.warning |^warning advice |`<<.warning text:"Eg: Make a backup ...">>` |<<.warning "Eg: Make a backup of your file<br>before you upgrade.">> |
!! Textboxe Parameters
; text
: Text to be shown in the box
; title
: A title shown as an HTML STRONG element
; icon
: Core icons can be found at [[Icon Gallery]]
; class
: An optional custom class can be added to the text block. It will overwrite the defaults. To keep the defaults, ''add them'' to the custom class settings.
: ''.note''-macro defaults to `doc-note`
: ''.tip''-macro defaults to `doc-tip`
: ''.warning''-macro defaults to `doc-warning`
! Blocks ! Blocks
|!Macro |!Used for |
|.preamble |an introductory sentence that stands apart from the rest of the tiddler |
!Tiddlers and fields |Macro |Used for |h
|.preamble |<<.preamble "an introductory sentence that stands apart from the rest of the tiddler">> |
|!Macro |!Used for |!Example | ! Tiddlers and Fields
|.tid |a tiddler title |<<.tid Example>> |
|.tag |a tag |<<.tag Example>> |
|.field |a field name |<<.field example>> |
|.value |a field value |<<.value "example value">> |
|.op |a filter operator |<<.op backlinks>> |
|.var |a variable or macro name |<<.var currentTiddler>> |
|.wid |a widget name |<<.wid list>> |
|.attr |an attribute name |<<.attr filter>> |
|.param |a macro parameter name |<<.param text>> |
|.tiddler-fields |a list of tiddler fields |<<.tiddler-fields "Monday">> |
|Macro |Used for |Example |Rendered |h
|.tid |a tiddler title |`<<.tid Example>>` |<<.tid Example>> |
|.tag |a tag |`<<.tag Example>>` |<<.tag Example>> |
|.field |a field name |`<<.field example>>` |<<.field example>> |
|.value |a field value |`<<.value "example value">>` |<<.value "example value">> |
|.op |a filter operator |`<<.op backlinks>>` |<<.op backlinks>> |
|.var |a variable or macro name |`<<.var currentTiddler>>` |<<.var currentTiddler>> |
|.wid |a widget name |`<<.wid list>>` |<<.wid list>> |
|.attr |an attribute name |`<<.attr filter>>` |<<.attr filter>> |
|.param |a macro parameter name |`<<.param text>>` |<<.param text>> |
|.tiddler-fields |a list of tiddler fields |`<<.tiddler-fields "Monday">>` |<<.tiddler-fields "Monday">> |
! Links ! Links
|!Macro |!Used for |!Example | |!Macro |Used for |Example |Renderd |h
|.link |a link containing WikiText |<<.link "^^an^^ ~~example~~" Example>> | |.link |link containing WikiText |`<<.link "^^an^^ ~~example~~" Example>>` |<<.link "^^an^^ ~~example~~" Example>> |
|.clink |a code link |<<.clink `<$list>` ListWidget>> | |.clink |code link |``<<.clink `<$list>` ListWidget>>`` |<<.clink `<$list>` ListWidget>> |
|.dlink |a link on a defining instance of a term |<<.dlink widget Widgets>> | |.dlink |definition link for a instance of a term |`<<.dlink widget Widgets>>` |<<.dlink widget Widgets>> |
|.dlink-ex |an external link on a defining instance of a term |<<.dlink-ex Example "http://example.com/">> | |.dlink-ex |external link to a defining instance of a term |`<<.dlink-ex Example "http://example.com/">>` |<<.dlink-ex Example "http://example.com/">> |
|.flink |a link to a field |<<.flink ListField>> | |.flink |field link |`<<.flink ListField>>` |<<.flink ListField>> |
|.mlink |a link to a macro |<<.mlink qualify>> | |.mlink |macro link |`<<.mlink qualify>>` |<<.mlink qualify>> |
|.mlink2 |a link to a macro, with specified target |<<.mlink2 foo "Examples of Macros">> | |.mlink2 |macro link with a specified target |`<<.mlink2 foo "Examples of Macros">>` |<<.mlink2 foo "Examples of Macros">> |
|.olink |a link to an operator |<<.olink prefix>> | |.olink |operator link |`<<.olink prefix>>` |<<.olink prefix>> |
|.olink2 |a link to an operator, with specified target |<<.olink2 foo prefix>> | |.olink2 |operator link with specified target |`<<.olink2 foo prefix>>` |<<.olink2 foo prefix>> |
|.vlink |a link to a variable |<<.vlink currentTiddler>> | |.vlink |variable link |`<<.vlink currentTiddler>>` |<<.vlink currentTiddler>> |
|.vlink2 |a link to a variable, with specified target |<<.vlink2 foo "Examples of Variables">> | |.vlink2 |variable link with specified target |`<<.vlink2 foo "Examples of Variables">>` |<<.vlink2 foo "Examples of Variables">> |
|.wlink |a link to a widget |<<.wlink ButtonWidget>> | |.wlink |widget link |`<<.wlink ButtonWidget>>` |<<.wlink ButtonWidget>> |
|.wlink2 |a link to a widget, with specified text |<<.wlink2 foo ButtonWidget>> | |.wlink2 |widget link with specified text |`<<.wlink2 foo ButtonWidget>>` |<<.wlink2 foo ButtonWidget>> |
!Tabs ! Keyboard Shortcuts
|!Macro |!Used for |!Example |
|Macro |Used for |Example |Rendered |h
|.key |a key on the keyboard |`<<.key Escape>>` |<<.key Escape>> |
|.keys |a key combination |`<<.keys Ctrl+Enter>>` |<<.keys Ctrl+Enter>> |
! Doc-Tabs
See: [[CheckboxWidget]]
|Macro |Used for |Example |h
|.doc-tabs |showing a tab set in a documentation tiddler | -- | |.doc-tabs |showing a tab set in a documentation tiddler | -- |
|.doc-tab-link |button to activate a tab | -- | |.doc-tab-link |button to activate a tab | -- |
|.widget-attr-link |button with a widget attribute name to activate a tab | -- | |.widget-attr-link |button with a widget attribute name to activate a tab | -- |
! Sidebar Tabs
!User interface |Macro |Used for |Example |Rendered |h
|.sidebar-tab |the name of a sidebar tab |`<<.sidebar-tab More>>` |<<.sidebar-tab More>> |
|!Macro |!Used for |!Example | |.more-tab |the name of a subtab of the More tab |`<<.more-tab Shadows>>` |<<.more-tab Shadows>> |
|.key |a key on the keyboard |<<.key Escape>> | |.info-tab |the name of a tiddler info tab |`<<.info-tab Fields>>` |<<.info-tab Fields>> |
|.keycombo |a key combination |<<.keycombo Ctrl Enter>> | |.controlpanel-tab |the name of a Control Panel tab |`<<.controlpanel-tab Settings>>` |<<.controlpanel-tab Settings>> |
|.advancedsearch-tab |the name of an Advanced Search tab |`<<.advancedsearch-tab Filter>>` |<<.advancedsearch-tab Filter>> |
!Tabs |.toc-tab |name of the tw5.com TOC tab |`<<.toc-tab>>` |<<.toc-tab>> |
|.example-tab |an example tab name |`<<.example-tab "Notes">>` |<<.example-tab "Notes">> |
|!Macro |!Used for |!Example |
|.sidebar-tab |the name of a sidebar tab |<<.sidebar-tab More>> |
|.more-tab |the name of a subtab of the More tab |<<.more-tab Shadows>> |
|.info-tab |the name of a tiddler info tab |<<.info-tab Fields>> |
|.controlpanel-tab |the name of a Control Panel tab |<<.controlpanel-tab Settings>> |
|.advancedsearch-tab |the name of an Advanced Search tab |<<.advancedsearch-tab Filter>> |
|.toc-tab |name of the tw5.com TOC tab |<<.toc-tab>> |
|.example-tab |an example tab name |<<.example-tab "Notes">> |
!! Parameters for .sidebar-tab !! Parameters for .sidebar-tab
|Open |<<.sidebar-tab Open>> | |Open |`<<.sidebar-tab Open>>` |<<.sidebar-tab Open>> |
|Recent |<<.sidebar-tab Recent>> | |Recent |`<<.sidebar-tab Recent>>` |<<.sidebar-tab Recent>> |
|Tools |<<.sidebar-tab Tools>> | |Tools |`<<.sidebar-tab Tools>>` |<<.sidebar-tab Tools>> |
|More |<<.sidebar-tab More>> | |More |`<<.sidebar-tab More>>` |<<.sidebar-tab More>> |
!! Parameters for .more-tab !! Parameters for .more-tab
|All |<<.more-tab All>> | |All |`<<.more-tab All>>` |<<.more-tab All>> |
|Recent |<<.more-tab Recent>> | |Recent |`<<.more-tab Recent>>` |<<.more-tab Recent>> |
|Tags |<<.more-tab Tags>> | |Tags |`<<.more-tab Tags>>` |<<.more-tab Tags>> |
|Missing |<<.more-tab Missing>> | |Missing |`<<.more-tab Missing>>` |<<.more-tab Missing>> |
|Drafts |<<.more-tab Drafts>> | |Drafts |`<<.more-tab Drafts>>` |<<.more-tab Drafts>> |
|Orphans |<<.more-tab Orphans>> | |Orphans |`<<.more-tab Orphans>>` |<<.more-tab Orphans>> |
|Types |<<.more-tab Types>> | |Types |`<<.more-tab Types>>` |<<.more-tab Types>> |
|System |<<.more-tab System>> | |System |`<<.more-tab System>>` |<<.more-tab System>> |
|Shadows |<<.more-tab Shadows>> | |Shadows |`<<.more-tab Shadows>>` |<<.more-tab Shadows>> |
!! Parameters for .info-tab !! Parameters for .info-tab
|Tools |<<.info-tab Tools>> | |Tools |`<<.info-tab Tools>>` |<<.info-tab Tools>> |
|References |<<.info-tab References>> | |References |`<<.info-tab References>>` |<<.info-tab References>> |
|Tagging |<<.info-tab Tagging>> | |Tagging |`<<.info-tab Tagging>>` |<<.info-tab Tagging>> |
|List |<<.info-tab List>> | |List |`<<.info-tab List>>` |<<.info-tab List>> |
|Listed |<<.info-tab Listed>> | |Listed |`<<.info-tab Listed>>` |<<.info-tab Listed>> |
|Fields |<<.info-tab Fields>> | |Fields |`<<.info-tab Fields>>` |<<.info-tab Fields>> |
|Advanced |<<.info-tab Advanced>> | |Advanced |`<<.info-tab Advanced>>` |<<.info-tab Advanced>> |
!! Parameters for .controlpanel-tab !! Parameters for .controlpanel-tab
|Info |<<.controlpanel-tab Info>> | |Info |`<<.controlpanel-tab Info>>` |<<.controlpanel-tab Info>> |
|Appearance |<<.controlpanel-tab Appearance>> | |Appearance |`<<.controlpanel-tab Appearance>>` |<<.controlpanel-tab Appearance>> |
|Settings |<<.controlpanel-tab Settings>> | |Settings |`<<.controlpanel-tab Settings>>` |<<.controlpanel-tab Settings>> |
|Saving |<<.controlpanel-tab Saving>> | |Saving |`<<.controlpanel-tab Saving>>` |<<.controlpanel-tab Saving>> |
|Plugins |<<.controlpanel-tab Plugins>> | |Plugins |`<<.controlpanel-tab Plugins>>` |<<.controlpanel-tab Plugins>> |
!! Parameters for .advancedsearch-tab !! Parameters for .advancedsearch-tab
|Standard |<<.advancedsearch-tab Standard>> | |Standard |`<<.advancedsearch-tab Standard>>` |<<.advancedsearch-tab Standard>> |
|System |<<.advancedsearch-tab System>> | |System |`<<.advancedsearch-tab System>>` |<<.advancedsearch-tab System>> |
|Shadows |<<.advancedsearch-tab Shadows>> | |Shadows |`<<.advancedsearch-tab Shadows>>` |<<.advancedsearch-tab Shadows>> |
|Filter |<<.advancedsearch-tab Filter>> | |Filter |`<<.advancedsearch-tab Filter>>` |<<.advancedsearch-tab Filter>> |
! Buttons ! Buttons
|!Macro |!Used for |!Example | |Macro |Used for |Example |Rendered |h
|.button |a standard button name and icon |<<.button "new-tiddler">> | |.button |a standard button name and icon |`<<.button "new-tiddler">>` |<<.button "new-tiddler">> |
!! Parameters for .button !! Parameters for .button
!!! Tiddler toolbar !!! Tiddler toolbar
|clone |<<.button "clone">> | |clone |`<<.button "clone">>` |<<.button "clone">> |
|close |<<.button "close">> | |close |`<<.button "close">>` |<<.button "close">> |
|close-others |<<.button "close-others">> | |close-others |`<<.button "close-others">>` |<<.button "close-others">> |
|edit |<<.button "edit">> | |edit |`<<.button "edit">>` |<<.button "edit">> |
|export-tiddler |<<.button "export-tiddler">> | |export-tiddler |`<<.button "export-tiddler">>` |<<.button "export-tiddler">> |
|info |<<.button "info">> | |info |`<<.button "info">>` |<<.button "info">> |
|more-tiddler-actions |<<.button "more-tiddler-actions">> | |more-tiddler-actions |`<<.button "more-tiddler-actions">>` |<<.button "more-tiddler-actions">> |
|new-here |<<.button "new-here">> | |new-here |`<<.button "new-here">>` |<<.button "new-here">> |
|new-journal-here |<<.button "new-journal-here">> | |new-journal-here |`<<.button "new-journal-here">>` |<<.button "new-journal-here">> |
|permalink |<<.button "permalink">> | |permalink |`<<.button "permalink">>` |<<.button "permalink">> |
!!! Edit-mode toolbar !!! Edit-mode toolbar
|cancel |<<.button "cancel">> | |cancel |`<<.button "cancel">>` |<<.button "cancel">> |
|delete |<<.button "delete">> | |delete |`<<.button "delete">>` |<<.button "delete">> |
|save |<<.button "save">> | |save |`<<.button "save">>` |<<.button "save">> |
!!! Page toolbar !!! Page toolbar
|advanced-search |<<.button "advanced-search">> | |advanced-search |`<<.button "advanced-search">>` |<<.button "advanced-search">> |
|close-all |<<.button "close-all">> | |close-all |`<<.button "close-all">>` |<<.button "close-all">> |
|control-panel |<<.button "control-panel">> | |control-panel |`<<.button "control-panel">>` |<<.button "control-panel">> |
|encryption |<<.button "encryption">> | |encryption |`<<.button "encryption">>` |<<.button "encryption">> |
|export-page |<<.button "export-page">> | |export-page |`<<.button "export-page">>` |<<.button "export-page">> |
|full-screen |<<.button "full-screen">> | |full-screen |`<<.button "full-screen">>` |<<.button "full-screen">> |
|home |<<.button "home">> | |home |`<<.button "home">>` |<<.button "home">> |
|import |<<.button "import">> | |import |`<<.button "import">>` |<<.button "import">> |
|language |<<.button "language">> | |language |`<<.button "language">>` |<<.button "language">> |
|more-page-actions |<<.button "more-page-actions">> | |more-page-actions |`<<.button "more-page-actions">>` |<<.button "more-page-actions">> |
|new-journal |<<.button "new-journal">> | |new-journal |`<<.button "new-journal">>` |<<.button "new-journal">> |
|new-tiddler |<<.button "new-tiddler">> | |new-tiddler |`<<.button "new-tiddler">>` |<<.button "new-tiddler">> |
|permaview |<<.button "permaview">> | |permaview |`<<.button "permaview">>` |<<.button "permaview">> |
|refresh |<<.button "refresh">> | |refresh |`<<.button "refresh">>` |<<.button "refresh">> |
|save-wiki |<<.button "save-wiki">> | |save-wiki |`<<.button "save-wiki">>` |<<.button "save-wiki">> |
|storyview |<<.button "storyview">> | |storyview |`<<.button "storyview">>` |<<.button "storyview">> |
|tag-manager |<<.button "tag-manager">> | |tag-manager |`<<.button "tag-manager">>` |<<.button "tag-manager">> |
|theme |<<.button "theme">> | |theme |`<<.button "theme">>` |<<.button "theme">> |