1
2
3
4
5
6
7
8
9
10
|
<h1>Managing Project Documentation</h1>
Fossil provides a built-in [/wiki | wiki] that can be used to store the
|
>
|
|
1
2
3
4
5
6
7
8
9
10
11
|
<h1>Managing Project Documentation</h1>
Fossil provides a built-in <a href="wikitheory.wiki">wiki</a>
that can be used to store the
documentation for a project. This is sufficient for many projects.
If your project is well-served by wiki documentation, then you
need read no further.
But fossil also supports embedding project documentation as
files in the source tree. There are several potential advantages
to this approach:
|
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
editing looks like before you check it in.
Finally, the <i><filename></i> element of the URL is the full
pathname of the documentation file starting from the root of the source
tree.
The mimetype (and thus the rendering) of documentation files is
determined by the file suffix. Fossil currently understands the
following file suffixes or embedded documents:
* .css
* .gif
* .htm
* .html
* .jpg
* .jpeg
* .png
* .txt
* .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.
file using the URL:
[http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki].
The first part of this path, the "[http://www.fossil-scm.org/index.html]",
is the base URL. You might have originally typed:
[http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org
site automatically redirects such links by appending "index.html". The
"index.html" file on www.fossil-scm.org is really a CGI script
(do not be mislead by the name) which runs the fossil web service in
|
|
|
|
<
<
<
<
<
<
<
<
<
<
<
<
|
>
|
|
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
editing looks like before you check it in.
Finally, the <i><filename></i> element of the URL is the full
pathname of the documentation file starting from the root of the source
tree.
The mimetype (and thus the rendering) of documentation files is
determined by the file suffix. Fossil currently understands 192
different file suffixes, including all the popular ones such as
".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt".
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.
<h2>Examples</h2>
This file that you are currently reading is an example of
embedded documentation. The name of this file in the fossil
source tree is "<b>www/embeddeddoc.wiki</b>".
You are perhaps looking at this
file using the URL:
[http://www.fossil-scm.org/index.html/doc/tip/www/embeddeddoc.wiki].
The first part of this path, the "[http://www.fossil-scm.org/index.html]",
is the base URL. You might have originally typed:
[http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org
site automatically redirects such links by appending "index.html". The
"index.html" file on www.fossil-scm.org is really a CGI script
(do not be mislead by the name) which runs the fossil web service in
|