mirror of
https://github.com/flynx/pWiki.git
synced 2025-10-29 18:10:09 +00:00
tweaking docs...
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
parent
c5eaace8bc
commit
0a9163c76d
@ -38,7 +38,7 @@ are likely to change, the implementation / API **will definitely** change! ;)_
|
|||||||
|
|
||||||
The app serves the following goals:
|
The app serves the following goals:
|
||||||
|
|
||||||
- a simple and functional note / todo / outline app (obviously)
|
- a simple and functional note / todo / outline app (_obviously_)
|
||||||
- an external/portable Wiki editor, as an alternative for
|
- an external/portable Wiki editor, as an alternative for
|
||||||
in-target-app documentation editor with ability to seamlesly
|
in-target-app documentation editor with ability to seamlesly
|
||||||
synchronize with the target app pWiki instance.
|
synchronize with the target app pWiki instance.
|
||||||
|
|||||||
2
bootstrap.js
vendored
2
bootstrap.js
vendored
File diff suppressed because one or more lines are too long
@ -26,6 +26,8 @@ The two forms exist to fill two distinct functions:
|
|||||||
- inline: compatible with attribute values and short
|
- inline: compatible with attribute values and short
|
||||||
- html-like: element-like, simpler when dealing with html
|
- html-like: element-like, simpler when dealing with html
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Escaping macros
|
### Escaping macros
|
||||||
|
|
||||||
Macros can be escaped for inclusion in the page, the two types of macros
|
Macros can be escaped for inclusion in the page, the two types of macros
|
||||||
@ -68,6 +70,20 @@ Get current date in seconds since epoch, this is equivalet Javascript's
|
|||||||
|
|
||||||
This is mostly used for automatically creating paths (see: todo / outline)
|
This is mostly used for automatically creating paths (see: todo / outline)
|
||||||
|
|
||||||
|
This is different from `$NOW` in path (see: Doc/Path) in that this gets
|
||||||
|
the date once per page load, i.e. the date changes on page load, while
|
||||||
|
`$NOW` is set every time the path is used, i.e. on every click or script
|
||||||
|
use.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
```
|
||||||
|
\@now()
|
||||||
|
```
|
||||||
|
Will produce: `@now()`
|
||||||
|
|
||||||
|
_NOTE: when viewing from outside of pWiki, this should look like: `1471389217848`_
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### filter (name)
|
### filter (name)
|
||||||
|
|
||||||
@ -84,8 +100,9 @@ Filters:
|
|||||||
- wikiword (default)
|
- wikiword (default)
|
||||||
- markdown
|
- markdown
|
||||||
|
|
||||||
Example:
|
**Example:**
|
||||||
- `[./_edit]` -- see the macro at the end of the page.
|
- `[./_edit]` -- _see the macro at the end of the page._
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### include (src isolated text)
|
### include (src isolated text)
|
||||||
@ -102,6 +119,10 @@ Arguments:
|
|||||||
- `isolated` -- prevent slots from included page from affecting the including page.
|
- `isolated` -- prevent slots from included page from affecting the including page.
|
||||||
- `text` -- is used when recursive include is detected and ignored otherwise.
|
- `text` -- is used when recursive include is detected and ignored otherwise.
|
||||||
|
|
||||||
|
_For examples see `slot` macro exaples below._
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### source (src) / quote (src)
|
### source (src) / quote (src)
|
||||||
|
|
||||||
Insert a page without rendering. This is similar to include but will not
|
Insert a page without rendering. This is similar to include but will not
|
||||||
@ -115,6 +136,12 @@ The difference between `source` and `quote` is:
|
|||||||
Arguments:
|
Arguments:
|
||||||
- `src` -- path to source page.
|
- `src` -- path to source page.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
|
||||||
|
[Templates/\_css] / [bootstrap css](bootstrap/Templates/_css.html):
|
||||||
|
```
|
||||||
|
@source(Templates/_css)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### slot (name text)
|
### slot (name text)
|
||||||
@ -124,6 +151,18 @@ Define or fill a slot.
|
|||||||
First occurrence of a `name` will _define_ a slot and fill it with `text`.
|
First occurrence of a `name` will _define_ a slot and fill it with `text`.
|
||||||
Each new occurrence of a name will change slot content.
|
Each new occurrence of a name will change slot content.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
|
||||||
|
[Templates/\_view] / [bootstrap view](bootstrap/Templates/_view.html):
|
||||||
|
```
|
||||||
|
@source(Templates/_view)
|
||||||
|
```
|
||||||
|
|
||||||
|
[Templates/\_edit] / [bootstrap edit](bootstrap/Templates/_edit.html):
|
||||||
|
```
|
||||||
|
@source(Templates/_edit)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### macro (name src text) / else ()
|
### macro (name src text) / else ()
|
||||||
|
|
||||||
@ -150,6 +189,13 @@ Arguments:
|
|||||||
`else` macro is applicable inside `macro`. it is used when the `src` path
|
`else` macro is applicable inside `macro`. it is used when the `src` path
|
||||||
of `macro` matches no pages.
|
of `macro` matches no pages.
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
|
||||||
|
[Templates/pages] / [bootstrap pages](bootstrap/Templates/pages.html):
|
||||||
|
```
|
||||||
|
@source(Templates/pages)
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
<!-- @filter(markdown) -->
|
<!-- @filter(markdown) -->
|
||||||
<!-- vim:set ts=4 sw=4 ft=markdown : -->
|
<!-- vim:set ts=4 sw=4 ft=markdown : -->
|
||||||
|
|||||||
@ -44,7 +44,8 @@ h2, h3 {
|
|||||||
pre {
|
pre {
|
||||||
display: block;
|
display: block;
|
||||||
background-color: rgba(0, 0, 0, 0.05);
|
background-color: rgba(0, 0, 0, 0.05);
|
||||||
padding: 5px;
|
padding: 10px;
|
||||||
|
padding-bottom: 15px;
|
||||||
|
|
||||||
-moz-tab-size: 4;
|
-moz-tab-size: 4;
|
||||||
-o-tab-size: 4;
|
-o-tab-size: 4;
|
||||||
|
|||||||
@ -1,5 +1,3 @@
|
|||||||
<!-- @filter(-wikiword) -->
|
|
||||||
|
|
||||||
<include src="../_view"/>
|
<include src="../_view"/>
|
||||||
|
|
||||||
<slot name="toggle-edit-link">(<a href="#..">view</a>)</slot>
|
<slot name="toggle-edit-link">(<a href="#..">view</a>)</slot>
|
||||||
@ -10,4 +8,5 @@
|
|||||||
<code><pre><quote src="../raw" class="raw" saveto=".." contenteditable/></pre></code>
|
<code><pre><quote src="../raw" class="raw" saveto=".." contenteditable/></pre></code>
|
||||||
</slot>
|
</slot>
|
||||||
|
|
||||||
|
<!-- @filter(-wikiword) -->
|
||||||
<!-- vim:set ts=4 sw=4 : -->
|
<!-- vim:set ts=4 sw=4 : -->
|
||||||
|
|||||||
@ -4,6 +4,9 @@
|
|||||||
<span class="separator"/>
|
<span class="separator"/>
|
||||||
<a class="button" href="#@source(./path)/delete">×</a>
|
<a class="button" href="#@source(./path)/delete">×</a>
|
||||||
</div>
|
</div>
|
||||||
|
<else>
|
||||||
|
No pages...
|
||||||
|
</else>
|
||||||
</macro>
|
</macro>
|
||||||
|
|
||||||
<!-- vim:set ts=4 sw=4 : -->
|
<!-- vim:set ts=4 sw=4 : -->
|
||||||
|
|||||||
@ -4,6 +4,9 @@
|
|||||||
<span class="separator"/>
|
<span class="separator"/>
|
||||||
<a class="button" href="#@source(./path)/delete">×</a>
|
<a class="button" href="#@source(./path)/delete">×</a>
|
||||||
</div>
|
</div>
|
||||||
|
<else>
|
||||||
|
No pages...
|
||||||
|
</else>
|
||||||
</macro>
|
</macro>
|
||||||
|
|
||||||
<!-- vim:set ts=4 sw=4 : -->
|
<!-- vim:set ts=4 sw=4 : -->
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user