diff options
author | pmichaud <pmichaud@524c5546-5005-0410-9a3e-e25e191bd360> | 2006-02-24 17:06:13 +0000 |
---|---|---|
committer | pmichaud <pmichaud@524c5546-5005-0410-9a3e-e25e191bd360> | 2006-02-24 17:06:13 +0000 |
commit | 9af04dd0be268a92a84e638eb8c981f873f58649 (patch) | |
tree | 9a319da1698b19330f66b1080006f60e1297b533 /wikilib.d/PmWiki.WikiTrails | |
parent | eed98f96b82c7c4b77be0165c448de51c8e9f28d (diff) | |
download | pmwiki.svn-9af04dd0be268a92a84e638eb8c981f873f58649.tar.bz2 |
git-svn-id: svn://pmwiki.org/pmwiki/trunk@1237 524c5546-5005-0410-9a3e-e25e191bd360
Diffstat (limited to 'wikilib.d/PmWiki.WikiTrails')
-rw-r--r-- | wikilib.d/PmWiki.WikiTrails | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/wikilib.d/PmWiki.WikiTrails b/wikilib.d/PmWiki.WikiTrails index 701eb14f..fd4cccaa 100644 --- a/wikilib.d/PmWiki.WikiTrails +++ b/wikilib.d/PmWiki.WikiTrails @@ -1,9 +1,10 @@ -version=pmwiki-2.1.beta22 ordered=1 urlencoded=1 -agent=Mozilla/5.0 (X11; U; Linux i686 (x86_64); en-US; rv:1.8) Gecko/20051128 SUSE/1.5-0.1 Firefox/1.5 -author=Pm -host=24.1.26.255 +version=pmwiki-2.1.beta26 ordered=1 urlencoded=1 +agent=Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.1) Gecko/20060111 Firefox/1.5.0.1 +author=Anno +csum= +host=85.125.177.30 name=PmWiki.WikiTrails -rev=38 +rev=39 targets=PmWiki.WikiStyles,PmWiki.GroupHeader,PmWiki.DocumentationIndex -text=%25audience%25 authors (basic)%0a%0aThe WikiTrails feature allows wiki authors to create "trails" through sequences of pages in the wiki.%0a%0a!!Creating a trail%0a%0aTo create a trail, an author creates a "trail index page" that gives the sequence of page names as either a bullet or numbered list. The page names must be the first item following each bullet.%0a%0aAn example trail index page: a list like%0a%0a [@%0a * [[TrailPage1]]%0a * Some text.%0a * [[TrailPage2]]%0a ** [[TrailPage3]]%0a ** [[TrailPage4]] some other text [[IrrelevantWikiPage]]%0a ** Yet some other text. [[AnotherIrrelevantWikiPage]] %0a ** %25center%25[[would-beTrailPage]]%0a @]%0a%0acreates the following "wikitrail":%0a%0a[= TrailPage1 %3c-> TrailPage2 %3c-> TrailPage3 %3c-> TrailPage4 =]%0a%0aObservations:%0a%0a# In general, indentation levels in the page list don't matter -- trails are a linear sequence of pages.%0a# A page is part of the trail only if the page link immediately follows the list markup.%0a%0a!!Using the trail%0a%0aCreating a trail doesn't do anything on its own -- any page with numbered or bulleted lists implicitly create a trail. What makes a trail "work" is adding ''trail markup'' on the pages in the trail (i.e. the pages that are listed in the bullet/numbered list).%0a%0aTo build a trail, add ''trail markup'' like [@%3c%3c|[[TrailIndexPage]]|>>@] to a page, where `TrailIndexPage is the page containing the bullet list of pages in the trail. PmWiki will display the trail markup with links to any previous and next pages in the trail. The trail markup can be placed anywhere in a page, and a page can contain multiple trail markups.%0a%0aPmWiki defines three trail markups:%0a%0a* [@%3c%3c|[[TrailIndexPage]]|>>@] displays as "[=%3c%3c PreviousPage | TrailIndexPage | NextPage >>=]".%0a%0a* [@%3c|[[TrailIndexPage]]|>@] displays as "[=%3c PreviousPage | TrailIndexPage | NextPage >=]", except the appropriate arrow is omitted at the beginning and end of the trail.%0a%0a* [@^|[[TrailIndexPage]]|^@] treats the list levels as a hierarchy and displays the "path" to reach the current page (i.e., a "breadcrumb" trail). In the example trail above, the markup [@^|TrailIndexPage|^@] on [@TrailPage4@] would display as "[=TrailIndexPage | TrailPage2 | TrailPage4=]".%0a%0a!!Circular trails%0a%0aTypically, a trail is a linear list with a first and a last page. However, the trail can be made "circular" by repeating the first page as the last item in the trail index:%0a%0a [@%0a * [[TrailPage1]]%0a * [[TrailPage2]]%0a ...%0a * [[TrailPageN]]%0a * [[TrailPage1]]%0a @]%0a%0aIf the trail index page is intended to be read by others, the last item can be made invisible using [@%25item comment%25@]:%0a%0a [@%0a * [[TrailPage1]]%0a * [[TrailPage2]]%0a ...%0a * [[TrailPageN]]%0a * [[TrailPage1]] %25item comment%25%0a @]%0a%0a!! Cross Group Trails%0a%0aTrail pages on both sides of group boundaries must be fully qualified with group names.%0a%0a%0a!!Other notes%0a%0aThe [@%25trail%25@] markup used in many of PmWiki's documentation pages is just a [[WikiStyle(s)]] that creates a grey background, and is not required for WikiTrails to work. It's defined in the [[PmWiki.GroupHeader]] page.%0a%0aTo get it to work, you must create the index page for the trail and the trail pages as stated above. Then you must define the wikistyle you want in the groupheader of the group you want it to appear in. Then you must refer or call to it with the [@%25trail%25@] markup from the trail pages.%0a%0a%25trail%25%3c%3c|[[DocumentationIndex]]|>> -time=1138996338 +text=%25audience%25 authors (basic)%0a%0aThe WikiTrails feature allows wiki authors to create "trails" through sequences of pages in the wiki.%0a%0a!!Creating a trail%0a%0aTo create a trail, an author creates a "trail index page" that gives the sequence of page names as either a bullet or numbered list. The page names must be the first item following each bullet.%0a%0aAn example trail index page: a list like%0a%0a [@%0a * [[TrailPage1]]%0a * Some text.%0a * [[TrailPage2]]%0a ** [[TrailPage3]]%0a ** [[TrailPage4]] some other text [[IrrelevantWikiPage]]%0a ** Yet some other text. [[AnotherIrrelevantWikiPage]] %0a ** %25center%25[[would-beTrailPage]]%0a @]%0a%0acreates the following "wikitrail":%0a%0a[= TrailPage1 %3c-> TrailPage2 %3c-> TrailPage3 %3c-> TrailPage4 =]%0a%0aObservations:%0a%0a# In general, indentation levels in the page list don't matter -- trails are a linear sequence of pages.%0a# A page is part of the trail only if the page link immediately follows the list markup.%0a%0a!!Using the trail%0a%0aCreating a trail doesn't do anything on its own -- any page with numbered or bulleted lists implicitly create a trail. What makes a trail "work" is adding ''trail markup'' on the pages in the trail (i.e. the pages that are listed in the bullet/numbered list).%0a%0aTo build a trail, add ''trail markup'' like [@%3c%3c|[[TrailIndexPage]]|>>@] to a page, where `TrailIndexPage is the page containing the bullet list of pages in the trail. PmWiki will display the trail markup with links to any previous and next pages in the trail. The trail markup can be placed anywhere in a page, and a page can contain multiple trail markups.%0a%0aPmWiki defines three trail markups:%0a%0a* [@%3c%3c|[[TrailIndexPage]]|>>@] displays as "[=%3c%3c PreviousPage | TrailIndexPage | NextPage >>=]".%0a%0a* [@%3c|[[TrailIndexPage]]|>@] displays as "[=%3c PreviousPage | TrailIndexPage | NextPage >=]", except the appropriate arrow is omitted at the beginning and end of the trail.%0a%0a* [@^|[[TrailIndexPage]]|^@] treats the list levels as a hierarchy and displays the "path" to reach the current page (i.e., a "breadcrumb" trail). In the example trail above, the markup [@^|TrailIndexPage|^@] on [@TrailPage4@] would display as "[=TrailIndexPage | TrailPage2 | TrailPage4=]".%0a%0a!!Circular trails%0a%0aTypically, a trail is a linear list with a first and a last page. However, the trail can be made "circular" by repeating the first page as the last item in the trail index:%0a%0a [@%0a * [[TrailPage1]]%0a * [[TrailPage2]]%0a ...%0a * [[TrailPageN]]%0a * [[TrailPage1]]%0a @]%0a%0aIf the trail index page is intended to be read by others, the last item can be made invisible using [@%25item comment%25@]:%0a%0a [@%0a * [[TrailPage1]]%0a * [[TrailPage2]]%0a ...%0a * [[TrailPageN]]%0a * [[TrailPage1]] %25item comment%25%0a @]%0a%0a!! Cross Group Trails%0a%0aTrail pages on both sides of group boundaries must be fully qualified with group names.%0a%0a%0a!!Other notes%0a%0aThe [@%25trail%25@] markup used in many of PmWiki's documentation pages is just a [[WikiStyle(s)]] that creates a grey background, and is not required for WikiTrails to work. It's defined in the [[PmWiki.GroupHeader]] page.%0a%0aTo get it to work, you must create the index page for the trail and the trail pages as stated above. Then you must define the wikistyle you want in the groupheader of the group you want it to appear in. Then you must refer or call to it with the [@%25trail%25@] markup from the trail pages.%0a%0aYou can change the trail separator of the "path" trail ( [@^|[[TrailIndexPage]]|^@] ) from the default | by setting the variable $TrailPathSep in your config.php file, for instance $TrailPathSep = ' > '; to achieve "[=TrailIndexPage > TrailPage2 > TrailPage4=]".%0a%0a%25trail%25%3c%3c|[[DocumentationIndex]]|>> +time=1140596362 |