Changeset 920 for trunk/core/data/System/VarINCLUDE.txt

Timestamp:

11/24/08 14:27:56 (4 years ago)

Author:

CrawfordCurrie

Message:

Item287: Rewrote significant chunk of plugins doc to simplify and improve developer doc. Added doc: protocol to %INCLUDE to support including core module documentation

File:

• trunk/core/data/System/VarINCLUDE.txt (modified) (1 diff)

trunk/core/data/System/VarINCLUDE.txt

@@ -9 +9 @@
      | ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%SYSTEMWEB%.SiteMap"}%= | |
      | ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://foswiki.org:80/index.html"}%=. Supported content types are =text/html= and =text/plain=. <br /> %I% if the URL resolves to an attachment file on the server this will _automatically_ translate to a server-side include. | |
+     | ="doc:Foswiki::..." level="3" | Generates the embedded documentation in the given perl module. The optional =level= parameter lets you define the base level for headings in the included text. |
      | =pattern="..."= |Include a subset of a topic or a web page. Specify a RegularExpression that scans from start (='^'=) to end and contains the text you want to keep in parenthesis, e.g., =pattern="^.*?(from here.*?to here).*"=. IncludeTopicsAndWebPages has more. | none |
      | =rev="2"= | Include a previous topic revision; N/A for URLs | top revision |