mirror of
https://github.com/flynx/pWiki.git
synced 2025-12-27 05:01:57 +00:00
docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
db812c8ede
commit
9f08299104
2
bootstrap.js
vendored
2
bootstrap.js
vendored
File diff suppressed because one or more lines are too long
@ -1,8 +1,8 @@
|
||||
#  pWiki Path
|
||||
|
||||
XXX a Wiki is a set of pages, mostly top level pages, mosty titled in
|
||||
XXX a Wiki is a set of pages, _mostly_ top level pages, _mostly_ titled in
|
||||
WikiWord style, pWiki follows this culture but does not restrict either
|
||||
page nesting or title formatting. But following this style is recommended.
|
||||
page nesting or title formatting, though following this style is recommended.
|
||||
|
||||
XXX write a set of recommendations...
|
||||
|
||||
@ -27,11 +27,11 @@ Paths are case sensitive.
|
||||
_A set of data associated with a path._
|
||||
|
||||
A page is identified by it's path, but this does not require every
|
||||
sub-path of that path to exist -- the full path is the identifier, not
|
||||
a sequence of path parts.
|
||||
sub-path of that path to exist -- the full path is the identifier.
|
||||
|
||||
Some pages are _bootstrapped_, i.e. are predefined in pWiki, these pages
|
||||
can be overridden but can not be removed.
|
||||
can be overridden but can not be removed. This is done to make it simple
|
||||
to revert to the default state if something goes wrong.
|
||||
|
||||
|
||||
**View**
|
||||
@ -49,7 +49,22 @@ is a page.
|
||||
|
||||
|
||||
**WikiWord**
|
||||
_XXX_
|
||||
_A WikiWork is a specially formated string that is treated as a link_
|
||||
|
||||
In pWiki a simple WikiWord is any string starting with a capital letter,
|
||||
must contain at least and one more capital letter and can consist of
|
||||
letters, numbers, underscores (WikiWord itself is a good example)
|
||||
|
||||
A _Path WikiWord_ is a set of path parts separated by '/' the first part
|
||||
must start with a capital letter and the rest can contain letters, numbers
|
||||
and/or underscores (example: Path/to/somepage).
|
||||
|
||||
|
||||
|
||||
**Special path characters**
|
||||
User page titles must not contain the leading underscore `_` character,
|
||||
such paths are used internally.
|
||||
|
||||
|
||||
|
||||
## Page acquisition
|
||||
@ -119,15 +134,28 @@ system configuration. This is done for security reasons.
|
||||
|
||||
XXX
|
||||
|
||||
- `Templates/EmptyPage`
|
||||
- `Templates/EmptyToDo`
|
||||
- `Templates/EmptyOutline`
|
||||
- `EmptyPage`
|
||||
- `EmptyToDo`
|
||||
- `EmptyOutline`
|
||||
- `NoMatch`
|
||||
|
||||
|
||||
|
||||
## Relative and absolute paths (".", "..", ">>" and "/")
|
||||
|
||||
XXX
|
||||
pWiki follows the traditional path semantics with one addition, the ">>"
|
||||
that is similar to ".." but works in the opposite direction, removing
|
||||
the next, i.e. child, path element.
|
||||
|
||||
To illustrate the relative and absolute mechanics:
|
||||
|
||||
| Source Page | Path | Resolves to |
|
||||
|-------------------|-----------------------|-------------------------------|
|
||||
| \Example/Page | \\./Target/Page | \Example/Page/Target/Page |
|
||||
| \Example/Page | \\../Target/Page | \Example/Target/Page |
|
||||
| \Example/Page | >>\/Target/Page | \Example/Page/Page |
|
||||
| \Example/Page | \/Target/Page | \/Target/Page |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -15,6 +15,24 @@ h2, h3 {
|
||||
border-bottom: solid 1px rgba(0, 0, 0, 0.05);
|
||||
}
|
||||
|
||||
|
||||
/* tables */
|
||||
table {
|
||||
width: 100%;
|
||||
}
|
||||
table, td, th {
|
||||
border-bottom: solid 1px gray;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
td, th {
|
||||
text-align: left;
|
||||
padding: 5px;
|
||||
}
|
||||
tr:hover {
|
||||
background-color: rgba(0, 0, 0, 0.05);
|
||||
}
|
||||
|
||||
|
||||
.raw,
|
||||
.text {
|
||||
display: block;
|
||||
@ -76,4 +94,5 @@ pre {
|
||||
display: block;
|
||||
}
|
||||
|
||||
/* @filter(-wikiword) */
|
||||
/* vim:set ts=4 sw=4 ft=css : */
|
||||
|
||||
5
macro.js
5
macro.js
@ -16,7 +16,7 @@ var setWikiWords = function(text, show_brackets, skip){
|
||||
.replace(
|
||||
macro.__wiki_link__,
|
||||
function(l){
|
||||
// check if wikiword is escaped...
|
||||
// check if WikiWord is escaped...
|
||||
if(l[0] == '\\'){
|
||||
return l.slice(1)
|
||||
}
|
||||
@ -95,7 +95,8 @@ module = {
|
||||
|
||||
// XXX should this be here???
|
||||
__wiki_link__: RegExp('('+[
|
||||
'\\\\?(\\./|\\.\\./|[A-Z][a-z0-9]+[A-Z/])[a-zA-Z0-9/]*',
|
||||
//'\\\\?(\\/|\\./|\\.\\./|>>|[A-Z][_a-z0-9]+[A-Z/])[_a-zA-Z0-9/]*',
|
||||
'\\\\?\\/?(\\./|\\.\\./|>>|[A-Z][_a-z0-9]+[A-Z/])[_a-zA-Z0-9/]*',
|
||||
'\\\\?\\[[^\\]]+\\]',
|
||||
].join('|') +')', 'g'),
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user