blob: a4b1bddafb1673ac39c3e094cabcc8072bc55206 [file] [log] [blame]
version=pmwiki-2.0.beta29 ordered=1
agent=Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.7.6) Gecko/20050317 Firefox/1.0.2
text=[[Category.DocumentationToDo]] ²* This page needs to be cleaned up for 2.0 release.²* [=Where in the source are directives listed, what filename(s) and function(s)?=]²* There should be a comprehensive enumeration of directives in documentation, even if some are left undocumented, for now.²²Cross Reference:²* See also the MarkupMasterIndex.²²PmWiki uses the markup sequence [@(:directive ...:)@] for a number of directives and text substitutions. Many of these replace the "double-bracket" directives that were used in PmWiki 1.0 and earlier versions. Here's a brief description of each.²²[[#title]][@(:title text:)@]²->Sets a page's title to be something other than the name of the page. For example, the markup²² [=(:title Patrick's home page:)=]²²->uses "Patrick's home page" as the title of the page in the browser title bar (HTML <title> tag) and the title area of the page ($PageTitle variable). Note that apostrophes and other special characters can be used here.²²%note% If we want to allow the user to specify a page's title, yet keep the original WikiWord for the crumbstrail as an unaltered variable in the template, how can this be done? like a subtitle directive instead of title, or some var that retains the title after the title directive alters it.²²->%Pm% Use $Name in the template for the breadcrumbs instead of $Title. --[[~Pm]]²²[[#keywords]][@(:keywords word, ...:)@]²->Sets page keywords in an HTML @@<meta name='keywords' content='word, ...' />@@ tag.²²[[#description]][@(:description A page about ...:)@]²->Sets page description in an HTML @@<meta name='description' content='A page about...' />@@ tag.²²[[#comment]][@(:comment This won't be displayed:)@]²->Allows comments to be included in the page markup without them being visible in the displayed page. This may be useful for providing editing guidance to new users, among other uses.²²[[#include]][@(:include PageName:)@] and [@(:include PageName#start#end:)@]²->Includes the contents of another page into the text of the current page. The second form of the include is used to include only the portion of the page between the #start and #end anchors. #start and #end can be numeric, in which case they refer to line numbers within the page, so that [@(:include RecentChanges#1#10:)@] grabs only the first ten lines of the RecentChanges file. ²->See IncludeOtherPages²²->In PmWiki 2, one can specify a range of lines to be used in the²->[@(:include:)@] directive, thus:²²->(from Pm email)²²->[@(:include SomePage :)@] - include all of `SomePage\\²[@(:include SomePage lines=10 :)@] - include lines 1-10 of `SomePage\\²[@(:include SomePage lines=1..10 :)@] - include lines 1-10 of `SomePage\\²[@(:include SomePage lines=6..10 :)@] - include lines 6-10 of `SomePage\\²[@(:include SomePage lines=6.. :)@] - include lines 6 to end of `SomePage\\²[@(:include SomePage lines=6..6:)@] - include only line 6 of `SomePage²²²[[#noheader]][@(:noheader:)@],²[[#nofooter]][@(:nofooter:)@], ²[[#notitle]][@(:notitle:)@],²[[#nogroupheader]][@(:nogroupheader:)@],²[[#nofootheader]][@(:nofootheader:)@],²etc.²->These directives disable the header, footer, and page title portions of a page's layout (if the page's skin allows it).²²[[#spacewikiwords]][@(:(no)spacewikiwords:)@]²->Turns on (off) automatic spacing of bare WikiWords within the page text. When on, `WikiWord will be displayed as "Wiki Word".²²[[#linkwikiwords]][@(:(no)linkwikiwords:)@]²->Turns on (off) automatic linking of bare WikiWords to pages of the same name.²²[[#if]][@(:if cond param:)@]²->The [@(:if cond param:)@] syntax allows portions of the markup text to be conditionally processed (up to the next [@(:if:)@]) depending on administrator-defined conditions. The predefined conditions are "true", "false", "group", and "name". For example, ²-->[@(:if group PmWiki:)This text displays only in the PmWiki group(:if:)@]²->For more details, see [[ConditionalMarkup]]. ²²[[#pagelist]][@(:pagelist group=xxx fmt=yyy list=zzz:)@]²->The [@(:pagelist ..:)@] syntax allows to include a bulleted list of pagenames which are within the specified group. The group and pagenames are displayed as links.²²:::[@group=xxx@]: optional, xxx = name of group, which pages should be included in the list²²--->%green%Q: can you specify pages as well, e.g via regex or matching name-prefix: Group\.PREF.* = all pages of group "Group" starting with "PREF" ²--->A:%Pm% No, just groups and not pages. There may be a new option added at some point that allows specifying fullnames by regex. Plus there's always the [@list=zzz@] option below which ''does'' allow arbitrary lists.²²:::[@fmt=yyy@]: optional, yyy = ²:::::[@bygroup@]:default, level 1 list entries for each group with level 2 list entries for each page of a group²:::::[@simple@]:one line per page, using full pagename: "* groupname.pagename", no group headers²:::::[@group@]:list just groups: "* groupname"²:::::see also: Cookbook:DictIndex²²:::[@list=zzz@]: optional, zzz = ²:::::[@normal@]:don't include special pages like [@RecentChanges@], [@GroupHeader@] and [@GroupFooter@] in the list²²->You can do ²-->[@(:pagelist:)@] to get a list of all pages, ²-->[@(:pagelist group=PmWiki:)@] to get a list of all pages in the PmWiki group,²-->[@(:pagelist group= -PmWiki -PmWikiDe:)@] to get a list of all pages ''except'' those in the PmWiki and PmWikiDe group (the blank before the first '-' is mandatory),²-->[@(:pagelist group={$Group}:)@] to get a list of all pages in the current group,²-->[@(:pagelist group={$Group} list=normal:)@] to get a list of all pages in the current group except [@GroupHeader, GroupFooter, RecentChanges @] etc.,²-->[@(:pagelist fmt=group :)@] to get a list of all groups,²-->[@(:pagelist fmt=group -{$Group} :)@] to get a list of all groups exept the current one.²²->from mailings:²²-->For `RecentPages, I just put the following in my local/config.php:²-->(There must be two spaces between the wikilink and the following text -> Copy&Paste from the source, not html view.)²²--->[@$RCTime = strftime('%b %d %H:%M',$Now);@]²--->[@$RecentChangesFmt['Main.RecentPages'] = ':[[$FullName]]: $RCTime';@]²²²->see also:Cookbook:SearchResults, PagelistsExplained²²[[#searchbox]][@(:searchbox:)@]²->Shows a search box at this position.²²[[#searchresult]][@(:searchresults group=xxx fmt=yyy list=zzz text:)@]²²For usage of group, fmt and list, see the [=(:pagelist:)=] directive above.²->see also:Cookbook.SearchResults²²[[#markup]][@(:markup:) ... (:markupend:)@]²->Can be used for markup examples, showing first the markup and then the result of the markup. see PmWiki.TextFormattingRules for examples.²²%trail%<<|PmWiki.DocumentationIndex|>>