TiddlyWiki5/editions/tw5.com/tiddlers/widgets/FieldsWidget.tid

title: FieldsWidget
created: 201310241419
modified: 20150220161240000
tags: Widgets
caption: fields

! Introduction

The fields widget renders each field of a specified tiddler through a simple text template. A list of fields to exclude can be provided. It is used internally by TiddlyWiki5, notably by the FileSavingMechanism.

!! Template Handling

The provided template is rendered with the following special substitutions:

|!Symbol |!Substitution |
|$name$ |Field name |
|$value$ |Field value |
|$encoded_value$ |HTML encoded form of field value |

! Content and Attributes

The content of the `<$fields>` widget is ignored.

|!Attribute |!Description |
|tiddler |Title of the tiddler from which the fields are to be displayed (defaults to the [[current tiddler|Current Tiddler]]) |
|template |Text of the template (see above) |
|exclude |Lists of fields to be excluded (defaults to "text") |
|include |Lists of fields to be included, if the field exists. This parameter takes precedence over "exclude" |
|sort |Sorts the fields by name (defaults to "yes"). Set to "no", if "include" order should be retained! |
|sortReverse |Reverses the sort order|
|stripTitlePrefix |If set to "yes" then curly bracketed prefixes are removed from titles (for example `{prefix}HelloThere` converts to `HelloThere`) |

The `stripTitlePrefix` attribute is used when building TiddlyWiki Classic; see `editions/tw2` in the TiddlyWiki5 repo.
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			`title: FieldsWidget`
			`created: 201310241419`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`modified: 20150220161240000`
More mangling of reference docs 2014-09-10 23:06:19 +00:00			`tags: Widgets`
			`caption: fields`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00
			`! Introduction`

			`The fields widget renders each field of a specified tiddler through a simple text template. A list of fields to exclude can be provided. It is used internally by TiddlyWiki5, notably by the FileSavingMechanism.`

			`!! Template Handling`

			`The provided template is rendered with the following special substitutions:`

			`\|!Symbol \|!Substitution \|`
			`\|$name$ \|Field name \|`
			`\|$value$ \|Field value \|`
			`\|$encoded_value$ \|HTML encoded form of field value \|`

			`! Content and Attributes`

			The content of the `<$fields>` widget is ignored.

			`\|!Attribute \|!Description \|`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`\|tiddler \|Title of the tiddler from which the fields are to be displayed (defaults to the [[current tiddler\|Current Tiddler]]) \|`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			`\|template \|Text of the template (see above) \|`
			`\|exclude \|Lists of fields to be excluded (defaults to "text") \|`
Add new parameters to fields-widget and fields-operator. (#4433) * add a new-line before the log text to increase readability of the test output * make eslint, jslint happy * extend fields-widget with include/exclude/sort/reverse and fields-filter with include and exclude params plus DOCS * remove new-line * remove eslint settings * restore old eslint settings * remove typo 2020-04-15 11:36:48 +00:00			`\|include \|Lists of fields to be included, if the field exists. This parameter takes precedence over "exclude" \|`
			`\|sort \|Sorts the fields by name (defaults to "yes"). Set to "no", if "include" order should be retained! \|`
			`\|sortReverse \|Reverses the sort order\|`
Lots and lots and lots of docs updates Now we've got up-to-date skeleton documentation for all the widgets 2013-10-31 22:03:40 +00:00			\|stripTitlePrefix \|If set to "yes" then curly bracketed prefixes are removed from titles (for example `{prefix}HelloThere` converts to `HelloThere`) \|

			The `stripTitlePrefix` attribute is used when building TiddlyWiki Classic; see `editions/tw2` in the TiddlyWiki5 repo.