From: <de...@de...> - 2010-07-07 00:57:14
|
Author: PeterThoeny Date: 2010-07-06 19:57:06 -0500 (Tue, 06 Jul 2010) New Revision: 19205 Trac url: http://develop.twiki.org/trac/changeset/19205 Modified: twiki/trunk/core/data/TWiki/IncludeTopicsAndWebPages.txt twiki/trunk/core/data/TWiki/VarINCLUDE.txt Log: Item6515: Relative Heading Levels for INCLUDE (documentation) Modified: twiki/trunk/core/data/TWiki/IncludeTopicsAndWebPages.txt =================================================================== --- twiki/trunk/core/data/TWiki/IncludeTopicsAndWebPages.txt 2010-07-06 06:15:45 UTC (rev 19204) +++ twiki/trunk/core/data/TWiki/IncludeTopicsAndWebPages.txt 2010-07-07 00:57:06 UTC (rev 19205) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1273005047" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1278463962" format="1.1" version="$Rev$"}% ---+!! Include Topics and Web Pages Using =%<nop>INCLUDE{...}%= Variable Use the =%<nop>INCLUDE{...}%= variable to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in %WIKIPREFSTOPIC%. @@ -9,7 +9,7 @@ =%<nop>INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" PARAMETER1="value" PARAMETER2="Some value"}%= -The =pattern= parameter is optional and allows you to extract some parts of a web page. Specify a %SYSTEMWEB%.RegularExpression that scans from start (='^'=) to end and contains the text you want to keep in parenthesis, e.g., =pattern="^.*?(from here.*?to here).*"=. You need to make sure that the integrity of a web page is not compromised; for example, if you include a table, make sure to include everything including the table end tag. +The =pattern= parameter is optional and allows you to extract some parts of a web page. Specify a %SYSTEMWEB%.RegularExpression that scans from start (='^'=) to end and contains the text you want to keep in parenthesis, e.g., =pattern="^.*?(from here.*?to here).*"=. You need to make sure that the integrity of a web page is not compromised; for example, if you include an HTML table, make sure to include everything including the table end tag. The example parameters PARAMETER1 and PARAMETER2 will be defined as a variable within the scope of the included topic. The example parameters shown will result in %PARAMETER1% and %PARAMETER2% being defined within the included topic. @@ -39,8 +39,24 @@ * You get: * Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}% ----+++ 4. Include a topic !MyTopic with two parameters +---+++ 4. Create a big document of many included topics +If you create a big document (such as a manual or book) it is better to split up content into topics. You can do that by chapter or sub-section. If needed you can adjust the heading level when you include the chapters into the master document. For example, in the master document you might want to show chapter's H1 heading as H2. Example: + +<verbatim> + ---+!! Breadslicer Users Guide + %TOC{ depth="3" }% + %INCLUDE{ "UsersGuidePreface" headingoffset="1" }% + %INCLUDE{ "UsersGuideChapter1" headingoffset="1" }% + %INCLUDE{ "UsersGuideChapter2" headingoffset="1" }% + %INCLUDE{ "UsersGuideChapter3" headingoffset="1" }% + %INCLUDE{ "UsersGuideChapter4" headingoffset="1" }% + %INCLUDE{ "UsersGuideAppendix" headingoffset="1" }% + %INCLUDE{ "UsersGuideIndex" headingoffset="1" }% +</verbatim> + +---+++ 5. Include a topic !MyTopic with two parameters + You include the topic with this line <verbatim> %INCLUDE{ "MyTopic" BETTER="apples" WORSE="Oranges"}% @@ -56,7 +72,7 @@ * I like apples better than oranges. ----+++ 5. Alert Box using Parameterized Include +---+++ 6. Alert Box using Parameterized Include Create a topic called !AlertBox with the following content: @@ -85,7 +101,7 @@ The =TITLE=""= and =MESSAGE=""= parameters are passed into the include. Using this approach, you can create a library of boxes in the %USERSWEB% web, such as <nop>%USERSWEB%.NoteBox, <nop>%USERSWEB%.InfoBox. ----+++ 6. Create a Widget Library +---+++ 7. Create a Widget Library You can create a library of [[http://en.wikipedia.org/wiki/GUI_widget][GUI widgets]] using a topic with named sections: Modified: twiki/trunk/core/data/TWiki/VarINCLUDE.txt =================================================================== --- twiki/trunk/core/data/TWiki/VarINCLUDE.txt 2010-07-06 06:15:45 UTC (rev 19204) +++ twiki/trunk/core/data/TWiki/VarINCLUDE.txt 2010-07-07 00:57:06 UTC (rev 19205) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1259091834" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1278463961" format="1.1" version="$Rev$"}% %META:TOPICPARENT{name="TWikiVariables"}% #VarINCLUDE ---+++ INCLUDE{"page"} -- include other topic or web page @@ -10,6 +10,7 @@ | ="Web.Topic"= | A topic in another web, i.e. =%<nop>INCLUDE{"%SYSTEMWEB%.SiteMap"}%= | | | ="http://..."= | A full qualified URL, i.e. =%<nop>INCLUDE{"http://twiki.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. | | | =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 | + | =headingoffset="2"= | Adjust the level of headings in the included topic. A ="2"= or ="+2"= increases the level by two, e.g. a =---+= H1 turns into a =---+++= H3. Positive and negative values are supported. Adjusted min and max levels are H1 and H6, respectively. | no adjustment | | =rev="2"= | Include a previous topic revision; N/A for URLs | top revision | | =raw="on"= | When a page is included, normally %WIKITOOLNAME% will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include _exactly_ what is in the source of the originating page set this to =on=. %BR% =raw="on"= is short for =disableremoveheaders="on"=, =disableremovescript="on"=, =disableremovebody="on"=, =disablecompresstags="on"= and =disablerewriteurls="on"=. | disabled | | =literal="on"= | While using the =raw= option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the =literal= option to ="on"=. | disabled | |