Fossil SCM
Improvements to the "embedded documentation" documentation.
Commit
c5d9ca673b5364d25ccb0ce3217ed625bfde2c2785635d0c8a498578cfbb68ae
Parent
5c0bb964cdf0e1a…
1 file changed
+27
-28
+27
-28
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -36,31 +36,28 @@ | ||
| 36 | 36 | <i><baseurl></i><big><b>/doc/</b></big><i><version></i><big><b>/</b></big><i><filename></i> |
| 37 | 37 | </blockquote> |
| 38 | 38 | |
| 39 | 39 | The <i><baseurl></i> is the main URL used to access the fossil web server. |
| 40 | 40 | For example, the <i><baseurl></i> for the fossil project itself is |
| 41 | -either <b>http://www.fossil-scm.org/fossil</b> or | |
| 42 | -<b>http://www.hwaci.com/cgi-bin/fossil</b>. | |
| 43 | -If you launch the web server using the "<b>fossil server</b>" command line, | |
| 41 | +[https://www.fossil-scm.org/fossil]. | |
| 42 | +If you launch the web server using the "[/help?cmd=ui|fossil ui]" command line, | |
| 44 | 43 | then the <i><baseurl></i> is usually |
| 45 | 44 | <b>http://localhost:8080/</b>. |
| 46 | 45 | |
| 47 | -The <i><version></i> is any unique prefix of the check-in ID for | |
| 48 | -the check-in containing the documentation you want to access. | |
| 49 | -Or <i><version></i> can be the name of a | |
| 50 | -[./branching.wiki | branch] in order to show | |
| 51 | -the documentation for the latest version of that branch. | |
| 52 | -Or <i><version></i> can be one of the keywords "<b>tip</b>" or | |
| 53 | -"<b>ckout</b>". The "<b>tip</b>" keyword means to use the most recent | |
| 54 | -check-in. This is useful if you want to see the very latest | |
| 55 | -version of the documentation. The "<b>ckout</b>" keywords means to | |
| 46 | +The <i><version></i> is [./checkin_names.wiki|name of a check-in] | |
| 47 | +that contains the embedded document. This might be a hash prefix for | |
| 48 | +the check-in, or it might be the name of a branch or tag, or it might | |
| 49 | +be a timestamp. See the [./checkin_names.wiki|check-in name documentation] | |
| 50 | +for more possibilities and examples. The <i><version></i> can | |
| 51 | +also be the special identifier "<b>ckout</b>". | |
| 52 | +The "<b>ckout</b>" keywords means to | |
| 56 | 53 | pull the documentation file from the local source tree on disk, not |
| 57 | -from the any check-in. The "<b>ckout</b>" keyword normally | |
| 58 | -only works when you start your server using the "<b>fossil server</b>" | |
| 59 | -or "<b>fossil ui</b>" | |
| 60 | -command line and is intended to show what the documentation you are currently | |
| 61 | -editing looks like before you check it in. | |
| 54 | +from the any check-in. The "<b>ckout</b>" keyword | |
| 55 | +only works when you start your server using the | |
| 56 | +"[/help?cmd=server|fossil server]" or "[/help?cmd=ui|fossil ui]" | |
| 57 | +commands. The "/doc/ckout" URL is intended to show a preview of | |
| 58 | +the documentation you are currently but have not yet you checked in. | |
| 62 | 59 | |
| 63 | 60 | Finally, the <i><filename></i> element of the URL is the |
| 64 | 61 | pathname of the documentation file relative to the root of the source |
| 65 | 62 | tree. |
| 66 | 63 | |
| @@ -92,13 +89,15 @@ | ||
| 92 | 89 | |
| 93 | 90 | Then the standard Fossil header and footer are added to the document |
| 94 | 91 | prior to being displayed. The "class='fossil-doc'" attribute is |
| 95 | 92 | required for this to occur. The "data-title='...'" attribute is |
| 96 | 93 | optional, but if it is present the text will become the title displayed |
| 97 | -in the Fossil header. An example of this can be seen in the text | |
| 98 | -of the [/artifact/84b4b3d041d93a?txt=1 | Index Of Fossil Documentation] | |
| 99 | -document. | |
| 94 | +in the Fossil header. An example of this can be seen in Fossil | |
| 95 | +Documentation Index www/permutedindex.html: | |
| 96 | + | |
| 97 | + * [/file/www/permutedindex.html?txt|source text for <b>www/permutedindex.html</b>] | |
| 98 | + * [/doc/trunk/www/permutedindex.html|<b>www/permutedindex.html</b> rendered as HTML] | |
| 100 | 99 | |
| 101 | 100 | Beware that such HTML files render in the same browser security context |
| 102 | 101 | as all other embedded documentation served from Fossil; they are not |
| 103 | 102 | fully-independent web pages. One practical consequence of this is that |
| 104 | 103 | embedded <tt><script></tt> tags will cause a |
| @@ -181,19 +180,19 @@ | ||
| 181 | 180 | embedded documentation. The name of this file in the fossil |
| 182 | 181 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 183 | 182 | You are perhaps looking at this |
| 184 | 183 | file using the URL: |
| 185 | 184 | |
| 186 | - [http://www.fossil-scm.org/index.html/doc/trunk/www/embeddeddoc.wiki]. | |
| 185 | + [http://www.fossil-scm.org/fossil/doc/trunk/www/embeddeddoc.wiki]. | |
| 187 | 186 | |
| 188 | -The first part of this path, the "[http://www.fossil-scm.org/index.html]", | |
| 187 | +The first part of this path, the "[http://www.fossil-scm.org/fossil]", | |
| 189 | 188 | is the base URL. You might have originally typed: |
| 190 | 189 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 191 | -site automatically redirects such links by appending "index.html". The | |
| 192 | -"index.html" file on www.fossil-scm.org is really a CGI script | |
| 193 | -(do not be mislead by the name) which runs the fossil web service in | |
| 194 | -CGI mode. The "index.html" CGI script looks like this: | |
| 190 | +site automatically redirects such links by appending "fossil". The | |
| 191 | +"fossil" file on www.fossil-scm.org is really a CGI script | |
| 192 | +which runs the fossil web service in CGI mode. | |
| 193 | +The "fossil" CGI script looks like this: | |
| 195 | 194 | |
| 196 | 195 | <blockquote><pre> |
| 197 | 196 | #!/usr/bin/fossil |
| 198 | 197 | repository: /fossil/fossil.fossil |
| 199 | 198 | </pre></blockquote> |
| @@ -223,12 +222,12 @@ | ||
| 223 | 222 | of the document that was most recently checked in as of the date |
| 224 | 223 | and time specified. So, for example, to see what the fossil website |
| 225 | 224 | looked like at the beginning of 2010, enter: |
| 226 | 225 | |
| 227 | 226 | <blockquote> |
| 228 | -<a href="http://www.fossil-scm.org/index.html/doc/2010-01-01/www/index.wiki"> | |
| 229 | -http://www.fossil-scm.org/index.html/doc/<b>2010-01-01</b>/www/index.wiki | |
| 227 | +<a href="http://www.fossil-scm.org/fossil/doc/2010-01-01/www/index.wiki"> | |
| 228 | +http://www.fossil-scm.org/fossil/doc/<b>2010-01-01</b>/www/index.wiki | |
| 230 | 229 | </a> |
| 231 | 230 | </blockquote> |
| 232 | 231 | |
| 233 | 232 | The file that encodes this document is stored in the fossil source tree under |
| 234 | 233 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 235 | 234 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -36,31 +36,28 @@ | |
| 36 | <i><baseurl></i><big><b>/doc/</b></big><i><version></i><big><b>/</b></big><i><filename></i> |
| 37 | </blockquote> |
| 38 | |
| 39 | The <i><baseurl></i> is the main URL used to access the fossil web server. |
| 40 | For example, the <i><baseurl></i> for the fossil project itself is |
| 41 | either <b>http://www.fossil-scm.org/fossil</b> or |
| 42 | <b>http://www.hwaci.com/cgi-bin/fossil</b>. |
| 43 | If you launch the web server using the "<b>fossil server</b>" command line, |
| 44 | then the <i><baseurl></i> is usually |
| 45 | <b>http://localhost:8080/</b>. |
| 46 | |
| 47 | The <i><version></i> is any unique prefix of the check-in ID for |
| 48 | the check-in containing the documentation you want to access. |
| 49 | Or <i><version></i> can be the name of a |
| 50 | [./branching.wiki | branch] in order to show |
| 51 | the documentation for the latest version of that branch. |
| 52 | Or <i><version></i> can be one of the keywords "<b>tip</b>" or |
| 53 | "<b>ckout</b>". The "<b>tip</b>" keyword means to use the most recent |
| 54 | check-in. This is useful if you want to see the very latest |
| 55 | version of the documentation. The "<b>ckout</b>" keywords means to |
| 56 | pull the documentation file from the local source tree on disk, not |
| 57 | from the any check-in. The "<b>ckout</b>" keyword normally |
| 58 | only works when you start your server using the "<b>fossil server</b>" |
| 59 | or "<b>fossil ui</b>" |
| 60 | command line and is intended to show what the documentation you are currently |
| 61 | editing looks like before you check it in. |
| 62 | |
| 63 | Finally, the <i><filename></i> element of the URL is the |
| 64 | pathname of the documentation file relative to the root of the source |
| 65 | tree. |
| 66 | |
| @@ -92,13 +89,15 @@ | |
| 92 | |
| 93 | Then the standard Fossil header and footer are added to the document |
| 94 | prior to being displayed. The "class='fossil-doc'" attribute is |
| 95 | required for this to occur. The "data-title='...'" attribute is |
| 96 | optional, but if it is present the text will become the title displayed |
| 97 | in the Fossil header. An example of this can be seen in the text |
| 98 | of the [/artifact/84b4b3d041d93a?txt=1 | Index Of Fossil Documentation] |
| 99 | document. |
| 100 | |
| 101 | Beware that such HTML files render in the same browser security context |
| 102 | as all other embedded documentation served from Fossil; they are not |
| 103 | fully-independent web pages. One practical consequence of this is that |
| 104 | embedded <tt><script></tt> tags will cause a |
| @@ -181,19 +180,19 @@ | |
| 181 | embedded documentation. The name of this file in the fossil |
| 182 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 183 | You are perhaps looking at this |
| 184 | file using the URL: |
| 185 | |
| 186 | [http://www.fossil-scm.org/index.html/doc/trunk/www/embeddeddoc.wiki]. |
| 187 | |
| 188 | The first part of this path, the "[http://www.fossil-scm.org/index.html]", |
| 189 | is the base URL. You might have originally typed: |
| 190 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 191 | site automatically redirects such links by appending "index.html". The |
| 192 | "index.html" file on www.fossil-scm.org is really a CGI script |
| 193 | (do not be mislead by the name) which runs the fossil web service in |
| 194 | CGI mode. The "index.html" CGI script looks like this: |
| 195 | |
| 196 | <blockquote><pre> |
| 197 | #!/usr/bin/fossil |
| 198 | repository: /fossil/fossil.fossil |
| 199 | </pre></blockquote> |
| @@ -223,12 +222,12 @@ | |
| 223 | of the document that was most recently checked in as of the date |
| 224 | and time specified. So, for example, to see what the fossil website |
| 225 | looked like at the beginning of 2010, enter: |
| 226 | |
| 227 | <blockquote> |
| 228 | <a href="http://www.fossil-scm.org/index.html/doc/2010-01-01/www/index.wiki"> |
| 229 | http://www.fossil-scm.org/index.html/doc/<b>2010-01-01</b>/www/index.wiki |
| 230 | </a> |
| 231 | </blockquote> |
| 232 | |
| 233 | The file that encodes this document is stored in the fossil source tree under |
| 234 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 235 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -36,31 +36,28 @@ | |
| 36 | <i><baseurl></i><big><b>/doc/</b></big><i><version></i><big><b>/</b></big><i><filename></i> |
| 37 | </blockquote> |
| 38 | |
| 39 | The <i><baseurl></i> is the main URL used to access the fossil web server. |
| 40 | For example, the <i><baseurl></i> for the fossil project itself is |
| 41 | [https://www.fossil-scm.org/fossil]. |
| 42 | If you launch the web server using the "[/help?cmd=ui|fossil ui]" command line, |
| 43 | then the <i><baseurl></i> is usually |
| 44 | <b>http://localhost:8080/</b>. |
| 45 | |
| 46 | The <i><version></i> is [./checkin_names.wiki|name of a check-in] |
| 47 | that contains the embedded document. This might be a hash prefix for |
| 48 | the check-in, or it might be the name of a branch or tag, or it might |
| 49 | be a timestamp. See the [./checkin_names.wiki|check-in name documentation] |
| 50 | for more possibilities and examples. The <i><version></i> can |
| 51 | also be the special identifier "<b>ckout</b>". |
| 52 | The "<b>ckout</b>" keywords means to |
| 53 | pull the documentation file from the local source tree on disk, not |
| 54 | from the any check-in. The "<b>ckout</b>" keyword |
| 55 | only works when you start your server using the |
| 56 | "[/help?cmd=server|fossil server]" or "[/help?cmd=ui|fossil ui]" |
| 57 | commands. The "/doc/ckout" URL is intended to show a preview of |
| 58 | the documentation you are currently but have not yet you checked in. |
| 59 | |
| 60 | Finally, the <i><filename></i> element of the URL is the |
| 61 | pathname of the documentation file relative to the root of the source |
| 62 | tree. |
| 63 | |
| @@ -92,13 +89,15 @@ | |
| 89 | |
| 90 | Then the standard Fossil header and footer are added to the document |
| 91 | prior to being displayed. The "class='fossil-doc'" attribute is |
| 92 | required for this to occur. The "data-title='...'" attribute is |
| 93 | optional, but if it is present the text will become the title displayed |
| 94 | in the Fossil header. An example of this can be seen in Fossil |
| 95 | Documentation Index www/permutedindex.html: |
| 96 | |
| 97 | * [/file/www/permutedindex.html?txt|source text for <b>www/permutedindex.html</b>] |
| 98 | * [/doc/trunk/www/permutedindex.html|<b>www/permutedindex.html</b> rendered as HTML] |
| 99 | |
| 100 | Beware that such HTML files render in the same browser security context |
| 101 | as all other embedded documentation served from Fossil; they are not |
| 102 | fully-independent web pages. One practical consequence of this is that |
| 103 | embedded <tt><script></tt> tags will cause a |
| @@ -181,19 +180,19 @@ | |
| 180 | embedded documentation. The name of this file in the fossil |
| 181 | source tree is "<b>www/embeddeddoc.wiki</b>". |
| 182 | You are perhaps looking at this |
| 183 | file using the URL: |
| 184 | |
| 185 | [http://www.fossil-scm.org/fossil/doc/trunk/www/embeddeddoc.wiki]. |
| 186 | |
| 187 | The first part of this path, the "[http://www.fossil-scm.org/fossil]", |
| 188 | is the base URL. You might have originally typed: |
| 189 | [http://www.fossil-scm.org/]. The web server at the www.fossil-scm.org |
| 190 | site automatically redirects such links by appending "fossil". The |
| 191 | "fossil" file on www.fossil-scm.org is really a CGI script |
| 192 | which runs the fossil web service in CGI mode. |
| 193 | The "fossil" CGI script looks like this: |
| 194 | |
| 195 | <blockquote><pre> |
| 196 | #!/usr/bin/fossil |
| 197 | repository: /fossil/fossil.fossil |
| 198 | </pre></blockquote> |
| @@ -223,12 +222,12 @@ | |
| 222 | of the document that was most recently checked in as of the date |
| 223 | and time specified. So, for example, to see what the fossil website |
| 224 | looked like at the beginning of 2010, enter: |
| 225 | |
| 226 | <blockquote> |
| 227 | <a href="http://www.fossil-scm.org/fossil/doc/2010-01-01/www/index.wiki"> |
| 228 | http://www.fossil-scm.org/fossil/doc/<b>2010-01-01</b>/www/index.wiki |
| 229 | </a> |
| 230 | </blockquote> |
| 231 | |
| 232 | The file that encodes this document is stored in the fossil source tree under |
| 233 | the name "<b>www/embeddeddoc.wiki</b>" and so that name forms the |
| 234 |