Skip to content

Commit

Permalink
Item11704: Document use of %BR% for line break.
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.foswiki.org/branches/Release01x01@14502 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
GeorgeClark authored and GeorgeClark committed Mar 29, 2012
1 parent 7c6961b commit 0dc70ba
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion core/data/System/FormatTokens.txt
Expand Up @@ -3,7 +3,8 @@
---++ Formatting Tokens

Foswiki defines some standard special tokens that can be used to replace characters in some parameters - notably those to FormattedSearch and IfStatements - to defer evaluation of the parameter until later. These special tokens are often called "escapes", because they allow the character to "escape" from its normal meaning.
%STARTINCLUDE%| =$n= or =$n()= | New line. Use =$n()= if followed by alphanumeric character, e.g. write =Foo$n()Bar= instead of =Foo$nBar= <blockquote class="foswikiHelp">%T% Most macros accept parameter strings which are split over multiple lines. This is usually more readable than using =$n= tokens. If you are familiar with [[VarSTARTSECTION][sectional includes]], you might also consider [[FormattedSearch#NestedSectionalInclude][nested sectional includes]] to hold the newline content outside of the parameter string entirely.</blockquote> |
%STARTINCLUDE%| =$n= or =$n()= | New line. Use =$n()= if followed by alphanumeric character, e.g. write =Foo$n()Bar= instead of =Foo$nBar= <blockquote class="foswikiHelp">%T% Most macros accept parameter strings which are split over multiple lines. This is usually more readable than using =$n= tokens. If you are familiar with [[VarSTARTSECTION][sectional includes]], you might also consider [[FormattedSearch#NestedSectionalInclude][nested sectional includes]] to hold the newline content outside of the parameter string entirely.</blockquote> \
<blockquote class="foswikiHelp">%T% Note that newline is _not_ a line break. The browser will wrap the lines together. If you require a line break, displaying the results on two lines, use =%<nop>BR%=. Or use two consecutive newlines to create a TML "Paragraph".</blockquote> |
| =$nop= or =$nop()= | Is a "no operation". This token gets removed; useful for nested search |
| =$quot= | Double quote (="=) (\" also works) |
| =$percent= | Percent sign (=%=) (=$percnt= also works) |
Expand Down

0 comments on commit 0dc70ba

Please sign in to comment.