Difference: IncludeTopicsAndWebPages (1 vs. 13)

Revision 132011-04-14 - TWikiContributor

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. If needed, set a proxy server in TWikiPreferences.

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
 
  • You get:
    • Tokyo:

Warning
This site does not allow %INCLUDE% of URLs
Changed:
<
<

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:

  ---+!! 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
 
  • I like apples better than oranges.
Changed:
<
<

5. Alert Box using Parameterized Include

>
>
TIP Tip: Parameterized variables are a somewhat easier to use alternative to parametrized includes.

6. Alert Box using Parameterized Include

  Create a topic called AlertBox with the following content:
Line: 67 to 85
 
Changed:
<
<
%TITLE%
>
>
%TITLE{ default="Alert!" }%
 
 
Changed:
<
<
%MESSAGE%
>
>
%MESSAGE{ default="Please specify a MESSAGE parameter." }%
 
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 using a topic with named sections:
Changed:
<
<
  1. Create a Main.WidgetLibrary topic
>
>
  1. Create a Main.WidgetLibrary topic
 
  1. Create widgets in that topic, such as alert boxes, submit forms, queries, etc. Widgets are defined as named sections and may process parameters. For example, above alert box can be a widget enclosed in %STARTSECTION{AlertBox}% ... %ENDSECTION{AlertBox}% (instead of the %STOPINCLUDE% ... %STOPINCLUDE%)
Changed:
<
<
  1. Place a widget in any topic. For example, to use the alert box widget write:
    %INCLUDE{ "Main.WidgetLibrary" section="AlertBox" TITLE="Alert" MESSAGE="The sky is the limit!" }%
>
>
  1. Place a widget in any topic. For example, to use the alert box widget write:
    %INCLUDE{ "Main.WidgetLibrary" section="AlertBox" TITLE="Alert" MESSAGE="The sky is the limit!" }%
  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, TWiki:Main/KennethLavrsen
>
>
-- Contributors: TWiki:Main.PeterThoeny, TWiki:Main.KennethLavrsen

Revision 122010-05-04 - TWikiContributor

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. If needed, set a proxy server in TWikiPreferences.

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 Library

You can create a library of GUI widgets using a topic with named sections:

  1. Create a Main.WidgetLibrary topic
  2. Create widgets in that topic, such as alert boxes, submit forms, queries, etc. Widgets are defined as named sections and may process parameters. For example, above alert box can be a widget enclosed in %STARTSECTION{AlertBox}% ... %ENDSECTION{AlertBox}% (instead of the %STOPINCLUDE% ... %STOPINCLUDE%)
  3. Place a widget in any topic. For example, to use the alert box widget write:
    %INCLUDE{ "Main.WidgetLibrary" section="AlertBox" TITLE="Alert" MESSAGE="The sky is the limit!" }%

In essence, you are building a library of functions with parameters that people can use. Use your imagination, the sky is the limit!

Related Topics: VarINCLUDE, VarSTARTSECTION, VarENDSECTION, UserDocumentationCategory

-- Contributors: TWiki:Main/PeterThoeny, TWiki:Main/KennethLavrsen

Revision 112009-03-11 - TWikiContributor

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. If needed, set a proxy server in TWikiPreferences.

Line: 56 to 56
 
  • I like apples better than oranges.
Changed:
<
<
Related Topics: VarINCLUDE, UserDocumentationCategory
>
>

5. Alert Box using Parameterized Include

Create 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>&nbsp;</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:

Alert
  This a test message

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.

Related Topics: VarINCLUDE, UserDocumentationCategory

Revision 102005-03-27 - TWikiContributor

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. If needed, set a proxy server in TWikiPreferences.

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
 
  • You get:
    • Tokyo:

Warning
This site does not allow %INCLUDE% of URLs
Added:
>
>

4. Include a topic MyTopic with two parameters

You 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

  • I like apples better than oranges.
 Related Topics: VarINCLUDE, UserDocumentationCategory

Revision 92005-03-27 - TWikiContributor

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. If needed, set a proxy server in TWikiPreferences.

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
 
  • You get:
    • Tokyo:

