17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
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:
|
|
|
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
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:
|
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
* .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
|
|
|
|
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
* .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
|