Skip to content

Commit

Permalink
Item2653: Clarify that Foswiki doesn't ignore Set, STARTSECTION or TM…
Browse files Browse the repository at this point in the history
…PL:DEF when located within <verbatim>

git-svn-id: http://svn.foswiki.org/branches/Release01x00@6662 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
PaulHarvey authored and PaulHarvey committed Mar 6, 2010
1 parent b5d9548 commit b8589ff
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions core/data/System/WikiSyntax.txt
Expand Up @@ -34,9 +34,7 @@ _If you can enter text, you're ready for Foswiki. With a few simple rules, you'l
=and more of it!= %BR%
=<b>&lt;/verbatim&gt;</b>=

---+++ Macros and special characters (advanced)
* <nop>%MACROS% can be set inside verbatim tags - they are not disabled. For more detailed information, see [[Macros]].

---+++ Working with special characters (advanced)
* If you want to display angle brackets, enter them as HTML codes instead of typing them in directly:
* =&amp;lt;= = =&lt;= %BR%
=&amp;gt;= = =&gt;=
Expand All @@ -46,6 +44,27 @@ _If you can enter text, you're ready for Foswiki. With a few simple rules, you'l
* Sometimes you will not see the =&= charachter and you need to excape it to see it as it is. The reason behind is that =&= has a special meaning in HTML - it starts so called character entities, like ='&amp;copy;'= which is the =&copy;= copyright character.
* Type ='This &amp;amp; that'= to get ='This &amp; that'=.

---+++ Preventing [[Macros][Macro]]/variable exapnsion (advanced)
Place =&lt;nop&gt;= within a =%<nop>MACRO%= statement to prevent it from being expanded, as follows:
* =%&lt;nop&gt;MACRO%=, result: %<nop>MACRO%

---+++ Working with =&lt;verbatim&gt;= (advanced)
Although text inside a =&lt;verbatim&gt;= block should be displayed exactly as it is typed (without being expanded), Foswiki does not necessarily ignore it. The following examples show TML that Foswiki will process inside a =&lt;verbatim&gt;= block:
<pre class="tml">&lt;verbatim&gt;
Example 1:
&#42; Set VARIABLE = This variable may be used as normal, Eg. %<nop>VARIABLE%

Example 2:
%<nop>STARTSECTION{"section"}%
This section may be used as normal, Eg. %<nop>INCLUDE{"%TOPIC%" section="section"}%
%<nop>ENDSECTION{"section"}%

Example 3:
%<nop>TMPL:DEF{"template"}%
This template definition may be used as normal, Eg. %<nop>TMPL:P{"template"}%
%TMPL:END%
&lt;/verbatim&gt;</pre>

---++ Internal and external links

* To link to another Wiki topic in the same web, type the WikiWord of that topic: =<nop>%HOMETOPIC%=. Acronyms will also be linked if the topic exists. See ACRONYM.
Expand Down

0 comments on commit b8589ff

Please sign in to comment.