Warning
This site does not allow %INCLUDE% of URLs
Changed:
<
<
Related Topics: TWikiVariables#VarINCLUDE, UserDocumentationCategory
>
>
Related Topics: VarINCLUDE, UserDocumentationCategory
 

Revision 82005-03-27 - TWikiContributor

Line: 1 to 1
Changed:
<
<

Include Topics and Web Pages Using %INCLUDE{...}% Variable

>
>

Include Topics and Web Pages Using %INCLUDE{...}% Variable

 
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.
 
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:
<
<
  • "page":
    The nameless parameter specifies the page to include. It is
    • The name of a topic located in the current web, e.g., %INCLUDE{"WebNotify"}%
    • A Web.Topic name specifying a topic in another web, e.g., %INCLUDE{"TWiki.SiteMap"}%
    • A full qualified URL with http protocol, domain name and optional port number, e.g., %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
>
>
TWikiVariables#VarINCLUDE explains the other parameters.
 
Changed:
<
<
  • pattern="reg-exp":
    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.

  • rev="1.x":
    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. 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:
<
<
  • You type:
    • %INCLUDE{"http://www.google.com/robots.txt"}%
>
>
  %INCLUDE{"http://www.google.com/robots.txt"}%
 

3. Display the current time in Tokyo in a TWiki page

  • You type:
Changed:
<
<
    • Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
>
>
    • Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
 
  • You get:
    • Tokyo:

Warning
This site does not allow %INCLUDE% of URLs
Changed:
<
<
See also other TWikiVariables.

-- TWiki:Main.PeterThoeny - 15 Aug 2004

>
>
Related Topics: TWikiVariables#VarINCLUDE, UserDocumentationCategory
 

Revision 72004-08-15 - PeterThoeny

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. If needed, set a proxy server in TWikiPreferences.

Line: 22 to 22
 
  • rev="1.x":
    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.
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

  • You type:
    • %INCLUDE{"http://www.yahoo.com/robots.txt"}%

3. Display the SUNW stock quote in a TWiki page

>
>

2. Display Google's robot.txt file

 
  • You type:
