Editing HelpOnMacros

   

<Include(HelpMenu)> === Introduction === OpenWiki recognizes a few macro names. A macro is recognized as such if its name appears between a pair of <...>'s characters (<.../> is also accepted). <br> E.g. {{{<TableOfContents>}}} and {{{<TableOfContents />}}} are macro's. Some macro's accept one or more parameters. Parameters are given directly following the macroname and are enclosed between a pair of (...)'s characters. Mulitple parameters are separated by comma's. <br> E.g. {{{<FullSearch("^Help")>}}}, {{{<RecentChanges(10,30)>}}}. All known macro's that are supported by OpenWiki are described below. === Table Of Contents === To show the table of contents of a page use the macro {{{<TableOfContents>}}}. This table is created by looking at all the [HelpOnHeaders headers] used within a page. <code> <TableOfContents> </code> <TableOfContents> === Line Break === By default OpenWiki ignores linebreaks. Actually it's a feature of all web browsers which OpenWiki simply inherits. If you want a line directly followed by a new line then you can use the macro {{{<br>}}}. Below you see an example which shows the difference: <code> this is line one. is this line two? this is line one. <br> is this line two? </code> this is line one. is this line two? this is line one. <br> is this line two? === Including Pages === One of the more powerful macro's is the {{{<Include>}}} macro. Using this macro you can include another wiki page into the current wiki page. This is great if for example you want to use a common menu structure for a subset of your wiki. See for example MyProject. Pass the name of the WikiPage you want to include, e.g.: <code> <Include(MyProjectMenu)> </code> <Include(MyProjectMenu)> === Anchors === You can put invisible anchors in your page by using the {{{<Anchor>}}} macro. Pass the name of the anchor as a parameter, e.g.: <code> <Anchor(MyAnchor)> This piece of text is anchored. </code> <Anchor(MyAnchor)> This piece of text is anchored. === Searches === To show an input editbox that will do a search through all the titles of the pages in this wiki use the macro {{{<TitleSearch>}}}. Below an example is shown: <code> Title search: <TitleSearch> </code> Title search: <TitleSearch> The {{{<TitleSearch>}}} macro also accepts a parameter. Instead of showing an editbox it will then show a list of page titles that match the pattern of the parameter. E.g.: <code> List of all the help page (assuming all these start with the letters "Help"): <TitleSearch(^Help)> </code> List of all the help page (assuming all these start with the letters "Help"): <TitleSearch(^Help)> To show an input editbox that will do a full text search through all the pages in this wiki use the macro {{{<FullSearch>}}}. Below an example is shown: <code> Full text search: <FullSearch> </code> Full text search: <FullSearch> The {{{<FullSearch>}}} macro also accepts a parameter. Instead of showing an editbox it will then do a full text search through all the pages and show a list of the pages that match the pattern of the parameter. E.g.: <code> List all pages containing the word "Text Search": <FullSearch("Text Search")> </code> List all pages containing the word "Text Search": <FullSearch("Text Search")> To show an input editbox that will allow you to go to a page or create a new page by entering it's name in the editbox use the macro {{{<GoTo>}}}. <code> <GoTo> </code> <GoTo> === Indexes === To view a list of all the pages in this wiki use the macro {{{<TitleIndex>}}}. See TitleIndex for an example. To view a list of all the words used in the titles of wiki pages use the macro {{{<WordIndex>}}}. See WordIndex for an example. To view a list of recently changed pages use the macro {{{<RecentChanges>}}}. When no parameters are provided all pages changed in the last 30 days will be shown. See for example the RecentChanges page. One or two paramterers are accepted. The first parameter is the maximum number of days that should be shown in the change list. The second parameter is the maximum number of page titles that should be shown in the change list. When a parameter is not a number or less or equal than zero, then a default value is taken. The example below will show all recently changed pages in the last 24 hours. <code> <RecentChanges(1)/> </code> <RecentChanges(1)/> The example below will show a maximum of 10 recently changed pages. <code> <RecentChanges(0,10)/> </code> <RecentChanges(0,10)/> For more information about recently changed pages and how revisions work see HelpOnRevisions. === Random Pages === To show a random page link use the macro {{{<RandomPage>}}}. Below a random page link is shown: <code> <RandomPage> </code> <RandomPage> To show a number of random page links, pass the number as a parameter to the macro. For example, below 5 random page links are shown by using the macro {{{<RandomPage(5)>}}}: <code> <RandomPage(5)> </code> <RandomPage(5)> === Syndication === News related sites often offer a so-called RSS feed. This feed is available through a URL. For example, the latest news headlines from [http://slashdot.org Slashdot] are retrievable through the URL http://slashdot.org/slashdot.rdf. It's possible to syndicate these news headlines into OpenWiki. To do this use the macro {{{<Syndicate>}}}. This macro needs at least one parameter, the second parameter is optional. The first parameter must be the URL to the RSS feed enclosed by quotes. The second parameter must be a number (in minutes) which tells how often to refresh the news, where the default is 120 minutes or 2 hours. Retrieving the news headlines is a costly operation so you don't want to set the refresh rate too low. Example: <code> <Syndicate("http://slashdot.org/slashdot.rdf", 120)> </code> <Syndicate("http://slashdot.org/slashdot.rdf", 120)> Use of this macro can be disabled by the system administrator. For more information about RSS see RDFSiteSummary. === Aggregation === Just as you can syndicate RSS feeds into a wiki page, it's possible to aggregate multiple RSS feeds into one list. Define all the RSS feeds you want to aggregate using the {{{Syndicate}}} macro, put all these definitions in one wiki page, and then use the macro {{{Aggregate}}} in any wiki page to aggregate the RSS feeds defined in the wiki page with the {{{Syndicate}}} macro's. This macro needs one parameter, which must be the name of the wiki page containing the {{{Syndicate}}} macro's. Example: <code> <Aggregate("AllTheNews")> </code> To view the results of this example, see AllTheNews and AllTheNews/Aggregation. Use of this macro can be disabled by the system administrator. === User Preferences === To show the user preferences use the macro {{{<UserPreferences>}}}. See for example the page UserPreferences. === Inter Wiki === To show the list of known InterWiki''''''s use the macro {{{<InterWiki>}}}. <code> <InterWiki> </code> <InterWiki> === System Info === Below information about this system is shown: <code> <SystemInfo> </code> <SystemInfo> <code> <PageCount> </code> This wiki contains **<PageCount>** WikiPage''''''s. <code> <Date> <Time> <DateTime> </code> The date on this server is <Date> The time on this server is <Time> The datetime on this server is <DateTime>
Include page in Recent Changes list.

Optional comment about this change: