PmWikiJa / Wikiトレイル

authors (basic)

(訳注:trail は、このページにもあるよう(<< Group headers | DocumentationIndex | Page history >> などの部分)に、ページを順序付けて順番にたどることが出来る機能のようです。そのまま「道」などと訳すとなんとなくわかりづらくなると思ったので「トレイル」としています。)

The WikiTrails feature allows wiki authors to create "trails" through sequences of pages in the wiki.

WikiTrails 機能で、wiki 作者は、wiki のページの並び順を通る"トレイル(道)"を作成します。

Creating a trail トレイルを作る

Before you can use a trail through a group of pages, you have to create a "trail index" on a separate page, which we will call the "trail index page". On that trail index page, you simply create a numbered or bulleted list of links. (So every numbered or bulleted list of links implicitly creates a trail.) It is important that each page name (link) be the first item following each bullet.

ページのグループを通るトレイルを使用できるようになる前に、あなたは"トレイルインデックス"を別のページに作成しなければなりません。(私たちはそれに"トレイルインデックスページ"と呼びます)。そのトレイルインデックスページでは、単にリンクの順序付きか点付きリストを作成します。(そう、リンクの順序付きか点付きリストは、暗黙のうちにトレイルをつくります。) それぞれのページ名(リンク)が各点に続く最初の項目であることは重要です。

An example trail index page:

  1. PITS?
    1. 00895?
RoadMap?
ChangeLog? (This won't be in the trail because it is preceded by text)

creates the following "wikitrail":

> Pm Wiki Ja.Installation? < > Pm Wiki Ja.Pm Wiki? < > Pm Wiki.Wiki Styles < > Pm Wiki.Page Lists < > Pm Wiki Ja.Features? < > Pm Wiki Ja.Cookbook < > Pm Wiki Ja.PITS? < > PITS.00895? < > Pm Wiki Ja.Road Map? <

トレイルインデックスページの例:

  1. PITS?
    1. 00895?
RoadMap?
ChangeLog? (テキストの後にあるので、これはトレイルにはありません。)

以下の "wikitrail" を作成します:

> Pm Wiki Ja.Installation? < > Pm Wiki Ja.Pm Wiki? < > Pm Wiki.Wiki Styles < > Pm Wiki.Page Lists < > Pm Wiki Ja.Features? < > Pm Wiki Ja.Cookbook < > Pm Wiki Ja.PITS? < > PITS.00895? < > Pm Wiki Ja.Road Map? <

Observations 観察

  1. In general, indentation levels in the page list don't matter -- trails are a linear sequence of pages.
  2. A page is part of the trail only if the page link immediately follows the list markup.
  3. 一般に、ページリストのインデントレベルは、重要でありません -- トレイルは、ページの連続した順序です。
  4. ページリンクがリストマークアップの直後に続く場合だけ、ページはトレイルの一部です。

Using the 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 on the trail index page).

To build a trail, add trail markup like <<|[[TrailIndexPage]]|>> to a page, where TrailIndexPage is the page, described above, containing the bulleted 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. If you are adding a trail to every page in a group, consider setting the trail markup in the GroupHeader? or GroupFooter pages instead of on every individual page in your group.

トレイルを「働かせ」るには、トレイル上のページ（すなわち、トレイルインデックスページの点/番号付きリストにリストされるページ）に、トレイルマークアップを加えます。

トレイルを造るためには、<<|[[TrailIndexPage]]|>> のようなトレイルマークアップをページに加えてください。TrailIndexPage は、上記のトレイル上のページを点付きリストとして含んでいるページです。PmWiki は、トレイルマークアップをトレイル上の何れかの前、または、後ろのページへのリンクとして表示します。

トレイルマークアップは、ページのどこにでも配置することができ、そして、複数のトレイルマークアップを含むことが出来ます。もし、グループの全てのページにトレイルを追加するならば、グループの個々のページ全ての代わりに、GroupHeader? や GroupFooter ページにトレイルマークアップを設定することを考えてください。

Trail types トレイルのタイプ

PmWiki defines 2 trail markups:

Path trail

^|[[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".

Wiki administrators can change the trail separator of the "path" trail ( ^|[[TrailIndexPage]]|^ ) from the default | by setting the variable $TrailPathSep in the config.php file. For instance $TrailPathSep = ' > '; will output "TrailIndexPage > TrailPage2 > TrailPage4".

Circular trails

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

    
    * [[TrailPage1]]
    * [[TrailPage2]]
    ...
    * [[TrailPageN]]
    * [[TrailPage1]]

If the trail index page is intended to be read by others, the last item can be made invisible using %item comment%: 

    
    * [[TrailPage1]]
    * [[TrailPage2]]
    ...
    * [[TrailPageN]]
    * [[TrailPage1]] %item comment%

Cross Group Trails

Trail pages on both sides of group boundaries must be fully qualified with group names.

Other notes

Trail style

The %trail% markup that is used in many of PmWiki's documentation pages is just a WikiStyle? that creates a grey background, and is not required for WikiTrails to work. It's defined in the PmWiki.GroupHeader page. Q: Is there a Site.GroupHeader where the style can be declared for all groups and pages

To 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 %trail% markup from the trail pages.

Trail in page lists?

Trails from a single page only can be displayed using the pagelist trail parameter. For example 

(:pagelist trail=PmWiki/WikiTrails fmt=PmWiki.WikiTrails#traillist order=random count=1:)

> Pm Wiki.My Trail Page 1? <

<< | DocumentationIndex? | >>