TiddlyWiki5/editions/tw5.com/tiddlers/concepts/Pragma.tid

created: 20150219175930000
modified: 20230107165037493
tags: Concepts [[WikiText Parser Modes]]
title: Pragma
type: text/vnd.tiddlywiki

A <<.def pragma>> is a special component of WikiText that provides control over the way the remaining text is parsed.

Pragmas occupy lines that start with `\`. They can only appear at the start of the text, but blank lines are allowed between them. If a pragma line appears in the main body of the text, it is treated as if it was ordinary text.
<<.from-version "5.2.6">> Pragmas can have preceding optional whitespace characters.


The following pragmas are available:

;`\define`
: for defining a [[macro|Macros]]
;`\rules`
: for adjusting the set of rules used to parse the text
;`\whitespace trim` or `\whitespace notrim`
: <<.from-version "5.1.15">> Control whether whitespace is trimmed from the start and end of text runs (the default is ''notrim''). This setting can be useful when the whitespace generated by linebreaks disturbs formatting
;`\import <filter-expression>`
: <<.from-version "5.1.18">> for importing macro definitions from tiddlers identified by a filter expression
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`created: 20150219175930000`
Adds support for indenting pragmas with whitespace (#7185) * feat: first pass at allowing pragmas to be indented * Added documentation 2023-01-08 13:17:01 +00:00			`modified: 20230107165037493`
Add doc related to WikiText parser modes (#6415) * Added macros for displaying wikitext examples in a table * Added documentation for WikiText parsing * Changed recognize to British spelling * Add links to the new wikitext parser tiddlers 2022-01-23 09:44:01 +00:00			`tags: Concepts [[WikiText Parser Modes]]`
Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00			`title: Pragma`
			`type: text/vnd.tiddlywiki`

			`A <<.def pragma>> is a special component of WikiText that provides control over the way the remaining text is parsed.`

			Pragmas occupy lines that start with `\`. They can only appear at the start of the text, but blank lines are allowed between them. If a pragma line appears in the main body of the text, it is treated as if it was ordinary text.
Adds support for indenting pragmas with whitespace (#7185) * feat: first pass at allowing pragmas to be indented * Added documentation 2023-01-08 13:17:01 +00:00			`<<.from-version "5.2.6">> Pragmas can have preceding optional whitespace characters.`

Overhaul the macro and variable documentation #1519 2015-02-24 16:41:16 +00:00
			`The following pragmas are available:`

			;`\define`
			`: for defining a [[macro\|Macros]]`
			;`\rules`
			`: for adjusting the set of rules used to parse the text`
Add new "\whitespace" pragma This will allow us to simplify some of the more unreadable core wikitext tiddlers… 2017-07-12 15:46:13 +00:00			;`\whitespace trim` or `\whitespace notrim`
Docs tweaks 2017-09-20 10:48:06 +00:00			`: <<.from-version "5.1.15">> Control whether whitespace is trimmed from the start and end of text runs (the default is ''notrim''). This setting can be useful when the whitespace generated by linebreaks disturbs formatting`
Add new "\import" pragma 2018-09-28 15:01:32 +00:00			;`\import <filter-expression>`
			`: <<.from-version "5.1.18">> for importing macro definitions from tiddlers identified by a filter expression`