Fossil SCM
Update instructions for enabling th1-docs support, per forum feedback.
Commit
17e79abbf04383cc08f98febad6b2304494826396b075af8c70444e502dec840
Parent
bc05e6cc2798049…
1 file changed
+13
-5
+13
-5
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -178,17 +178,25 @@ | ||
| 178 | 178 | As with "$ROOT", this substitution only works for Markdown and HTML |
| 179 | 179 | documents. For Wiki documents, you would need to use a relative URL. |
| 180 | 180 | |
| 181 | 181 | <h2 id="th1">2.3 TH1 Documents</h2> |
| 182 | 182 | |
| 183 | -Fossil will substitute the value of [./th1.md | TH1 expressions] within | |
| 184 | -<tt>{</tt> curly braces <tt>}</tt> into the output HTML if you have | |
| 185 | -configured it with the <tt>--with-th1-docs</tt> option, which is | |
| 186 | -disabled by default. | |
| 183 | +Enabling TH1 document support requires the following: | |
| 184 | + | |
| 185 | + * Configure the build with the <code>--with-th1-docs</code> flag. | |
| 186 | + * Enable the <code>th1-docs</code> setting, which is only available | |
| 187 | + after building with <code>--with-th1-docs</code>. | |
| 188 | + * Affected files must have a <code>.th1</code> file extension. | |
| 189 | + * The code to run must be embedded in blocks of | |
| 190 | + <code><th1>...</th1></code>. | |
| 191 | + | |
| 192 | +Fossil will substitute the value of [./th1.md | TH1 expressions] | |
| 193 | +within the <code><th1>...</th1></code> blocks into | |
| 194 | +the output HTML. | |
| 187 | 195 | |
| 188 | 196 | Since TH1 is a full scripting language, this feature essential grants |
| 189 | -the ability to execute code on the server to anyone with check-in | |
| 197 | +the ability to execute code on the server to anyone with check-in | |
| 190 | 198 | privilege for the project. |
| 191 | 199 | This is a security risk that needs to be carefully managed. |
| 192 | 200 | The feature is off by default. |
| 193 | 201 | Administrators should understand and carefully assess the risks |
| 194 | 202 | before enabling the use of TH1 within embedded documentation. |
| 195 | 203 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -178,17 +178,25 @@ | |
| 178 | As with "$ROOT", this substitution only works for Markdown and HTML |
| 179 | documents. For Wiki documents, you would need to use a relative URL. |
| 180 | |
| 181 | <h2 id="th1">2.3 TH1 Documents</h2> |
| 182 | |
| 183 | Fossil will substitute the value of [./th1.md | TH1 expressions] within |
| 184 | <tt>{</tt> curly braces <tt>}</tt> into the output HTML if you have |
| 185 | configured it with the <tt>--with-th1-docs</tt> option, which is |
| 186 | disabled by default. |
| 187 | |
| 188 | Since TH1 is a full scripting language, this feature essential grants |
| 189 | the ability to execute code on the server to anyone with check-in |
| 190 | privilege for the project. |
| 191 | This is a security risk that needs to be carefully managed. |
| 192 | The feature is off by default. |
| 193 | Administrators should understand and carefully assess the risks |
| 194 | before enabling the use of TH1 within embedded documentation. |
| 195 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -178,17 +178,25 @@ | |
| 178 | As with "$ROOT", this substitution only works for Markdown and HTML |
| 179 | documents. For Wiki documents, you would need to use a relative URL. |
| 180 | |
| 181 | <h2 id="th1">2.3 TH1 Documents</h2> |
| 182 | |
| 183 | Enabling TH1 document support requires the following: |
| 184 | |
| 185 | * Configure the build with the <code>--with-th1-docs</code> flag. |
| 186 | * Enable the <code>th1-docs</code> setting, which is only available |
| 187 | after building with <code>--with-th1-docs</code>. |
| 188 | * Affected files must have a <code>.th1</code> file extension. |
| 189 | * The code to run must be embedded in blocks of |
| 190 | <code><th1>...</th1></code>. |
| 191 | |
| 192 | Fossil will substitute the value of [./th1.md | TH1 expressions] |
| 193 | within the <code><th1>...</th1></code> blocks into |
| 194 | the output HTML. |
| 195 | |
| 196 | Since TH1 is a full scripting language, this feature essential grants |
| 197 | the ability to execute code on the server to anyone with check-in |
| 198 | privilege for the project. |
| 199 | This is a security risk that needs to be carefully managed. |
| 200 | The feature is off by default. |
| 201 | Administrators should understand and carefully assess the risks |
| 202 | before enabling the use of TH1 within embedded documentation. |
| 203 |