working on path docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2016-08-17 17:55:49 +03:00
parent 4a00c44e45
commit 89d6c098f1
2 changed files with 19 additions and 13 deletions

2
bootstrap.js vendored

File diff suppressed because one or more lines are too long

View File

@ -11,21 +11,14 @@ XXX write a set of recommendations...
## Basic terminology ## Basic terminology
**Path** **Path**
_One or more _names_ separated by "/" that identifies a view._ _One or more strings (or parts) separated by "/" that identifies a view._
We call the last name in the path sequence a _title_. We call the last _part_ in a path sequence a _title_.
We call the sub-path without the _title_ a _basedir_ or simply _dir_. We call the sub-path without the _title_ a _basedir_ or simply _dir_.
In pWiki, there is no distinction between a page and a _directory_, thus In pWiki, there is no distinction between a page and a _directory_, thus
we do not use the term, instead, we may use the term _sub-page_ we do not use the later term, instead, we may use the term _sub-page_.
**View**
_A path that resolves to a page that may or may not be at that specific
path._
(see: _Page acquisiton_ below)
**Page** **Page**
@ -37,6 +30,19 @@ sub-path of that path must exist.
XXX a word about bootstrap pages that can't be deleted... XXX a word about bootstrap pages that can't be deleted...
**View**
_A path that resolves to a page that may or may not be at that specific
path._
A _view's_ path may match that of a specific page or may not match any
page directly, but any view will resolve to a page via the _acquisition
process_
Any page is a view, but not every view is a page.
(see: _Page acquisiton_ below)
**WikiWord** **WikiWord**
_XXX_ _XXX_
@ -44,8 +50,8 @@ _XXX_
## Page acquisition ## Page acquisition
pWiki path system differs from how traditional file system paths are pWiki path system differs from how traditional file system paths are
handled. In pWiki if a path does not reference a page directly a search handled. In pWiki if a path does not reference a page directly, a search
is conducted to find an alternative page. This search is call _page is conducted to find an alternative page. This search is called _page
acquisition_. acquisition_.
**Acquisition process:** **Acquisition process:**