39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
The <i><baseurl></i> is the main URL used to access the fossil web server.
For example, the <i><baseurl></i> for the fossil project itself is
[https://www.fossil-scm.org/fossil].
If you launch the web server using the "[/help?cmd=ui|fossil ui]" command line,
then the <i><baseurl></i> is usually
<b>http://localhost:8080/</b>.
The <i><version></i> is [./checkin_names.wiki|name of a check-in]
that contains the embedded document. This might be a hash prefix for
the check-in, or it might be the name of a branch or tag, or it might
be a timestamp. See the [./checkin_names.wiki|check-in name documentation]
for more possibilities and examples. The <i><version></i> can
also be the special identifier "<b>ckout</b>".
The "<b>ckout</b>" keywords means to
pull the documentation file from the local source tree on disk, not
from the any check-in. The "<b>ckout</b>" keyword
only works when you start your server using the
"[/help?cmd=server|fossil server]" or "[/help?cmd=ui|fossil ui]"
commands. The "/doc/ckout" URL is intended to show a preview of
the documentation you are currently editing but have not yet you checked in.
Finally, the <i><filename></i> element of the URL is the
pathname of the documentation file relative to the root of the source
tree.
The mimetype (and thus the rendering) of documentation files is
determined by the file suffix. Fossil currently understands
[/mimetype_list|many different file suffixes],
|
|
>
|
|
>
>
>
>
>
>
>
>
>
>
>
|
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
The <i><baseurl></i> is the main URL used to access the fossil web server.
For example, the <i><baseurl></i> for the fossil project itself is
[https://www.fossil-scm.org/fossil].
If you launch the web server using the "[/help?cmd=ui|fossil ui]" command line,
then the <i><baseurl></i> is usually
<b>http://localhost:8080/</b>.
The <i><version></i> is the
[./checkin_names.wiki|name of a check-in]
that contains the embedded document. This might be a hash prefix for
the check-in, or it might be the name of a branch or tag, or it might
be a timestamp. See the prior link
for more possibilities and examples.
<a id="ckout"></a>The <i><version></i> can
also be the special identifier "<b>ckout</b>".
The "<b>ckout</b>" keywords means to
pull the documentation file from the local source tree on disk, not
from the any check-in. The "<b>ckout</b>" keyword
only works when you start your server using the
"[/help?cmd=server|fossil server]" or "[/help?cmd=ui|fossil ui]"
commands. The "/doc/ckout" URL is intended to show a preview of
the documentation you are currently editing but have not yet you checked in.
The original designed purpose of the "ckout" feature is to allow the
user to preview local changes to documentation before committing the
change. This is an important facility, since unlike other document
languages like HTML, there is still a lot of variation among rendering
engines for Fossil's markup languages, Markdown and Fossil Wiki. Your
changes may look fine in your whizzy GUI Markdown editor, but what
actually matters is how <i>Fossil</i> will interpret your Markdown text.
Therefore, you should always preview your edits before committing them.
Finally, the <i><filename></i> element of the URL is the
pathname of the documentation file relative to the root of the source
tree.
The mimetype (and thus the rendering) of documentation files is
determined by the file suffix. Fossil currently understands
[/mimetype_list|many different file suffixes],
|