Fossil

Check-in [8d8a41d1]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Documentation updates.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:8d8a41d195b81dccb271777f747c749d49e37a47
User & Date: drh 2008-07-15 13:46:00
Context
2008-07-15
14:33
Additional documentation updates. check-in: adc0b3bf user: drh tags: trunk
13:46
Documentation updates. check-in: 8d8a41d1 user: drh tags: trunk
02:01
Use the %/ substitution instead of %s when constructing windows pathnames. check-in: 9d232303 user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to src/wiki.c.

501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
*/
void wikirules_page(void){
  style_header("Wiki Formatting Rules");
  @ <h2>Formatting Rule Summary</h2>
  @ <ol>
  @ <li> Blank lines are paragraph breaks
  @ <li> Bullets are "*" surrounded by two spaces at the beginning of the line.
  @ <li> Enumeration items a number surrounded by two space
  @ at the beginning of a line.
  @ <li> Indented pargraphs begin with a tab or two spaces.
  @ <li> Hyperlinks are contained with square brackets:  "[target]"
  @ <li> Most ordinary HTML works.
  @ <li> &lt;verbatim&gt; and &lt;nowiki&gt;.
  @ </ol>
  @ <p>We call the first five rules above "wiki" formatting rules.  The







|







501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
*/
void wikirules_page(void){
  style_header("Wiki Formatting Rules");
  @ <h2>Formatting Rule Summary</h2>
  @ <ol>
  @ <li> Blank lines are paragraph breaks
  @ <li> Bullets are "*" surrounded by two spaces at the beginning of the line.
  @ <li> Enumeration items are a number surrounded by two space
  @ at the beginning of a line.
  @ <li> Indented pargraphs begin with a tab or two spaces.
  @ <li> Hyperlinks are contained with square brackets:  "[target]"
  @ <li> Most ordinary HTML works.
  @ <li> &lt;verbatim&gt; and &lt;nowiki&gt;.
  @ </ol>
  @ <p>We call the first five rules above "wiki" formatting rules.  The

Changes to www/embeddeddoc.wiki.

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
..
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
      text editor instead of having to use the web-based wiki
      editor.

  3.  Only people with check-in privileges can modify the documentation.
      (This might be either an advantage or disadvantage, depending
      on the nature of your project.)

We will call documentation is included as files in the source tree
"embedded documentation".

<h2>Fossil Support For Embedded Documentation</h2>

The fossil web interface supports embedded documentation using
the "/doc" page.  To access embedded documentation, one points
a web browser to a fossil URL of the following form:
................................................................................
  *  .wiki

Documentation files whose names end in ".wiki" use the 
[/wiki_rules | same markup as wiki pages] -
a safe subset of HTML together with some rules for paragraph
breaks, lists, and hyperlinks.  The ".wiki" and ".txt" pages
are rendered with the standard fossil header and footer added.
All other mimetimes are delivered directly to the requesting
web browser with interpretation, additions, or changes.

The list of allowed suffixes for embedded documents is likely to
grow and become user-configurable in future releases of fossil.

<h2>Examples</h2>

This file that you are currently reading is an example of







|







 







|
|







17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
..
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
      text editor instead of having to use the web-based wiki
      editor.

  3.  Only people with check-in privileges can modify the documentation.
      (This might be either an advantage or disadvantage, depending
      on the nature of your project.)

We will call documentation that is included as files in the source tree
"embedded documentation".

<h2>Fossil Support For Embedded Documentation</h2>

The fossil web interface supports embedded documentation using
the "/doc" page.  To access embedded documentation, one points
a web browser to a fossil URL of the following form:
................................................................................
  *  .wiki

Documentation files whose names end in ".wiki" use the 
[/wiki_rules | same markup as wiki pages] -
a safe subset of HTML together with some rules for paragraph
breaks, lists, and hyperlinks.  The ".wiki" and ".txt" pages
are rendered with the standard fossil header and footer added.
All other mimetypes are delivered directly to the requesting
web browser without interpretation, additions, or changes.

The list of allowed suffixes for embedded documents is likely to
grow and become user-configurable in future releases of fossil.

<h2>Examples</h2>

This file that you are currently reading is an example of