1
2
3
4
5
6
7
8
9
10
|
<h1>Managing Project Documentation</h1>
Fossil provides a built-in wiki which 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:
|
|
|
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
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:
|
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
Or <i><version></i> can be one of the keywords "<b>tip</b>" or
"<b>ckout</b>". The "<b>tip</b>" keyword means to use the most recently
checked-in baseline. This is useful if you want to see the very latest
version of the documentation. The "<b>ckout</b>" keywords means to
pull the documentation file from the local source tree on disk, not
from the any versioned baseline. The "<b>ckout</b>" keyword normally
only works when you start your server using the "<b>fossil server</b>"
command line and is intented to show what the documenation you are currently
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
|
>
|
|
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
Or <i><version></i> can be one of the keywords "<b>tip</b>" or
"<b>ckout</b>". The "<b>tip</b>" keyword means to use the most recently
checked-in baseline. This is useful if you want to see the very latest
version of the documentation. The "<b>ckout</b>" keywords means to
pull the documentation file from the local source tree on disk, not
from the any versioned baseline. The "<b>ckout</b>" keyword normally
only works when you start your server using the "<b>fossil server</b>"
or "<b>fossil ui</b>"
command line and is intented to show what the documentation you are currently
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
|