diff --git a/editions/tw5.com/tiddlers/styleguide/Documentation Macros.tid b/editions/tw5.com/tiddlers/styleguide/Documentation Macros.tid index 466f58bf9..0b92d0770 100644 --- a/editions/tw5.com/tiddlers/styleguide/Documentation Macros.tid +++ b/editions/tw5.com/tiddlers/styleguide/Documentation Macros.tid @@ -1,7 +1,8 @@ created: 20150110182600000 -modified: 20150228082845000 -title: Documentation Macros +modified: 20211206080809651 tags: [[Improving TiddlyWiki Documentation]] +title: Documentation Macros +type: text/vnd.tiddlywiki The following macros are used throughout ~TiddlyWiki's documentation. Their names start with a dot to keep them out of the way of names that a user might try experimenting with. @@ -13,6 +14,7 @@ The following macros are used throughout ~TiddlyWiki's documentation. Their name |.place |a placeholder for the user to fill in |<<.place tagname>> | |.strong |major emphasis within a tiddler |<<.strong Important!>> | |.word |a mention of an ordinary word or phrase |<<.word "hello world">> | +|.icon |an icon, sized to match the surrounding text |<<.icon "$:/core/images/globe">> | !Advice @@ -36,6 +38,8 @@ The following macros are used throughout ~TiddlyWiki's documentation. Their name |.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">> | + !Links diff --git a/editions/tw5.com/tiddlers/system/doc-macros.tid b/editions/tw5.com/tiddlers/system/doc-macros.tid index 1aebbec25..1a04dd72c 100644 --- a/editions/tw5.com/tiddlers/system/doc-macros.tid +++ b/editions/tw5.com/tiddlers/system/doc-macros.tid @@ -130,4 +130,21 @@ This is an example tiddler. See [[Table-of-Contents Macros (Examples)]]. \define .link-badge-renamed(link,colour:#b4b995) <<.link-badge "renamed" """$link$""" """$colour$""">> \define .link-badge-updated(link,colour:#91ba66) <<.link-badge "updated" """$link$""" """$colour$""">> +\define .tiddler-fields(tiddler) +<$tiddler tiddler=<<__tiddler__>>> +
+

+<$link> +{{||$:/core/ui/TiddlerIcon}}<$text text=<>/> + +

+ + +<$list filter="[all[current]fields[]sort[title]] -title" template="$:/core/ui/TiddlerFieldTemplate" variable="listItem"/> + +
+
+ +\end +
<$view field="text"/>
\ No newline at end of file diff --git a/editions/tw5.com/tiddlers/system/doc-styles.tid b/editions/tw5.com/tiddlers/system/doc-styles.tid index b87f1f1f5..277cd88d6 100644 --- a/editions/tw5.com/tiddlers/system/doc-styles.tid +++ b/editions/tw5.com/tiddlers/system/doc-styles.tid @@ -221,3 +221,30 @@ tr.doc-table-subheading { .doc-link-badge:hover { text-decoration: underline; } + +.doc-tiddler-fields { + background-color: <>; + border: 1px solid <>; + border-radius: 4px; + padding: 0 0.5em; +} + +.doc-tiddler-fields h2 svg { + height: 1em; +} + + +.doc-tiddler-fields table, +.doc-tiddler-fields h2 { + margin: 0.5em 0; +} + +.doc-tiddler-fields table { + background-color: <>; +} + +@media screen { + .doc-tiddler-fields { + <> + } +}