Changed:
<
<
    • SUNW: %INCLUDE{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.*?>SUNW</a>[^<]+(.*?)\s+\S+\s+<small.*"}%
  • You get:
    • SUNW:

Warning
This site does not allow %INCLUDE% of URLs
>
>
    • %INCLUDE{"http://www.google.com/robots.txt"}%
 
Changed:
<
<

4. Display the temperature in San Francisco

>
>

3. Display the current time in Tokyo in a TWiki page

 
  • You type:
Changed:
<
<
    • San Francisco: %INCLUDE{"http://weather.yahoo.com/forecast/San_Francisco_CA_US_f.html" pattern="^.*?([0-9]+\&ordm\;F).*"}%
>
>
    • Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
 
  • You get:
Changed:
<
<
    • San Francisco:

Warning
This site does not allow %INCLUDE% of URLs
>
>
    • Tokyo:

Warning
This site does not allow %INCLUDE% of URLs
  See also other TWikiVariables.
Changed:
<
<
-- PeterThoeny - 15 Jan 2003
>
>
-- TWiki:Main.PeterThoeny - 15 Aug 2004

Revision 62003-02-01 - PeterThoeny

Line: 1 to 1
 

Include Topics and Web Pages Using %INCLUDE{...}% Variable

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.
 

Revision 52003-01-16 - PeterThoeny

Line: 1 to 1
Changed:
<
<
Include Topics and Web Pages Using %INCLUDE{...}% Variable
>
>

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: 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

  • You type:
Changed:
<
<
    • %INCLUDE{"http://www.yahoo.com/robots.txt"}%
  • You get:
%INCLUDE{"http://www.yahoo.com/robots.txt"}%
>
>
    • %INCLUDE{"http://www.yahoo.com/robots.txt"}%
 

3. Display the SUNW stock quote in a TWiki page

  • You type:
Changed:
<
<
    • SUNW: %INCLUDE{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.*?>SUNW</a>[^<]+(.*?)\s+\S+\s+<small.*"}%
>
>
    • SUNW: %INCLUDE{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.*?>SUNW</a>[^<]+(.*?)\s+\S+\s+<small.*"}%
 
  • You get:
    • SUNW:

Warning
This site does not allow %INCLUDE% of URLs

4. Display the temperature in San Francisco

  • You type:
Changed:
<
<
    • San Francisco: %INCLUDE{"http://weather.yahoo.com/forecast/San_Francisco_CA_US_f.html" pattern="^.*?([0-9]+\&ordm\;F).*"}%
>
>
    • San Francisco: %INCLUDE{"http://weather.yahoo.com/forecast/San_Francisco_CA_US_f.html" pattern="^.*?([0-9]+\&ordm\;F).*"}%
 
  • You get:
    • San Francisco:

Warning
This site does not allow %INCLUDE% of URLs

See also other TWikiVariables.

Changed:
<
<
-- PeterThoeny - 25 Jun 2001
>
>
-- PeterThoeny - 15 Jan 2003

Revision 42002-12-11 - PeterThoeny

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
 
  • "page":
    The nameless parameter specifies the page to include. It is
Changed:
<
<
    • The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
    • A Web.Topic name specifying a topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
    • A full qualified URL with http protocol, domain name and optional port number, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
>
>
    • The name of a topic located in the current web, e.g., %INCLUDE{"WebNotify"}%
    • A Web.Topic name specifying a topic in another web, e.g., %INCLUDE{"TWiki.SiteMap"}%
    • A full qualified URL with http protocol, domain name and optional port number, e.g., %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
 
  • pattern="reg-exp":
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.
 
  • rev="1.x":
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.

Revision 32002-11-14 - PeterThoeny

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:
<
<
  • "page":
>
>
  • "page":
  The nameless parameter specifies the page to include. It is
    • The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
    • A Web.Topic name specifying a topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
    • A full qualified URL with http protocol, domain name and optional port number, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
Changed:
<
<
  • pattern="reg-exp":
>
>
  • pattern="reg-exp":
  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:
>
>
  • rev="1.x":
    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.
 Note: All text of a topic is included unless you specify %STARTINCLUDE%, %STOPINCLUDE% and/or a pattern parameter.

Revision 22002-04-07 - PeterThoeny

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
 
  • "page":
    The nameless parameter specifies the page to include. It is
    • The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
Changed:
<
<
    • A Web.Topic name specifying a topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>
    • A Web.Topic name specifying a topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%
 
    • A full qualified URL with http protocol, domain name and optional port number, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.

  • pattern="reg-exp":

Revision 12001-06-26 - PeterThoeny

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.

Syntax

%INCLUDE{"page" pattern="reg-exp"}%

  • "page":
    The nameless parameter specifies the page to include. It is
    • The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
    • A Web.Topic name specifying a topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
    • A full qualified URL with http protocol, domain name and optional port number, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.

  • pattern="reg-exp":
    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.

Note: All text of a topic is included unless you specify %STARTINCLUDE%, %STOPINCLUDE% and/or a pattern parameter.

Usage Examples

1. 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

  • You type:
    • %INCLUDE{"http://www.yahoo.com/robots.txt"}%
  • You get:
%INCLUDE{"http://www.yahoo.com/robots.txt"}%

3. Display the SUNW stock quote in a TWiki page

  • You type:
    • SUNW: %INCLUDE{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.*?>SUNW</a>[^<]+(.*?)\s+\S+\s+<small.*"}%
  • You get:
    • SUNW:

Warning
This site does not allow %INCLUDE% of URLs

4. Display the temperature in San Francisco

  • You type:
    • San Francisco: %INCLUDE{"http://weather.yahoo.com/forecast/San_Francisco_CA_US_f.html" pattern="^.*?([0-9]+\&ordm\;F).*"}%
  • You get:
    • San Francisco:

Warning
This site does not allow %INCLUDE% of URLs

See also other TWikiVariables.

-- PeterThoeny - 25 Jun 2001

 
This site is powered by the TWiki collaboration platformCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.IncludeTopicsAndWebPages.

mersin escort bayan adana escort bayan izmit escort ankara escort bursa escort