Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 113 to 113 | ||||||||
In essence, you are building a library of functions with parameters that people can use. Use your imagination, the sky is the limit! | ||||||||
Changed: | ||||||||
< < | Related Topics: VarINCLUDE, VarSTARTSECTION, VarENDSECTION, UserDocumentationCategory, ParameterizedVariables | |||||||
> > | Related Topics: VarINCLUDE, VarSTARTSECTION, VarENDSECTION, IncludeTopicRaw, UserDocumentationCategory, ParameterizedVariables | |||||||
-- Contributors: TWiki:Main.PeterThoeny![]() ![]() |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 9 to 9 | ||||||||
%INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" PARAMETER1="value" PARAMETER2="Some value"}% | ||||||||
Changed: | ||||||||
< < | The pattern parameter is optional and allows you to extract some parts of 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).*" . 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 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. | |||||||
Changed: | ||||||||
< < | 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. | |||||||
> > | 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. A default value can be specified such as %PARAMETER1{ default="..." }% in case the INCLUDE does not specify the parameter. Parametrized includes can be used to define and use macros, which is an alternative to parameterized variables. | |||||||
VarINCLUDE explains the other parameters. | ||||||||
Line: 39 to 39 | ||||||||
| ||||||||
Changed: | ||||||||
< < | 4. Include a topic MyTopic with two parameters | |||||||
> > | 4. Create a big document of many included topicsIf 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:---+!! 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" }% 5. Include a topic MyTopic with two parameters | |||||||
You include the topic with this line | ||||||||
Line: 56 to 72 | ||||||||
| ||||||||
Changed: | ||||||||
< < | 5. Alert Box using Parameterized Include | |||||||
> > | ![]() 6. Alert Box using Parameterized Include | |||||||
Create a topic called AlertBox with the following content: | ||||||||
Line: 67 to 85 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Line: 85 to 103 | ||||||||
The TITLE="" and MESSAGE="" parameters are passed into the include. Using this approach, you can create a library of boxes in the Main web, such as Main.NoteBox, Main.InfoBox. | ||||||||
Changed: | ||||||||
< < | 6. Create a Widget Library | |||||||
> > | 7. Create a Widget Library | |||||||
You can create a library of GUI widgets![]() | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
In essence, you are building a library of functions with parameters that people can use. Use your imagination, the sky is the limit! | ||||||||
Changed: | ||||||||
< < | Related Topics: VarINCLUDE, VarSTARTSECTION, VarENDSECTION, UserDocumentationCategory | |||||||
> > | Related Topics: VarINCLUDE, VarSTARTSECTION, VarENDSECTION, UserDocumentationCategory, ParameterizedVariables | |||||||
Changed: | ||||||||
< < | -- Contributors: TWiki:Main/PeterThoeny![]() ![]() | |||||||
> > | -- Contributors: TWiki:Main.PeterThoeny![]() ![]() |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 85 to 85 | ||||||||
The TITLE="" and MESSAGE="" parameters are passed into the include. Using this approach, you can create a library of boxes in the Main web, such as Main.NoteBox, Main.InfoBox. | ||||||||
Changed: | ||||||||
< < | Related Topics: VarINCLUDE, UserDocumentationCategory | |||||||
> > | 6. Create a Widget LibraryYou can create a library of GUI widgets![]()
![]() ![]() |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 56 to 56 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Related Topics: VarINCLUDE, UserDocumentationCategory | |||||||
> > | 5. Alert Box using Parameterized IncludeCreate a topic called AlertBox with the following content:----- %STARTINCLUDE% <div style="border-color:#FF9933; border-style:solid; border-width:thin; width:85%; margin: 0 auto"> <table cellpadding="5" width="100%" cellspacing="0" cellpadding="12" border="0"> <tr bgcolor="#FFBB55"> <td valign="top" width="16"><img src="%ICONURL{warning}%" width="16" height="16" align="absmiddle" alt="" border="0"></td> <td><b> %TITLE% </b></td> </tr> <tr bgcolor="#FFCC66"> <td> </td> <td> %MESSAGE% </td> </tr> </table> </div> %STOPINCLUDE% ----- | |||||||
Added: | ||||||||
> > | Now you can write %INCLUDE{ "AlertBox" TITLE="Alert" MESSAGE="This a test message" }% to get this:
TITLE="" and MESSAGE="" parameters are passed into the include. Using this approach, you can create a library of boxes in the Main web, such as Main.NoteBox, Main.InfoBox.
Related Topics: VarINCLUDE, UserDocumentationCategory |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 7 to 7 | ||||||||
Syntax Example | ||||||||
Changed: | ||||||||
< < | %INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }% | |||||||
> > | %INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" PARAMETER1="value" PARAMETER2="Some value"}% | |||||||
Changed: | ||||||||
< < | The pattern parameter is optional and allows you to extract some parts of 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).*" . 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 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 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. | |||||||
VarINCLUDE explains the other parameters. | ||||||||
Line: 37 to 39 | ||||||||
| ||||||||
Added: | ||||||||
> > | 4. Include a topic MyTopic with two parametersYou include the topic with this line%INCLUDE{ "MyTopic" BETTER="apples" WORSE="Oranges"}%An example of a very simple MyTopic could contain * I like %BETTER% better than %WORSE%.The result would be
| |||||||
Related Topics: VarINCLUDE, UserDocumentationCategory |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 11 to 11 | ||||||||
The pattern parameter is optional and allows you to extract some parts of 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).*" . 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. | ||||||||
Changed: | ||||||||
< < | TWikiVariables#VarINCLUDE explains the other parameters. | |||||||
> > | VarINCLUDE explains the other parameters. | |||||||
Note: All text of a topic is included unless it contains a %STARTINCLUDE% and %STOPINCLUDE% , or you specify a section parameter and/or a pattern parameter. A pattern will only search between %STARTINCLUDE% and %STOPINCLUDE% . | ||||||||
Line: 37 to 37 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Related Topics: TWikiVariables#VarINCLUDE, UserDocumentationCategory | |||||||
> > | Related Topics: VarINCLUDE, UserDocumentationCategory | |||||||
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Changed: | ||||||||
< < | Include Topics and Web Pages Using | |||||||
> > | Include Topics and Web Pages Using | |||||||
Changed: | ||||||||
< < | Use the %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 TWikiPreferences. | |||||||
> > | Use the %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 TWikiPreferences. | |||||||
On this page:
| ||||||||
Added: | ||||||||
> > | Syntax Example | |||||||
Changed: | ||||||||
< < | Syntax | |||||||
> > | %INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }% | |||||||
Changed: | ||||||||
< < | %INCLUDE{ "page" pattern="reg-exp" rev="1.2" }% | |||||||
> > | The pattern parameter is optional and allows you to extract some parts of 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).*" . 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. | |||||||
Changed: | ||||||||
< < |
| |||||||
> > | TWikiVariables#VarINCLUDE explains the other parameters. | |||||||
Changed: | ||||||||
< < |
%STARTINCLUDE% , %STOPINCLUDE% and/or a pattern parameter. A pattern will only search between %STARTINCLUDE% and %STOPINCLUDE% . | |||||||
> > | Note: All text of a topic is included unless it contains a %STARTINCLUDE% and %STOPINCLUDE% , or you specify a section parameter and/or a pattern parameter. A pattern will only search between %STARTINCLUDE% and %STOPINCLUDE% . | |||||||
Usage Examples | ||||||||
Line: 35 to 26 | ||||||||
2. Display Google's robot.txt file | ||||||||
Changed: | ||||||||
< < |
| |||||||
> > | %INCLUDE{"http://www.google.com/robots.txt"}% | |||||||
3. Display the current time in Tokyo in a TWiki page
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < | See also other TWikiVariables.
-- TWiki:Main.PeterThoeny![]() | |||||||
> > | Related Topics: TWikiVariables#VarINCLUDE, UserDocumentationCategory | |||||||
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using
Use the | ||||||||
Line: 22 to 22 | ||||||||
| ||||||||
Changed: | ||||||||
< < | Note: All text of a topic is included unless you specify %STARTINCLUDE% , %STOPINCLUDE% and/or a pattern parameter. | |||||||
> > | Note: All text of a topic is included unless you specify %STARTINCLUDE% , %STOPINCLUDE% and/or a pattern parameter. A pattern will only search between %STARTINCLUDE% and %STOPINCLUDE% . | |||||||
Usage Examples | ||||||||
Line: 34 to 33 | ||||||||
</pre> | ||||||||
Changed: | ||||||||
< < | 2. Display Yahoo's robot.txt file
3. Display the SUNW stock quote in a TWiki page | |||||||
> > | 2. Display Google's robot.txt file | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
Changed: | ||||||||
< < | 4. Display the temperature in San Francisco | |||||||
> > | 3. Display the current time in Tokyo in a TWiki page | |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
See also other TWikiVariables. | ||||||||
Changed: | ||||||||
< < | -- PeterThoeny - 15 Jan 2003 | |||||||
> > | -- TWiki:Main.PeterThoeny![]() |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using | ||||||||
Changed: | ||||||||
< < | Use the %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. | |||||||
> > | Use the %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 TWikiPreferences. | |||||||
On this page:
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Changed: | ||||||||
< < | Include Topics and Web Pages Using %INCLUDE{...}% Variable | |||||||
> > | Include Topics and Web Pages Using | |||||||
Use the %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. | ||||||||
Line: 30 to 30 | ||||||||
1. Display regression test results in a TWiki page<pre> | ||||||||
Changed: | ||||||||
< < | %INCLUDEURL{"http://domain/~qa/v1.1/REDTest.log.txt"}% | |||||||
> > | %INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}% | |||||||
</pre>
2. Display Yahoo's robot.txt file
| ||||||||
Changed: | ||||||||
< < |
%INCLUDE{"http://www.yahoo.com/robots.txt"}% | |||||||
> > |
| |||||||
3. Display the SUNW stock quote in a TWiki page
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
4. Display the temperature in San Francisco
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < | -- PeterThoeny - 25 Jun 2001 | |||||||
> > | -- PeterThoeny - 15 Jan 2003 |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using %INCLUDE{...}% Variable
Use the %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. | ||||||||
Line: 12 to 12 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
| ||||||||
Changed: | ||||||||
< < | The pattern parameter is optional and allows you to extract some parts of a web page. Specify a RegularExpression that scans from start ('^' ) to end and contains the text you want to keep in parenthesis, i.e. pattern="^.*?(from here.*?to here).*" . You need to make sure that the integrity of a web page is not compromised, i.e. 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 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. | |||||||
| ||||||||
Changed: | ||||||||
< < | The rev parameter is optional and allows you to include an earlier revision of a topic. This can be used to include an official version of a topic, e.g. one that has been signed of by management. | |||||||
> > | The rev parameter is optional and allows you to include an earlier revision of a topic. This can be used to include an official version of a topic, e.g. one that has been signed of by management. This parameter does not apply to URLs. | |||||||
Note: All text of a topic is included unless you specify %STARTINCLUDE% , %STOPINCLUDE% and/or a pattern parameter. |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using %INCLUDE{...}% Variable
Use the %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. | ||||||||
Line: 8 to 8 | ||||||||
Syntax | ||||||||
Changed: | ||||||||
< < | %INCLUDE{"page" pattern="reg-exp"}% | |||||||
> > | %INCLUDE{ "page" pattern="reg-exp" rev="1.2" }% | |||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
The nameless parameter specifies the page to include. It is
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
The pattern parameter is optional and allows you to extract some parts of a web page. Specify a RegularExpression that scans from start ('^' ) to end and contains the text you want to keep in parenthesis, i.e. pattern="^.*?(from here.*?to here).*" . You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag. | ||||||||
Added: | ||||||||
> > |
| |||||||
Note: All text of a topic is included unless you specify %STARTINCLUDE% , %STOPINCLUDE% and/or a pattern parameter. |
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Include Topics and Web Pages Using %INCLUDE{...}% Variable
Use the %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. | ||||||||
Line: 12 to 13 | ||||||||
| ||||||||
Changed: | ||||||||
< < |
| |||||||
> > |
| |||||||
|
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Added: | ||||||||
> > | Include Topics and Web Pages Using %INCLUDE{...}% Variable
Use the %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.
On this page:
Syntax%INCLUDE{"page" pattern="reg-exp"}%
%STARTINCLUDE% , %STOPINCLUDE% and/or a pattern parameter.
Usage Examples1. Display regression test results in a TWiki page<pre> %INCLUDEURL{"http://domain/~qa/v1.1/REDTest.log.txt"}% </pre> 2. Display Yahoo's robot.txt file
%INCLUDE{"http://www.yahoo.com/robots.txt"}% 3. Display the SUNW stock quote in a TWiki page
4. Display the temperature in San Francisco
|