Fossil SCM
New document: pikchr.md
Commit
a92365d72213c6dc58740f27600d1a0e05a178e53eac5e2d9faff9c57e1cba3d
Parent
1ddb400886783ae…
3 files changed
+3
-4
+1
-1
+87
+3
-4
| --- www/cgi.wiki | ||
| +++ www/cgi.wiki | ||
| @@ -28,11 +28,12 @@ | ||
| 28 | 28 | <blockquote><verbatim> |
| 29 | 29 | #!/usr/bin/fossil |
| 30 | 30 | repository: /home/www/fossils/myproject.fossil |
| 31 | 31 | </verbatim></blockquote> |
| 32 | 32 | |
| 33 | -Of course, pathnames will likely be different. The first line (the "shebang") | |
| 33 | +Of course, pathnames will likely be different. The first line | |
| 34 | +(the "[wikipedia:/wiki/Shebang_(Unix)|shebang]") | |
| 34 | 35 | always gives the name of the Fossil executable. Subsequent lines are of |
| 35 | 36 | the form "<b>property: argument ...</b>". |
| 36 | 37 | The remainder of this document describes the available properties and |
| 37 | 38 | their arguments. |
| 38 | 39 | |
| @@ -40,11 +41,11 @@ | ||
| 40 | 41 | <h2 id="repository">repository: <i>PATH</i></h2> |
| 41 | 42 | |
| 42 | 43 | This property defines the Fossil repository that the server will use. |
| 43 | 44 | Every Fossil CGI requires either this property or the |
| 44 | 45 | [#directory|<b>directory:</b>] property (but not both). |
| 45 | -Many Fossil repository sets have this one property and no other. | |
| 46 | +Many Fossil CGI scripts have this one property and no other. | |
| 46 | 47 | |
| 47 | 48 | <h2 id="directory">directory: <i>PATH</i></h2> |
| 48 | 49 | |
| 49 | 50 | The PATH is the name of a directory that contains one or more Fossil |
| 50 | 51 | repository files having the suffix ".fossil". If this property is used |
| @@ -104,12 +105,10 @@ | ||
| 104 | 105 | |
| 105 | 106 | This is a Boolean property. |
| 106 | 107 | If it is present, [./caps/ref.html#s | setup capability] |
| 107 | 108 | is granted to any HTTP request that |
| 108 | 109 | comes in over a loopback interface, such as 127.0.0.1. |
| 109 | -If the PATH_INFO string is empty, Fossil will show a list | |
| 110 | -of available Fossil repositories. | |
| 111 | 110 | |
| 112 | 111 | <h2 id="skin">skin: <i>NAME</i></h2> |
| 113 | 112 | |
| 114 | 113 | If NAME is the name of one of the built-in skins supported by Fossil, |
| 115 | 114 | then this option causes Fossil to display using that built-in skin, |
| 116 | 115 |
| --- www/cgi.wiki | |
| +++ www/cgi.wiki | |
| @@ -28,11 +28,12 @@ | |
| 28 | <blockquote><verbatim> |
| 29 | #!/usr/bin/fossil |
| 30 | repository: /home/www/fossils/myproject.fossil |
| 31 | </verbatim></blockquote> |
| 32 | |
| 33 | Of course, pathnames will likely be different. The first line (the "shebang") |
| 34 | always gives the name of the Fossil executable. Subsequent lines are of |
| 35 | the form "<b>property: argument ...</b>". |
| 36 | The remainder of this document describes the available properties and |
| 37 | their arguments. |
| 38 | |
| @@ -40,11 +41,11 @@ | |
| 40 | <h2 id="repository">repository: <i>PATH</i></h2> |
| 41 | |
| 42 | This property defines the Fossil repository that the server will use. |
| 43 | Every Fossil CGI requires either this property or the |
| 44 | [#directory|<b>directory:</b>] property (but not both). |
| 45 | Many Fossil repository sets have this one property and no other. |
| 46 | |
| 47 | <h2 id="directory">directory: <i>PATH</i></h2> |
| 48 | |
| 49 | The PATH is the name of a directory that contains one or more Fossil |
| 50 | repository files having the suffix ".fossil". If this property is used |
| @@ -104,12 +105,10 @@ | |
| 104 | |
| 105 | This is a Boolean property. |
| 106 | If it is present, [./caps/ref.html#s | setup capability] |
| 107 | is granted to any HTTP request that |
| 108 | comes in over a loopback interface, such as 127.0.0.1. |
| 109 | If the PATH_INFO string is empty, Fossil will show a list |
| 110 | of available Fossil repositories. |
| 111 | |
| 112 | <h2 id="skin">skin: <i>NAME</i></h2> |
| 113 | |
| 114 | If NAME is the name of one of the built-in skins supported by Fossil, |
| 115 | then this option causes Fossil to display using that built-in skin, |
| 116 |
| --- www/cgi.wiki | |
| +++ www/cgi.wiki | |
| @@ -28,11 +28,12 @@ | |
| 28 | <blockquote><verbatim> |
| 29 | #!/usr/bin/fossil |
| 30 | repository: /home/www/fossils/myproject.fossil |
| 31 | </verbatim></blockquote> |
| 32 | |
| 33 | Of course, pathnames will likely be different. The first line |
| 34 | (the "[wikipedia:/wiki/Shebang_(Unix)|shebang]") |
| 35 | always gives the name of the Fossil executable. Subsequent lines are of |
| 36 | the form "<b>property: argument ...</b>". |
| 37 | The remainder of this document describes the available properties and |
| 38 | their arguments. |
| 39 | |
| @@ -40,11 +41,11 @@ | |
| 41 | <h2 id="repository">repository: <i>PATH</i></h2> |
| 42 | |
| 43 | This property defines the Fossil repository that the server will use. |
| 44 | Every Fossil CGI requires either this property or the |
| 45 | [#directory|<b>directory:</b>] property (but not both). |
| 46 | Many Fossil CGI scripts have this one property and no other. |
| 47 | |
| 48 | <h2 id="directory">directory: <i>PATH</i></h2> |
| 49 | |
| 50 | The PATH is the name of a directory that contains one or more Fossil |
| 51 | repository files having the suffix ".fossil". If this property is used |
| @@ -104,12 +105,10 @@ | |
| 105 | |
| 106 | This is a Boolean property. |
| 107 | If it is present, [./caps/ref.html#s | setup capability] |
| 108 | is granted to any HTTP request that |
| 109 | comes in over a loopback interface, such as 127.0.0.1. |
| 110 | |
| 111 | <h2 id="skin">skin: <i>NAME</i></h2> |
| 112 | |
| 113 | If NAME is the name of one of the built-in skins supported by Fossil, |
| 114 | then this option causes Fossil to display using that built-in skin, |
| 115 |
+1
-1
| --- www/changes.wiki | ||
| +++ www/changes.wiki | ||
| @@ -4,11 +4,11 @@ | ||
| 4 | 4 | <h2>Changes for Version 2.13 (pending)</h2> |
| 5 | 5 | |
| 6 | 6 | * Added support for [./interwiki.md|interwiki links]. |
| 7 | 7 | * Enable <del> and <ins> markup in wiki. |
| 8 | 8 | * Improvements to the Forum threading display. |
| 9 | - * Added support for embedding [https://pikchr.org|pikchr] | |
| 9 | + * Added support for embedding [./pikchr.md|pikchr] | |
| 10 | 10 | markup in markdown and fossil-wiki content. |
| 11 | 11 | * The new "[/help?cmd=pikchr|pikchr]" command can render |
| 12 | 12 | pikchr scripts, optionally pre-processed with |
| 13 | 13 | [/doc/trunk/www/th1.md|TH1] blocks and variables exactly like |
| 14 | 14 | site skins are. |
| 15 | 15 | |
| 16 | 16 | ADDED www/pikchr.md |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -4,11 +4,11 @@ | |
| 4 | <h2>Changes for Version 2.13 (pending)</h2> |
| 5 | |
| 6 | * Added support for [./interwiki.md|interwiki links]. |
| 7 | * Enable <del> and <ins> markup in wiki. |
| 8 | * Improvements to the Forum threading display. |
| 9 | * Added support for embedding [https://pikchr.org|pikchr] |
| 10 | markup in markdown and fossil-wiki content. |
| 11 | * The new "[/help?cmd=pikchr|pikchr]" command can render |
| 12 | pikchr scripts, optionally pre-processed with |
| 13 | [/doc/trunk/www/th1.md|TH1] blocks and variables exactly like |
| 14 | site skins are. |
| 15 | |
| 16 | DDED www/pikchr.md |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -4,11 +4,11 @@ | |
| 4 | <h2>Changes for Version 2.13 (pending)</h2> |
| 5 | |
| 6 | * Added support for [./interwiki.md|interwiki links]. |
| 7 | * Enable <del> and <ins> markup in wiki. |
| 8 | * Improvements to the Forum threading display. |
| 9 | * Added support for embedding [./pikchr.md|pikchr] |
| 10 | markup in markdown and fossil-wiki content. |
| 11 | * The new "[/help?cmd=pikchr|pikchr]" command can render |
| 12 | pikchr scripts, optionally pre-processed with |
| 13 | [/doc/trunk/www/th1.md|TH1] blocks and variables exactly like |
| 14 | site skins are. |
| 15 | |
| 16 | DDED www/pikchr.md |
+87
| --- a/www/pikchr.md | ||
| +++ b/www/pikchr.md | ||
| @@ -0,0 +1,87 @@ | ||
| 1 | +# The Pikchr Diagram Language | |
| 2 | + | |
| 3 | +Pikchr (pronounced "picture") is a [PIC][1]-like markup language for creating | |
| 4 | +diagrams in technical documentation. Pikchr diagrams source texte text for Pikchr diagrams | |
| 5 | +can be embedded directly in either [Markdown][2] or [Fossil Wiki][3]. | |
| 6 | +Fossil translates the Pikchr source text into SVG which is displayed as | |
| 7 | +part of the rendered wiki. | |
| 8 | + | |
| 9 | +[1]: wikipedia:/wiki/Pic_language | |
| 10 | +[2]: /md_rules | |
| 11 | +[3]: /wiki_rules | |
| 12 | + | |
| 13 | +For example, this document is written in Markdown. The following | |
| 14 | +is a sample Pikchr diagram: | |
| 15 | + | |
| 16 | +``` pikchr | |
| 17 | +arrow right 200% "Markdown" "Source" | |
| 18 | +box rad 10px "Markdown" "Formatter" "(markdown.c)" fit | |
| 19 | +arrow right 200% "HTML+SVG" "Output" | |
| 20 | +arrow <-> down 70% from last box.s | |
| 21 | +box same "Pikchr" "Formatter" "(pikchr.c)" fit | |
| 22 | +``` | |
| 23 | + | |
| 24 | +The diagram above was ``` pikchr | |
| 25 | + matter" "(markdownMarkdown" "Source" | |
| 26 | + ram: | |
| 27 | + | |
| 28 | +``` pikchr | |
| 29 | +arrow right matter" "( t 200% "HTML+SVG" "Output" | |
| 30 | +arrow <- HTML+SVG" "Output" | |
| 31 | +a ormatter" "(pikchr.c)" fit | |
| 32 | +``` | |
| 33 | +~~~~~ | |
| 34 | + | |
| 35 | +See the [original Markdown source text of this document][4] for an | |
| 36 | +example of Pikchr in operation. | |
| 37 | + | |
| 38 | +[4]: ./pikchr.md?mimetype=text/plain | |
| 39 | + | |
| 40 | +Fossil allows Pikchr diagrams to appear anywhere that Markdown or | |
| 41 | +Fossil Wiki markup or used, including: | |
| 42 | + | |
| 43 | + * [Embedded documentation](./embeddeddoc.wiki) | |
| 44 | + * Stand-alone wiki pages | |
| 45 | + * [Wiki pages associated with particular branches or check-ins](./wikitheory.wiki#assocwiki) | |
| 46 | + * Check-in comments | |
| 47 | + * [Technical notes](./event.wiki) | |
| 48 | + * [Forum posts](./forum.wiki) | |
| 49 | + * [Bug reports and trouble tickets](./bugtheory.wiki) | |
| 50 | + | |
| 51 | +## Pikchr Is A Separate Project | |
| 52 | + | |
| 53 | +Even though the original author of Pikchr is the same as the original | |
| 54 | +creator of Fossil, the sources to the Pikchr formatter are maintained | |
| 55 | +as a [separate project named "pikchr.org"](https://pikchr.org). | |
| 56 | +Pikchr is a delivvered as a single file of C code. The "pikchr.c" file | |
| 57 | +from the Pikchr project is periodically copied into the Fossil source | |
| 58 | +tree. Pikchr is maintained as a project distinct from Fossil so that it | |
| 59 | +can be used independently of Fossil. | |
| 60 | + | |
| 61 | +### Pikchr User Manual And Tutorials | |
| 62 | + | |
| 63 | +Complete documentation on the Pikchr language can be found on the | |
| 64 | +Pikchr project page: | |
| 65 | + | |
| 66 | + * <https://pikchr.org/> | |
| 67 | + | |
| 68 | +That website contains a user manual, tutorials, a language specification, | |
| 69 | +a summary of differences between Pikchr and legacy PIC, | |
| 70 | +and it hosts copies of historical PIC documentation. | |
| 71 | + | |
| 72 | +## How To Include Pikchr Diagrams In Fossil Documents | |
| 73 | + | |
| 74 | +To illustrate how to include Pikchr in Fossil markup, we will use the | |
| 75 | +following one-line Pikchr. Click to see the code: | |
| 76 | + | |
| 77 | +~~~ pikchr toggle | |
| 78 | +arrow; box "Hello" "World!" fit; arrow | |
| 79 | +~~~ | |
| 80 | + | |
| 81 | +For Markdown, the Pikchr code is put inside of a | |
| 82 | +[fenced code block][fcb]. A fenced code block is the text in between | |
| 83 | +``` ... ``` or between | |
| 84 | +~~~ ... ~~~ using three or | |
| 85 | +more ` or ~ characters. The fenced code block normally | |
| 86 | +displays its content verbatim, but if an "info string" of "pikchr" | |
| 87 | +follows the opening ``` or ~~~ |
| --- a/www/pikchr.md | |
| +++ b/www/pikchr.md | |
| @@ -0,0 +1,87 @@ | |
| --- a/www/pikchr.md | |
| +++ b/www/pikchr.md | |
| @@ -0,0 +1,87 @@ | |
| 1 | # The Pikchr Diagram Language |
| 2 | |
| 3 | Pikchr (pronounced "picture") is a [PIC][1]-like markup language for creating |
| 4 | diagrams in technical documentation. Pikchr diagrams source texte text for Pikchr diagrams |
| 5 | can be embedded directly in either [Markdown][2] or [Fossil Wiki][3]. |
| 6 | Fossil translates the Pikchr source text into SVG which is displayed as |
| 7 | part of the rendered wiki. |
| 8 | |
| 9 | [1]: wikipedia:/wiki/Pic_language |
| 10 | [2]: /md_rules |
| 11 | [3]: /wiki_rules |
| 12 | |
| 13 | For example, this document is written in Markdown. The following |
| 14 | is a sample Pikchr diagram: |
| 15 | |
| 16 | ``` pikchr |
| 17 | arrow right 200% "Markdown" "Source" |
| 18 | box rad 10px "Markdown" "Formatter" "(markdown.c)" fit |
| 19 | arrow right 200% "HTML+SVG" "Output" |
| 20 | arrow <-> down 70% from last box.s |
| 21 | box same "Pikchr" "Formatter" "(pikchr.c)" fit |
| 22 | ``` |
| 23 | |
| 24 | The diagram above was ``` pikchr |
| 25 | matter" "(markdownMarkdown" "Source" |
| 26 | ram: |
| 27 | |
| 28 | ``` pikchr |
| 29 | arrow right matter" "( t 200% "HTML+SVG" "Output" |
| 30 | arrow <- HTML+SVG" "Output" |
| 31 | a ormatter" "(pikchr.c)" fit |
| 32 | ``` |
| 33 | ~~~~~ |
| 34 | |
| 35 | See the [original Markdown source text of this document][4] for an |
| 36 | example of Pikchr in operation. |
| 37 | |
| 38 | [4]: ./pikchr.md?mimetype=text/plain |
| 39 | |
| 40 | Fossil allows Pikchr diagrams to appear anywhere that Markdown or |
| 41 | Fossil Wiki markup or used, including: |
| 42 | |
| 43 | * [Embedded documentation](./embeddeddoc.wiki) |
| 44 | * Stand-alone wiki pages |
| 45 | * [Wiki pages associated with particular branches or check-ins](./wikitheory.wiki#assocwiki) |
| 46 | * Check-in comments |
| 47 | * [Technical notes](./event.wiki) |
| 48 | * [Forum posts](./forum.wiki) |
| 49 | * [Bug reports and trouble tickets](./bugtheory.wiki) |
| 50 | |
| 51 | ## Pikchr Is A Separate Project |
| 52 | |
| 53 | Even though the original author of Pikchr is the same as the original |
| 54 | creator of Fossil, the sources to the Pikchr formatter are maintained |
| 55 | as a [separate project named "pikchr.org"](https://pikchr.org). |
| 56 | Pikchr is a delivvered as a single file of C code. The "pikchr.c" file |
| 57 | from the Pikchr project is periodically copied into the Fossil source |
| 58 | tree. Pikchr is maintained as a project distinct from Fossil so that it |
| 59 | can be used independently of Fossil. |
| 60 | |
| 61 | ### Pikchr User Manual And Tutorials |
| 62 | |
| 63 | Complete documentation on the Pikchr language can be found on the |
| 64 | Pikchr project page: |
| 65 | |
| 66 | * <https://pikchr.org/> |
| 67 | |
| 68 | That website contains a user manual, tutorials, a language specification, |
| 69 | a summary of differences between Pikchr and legacy PIC, |
| 70 | and it hosts copies of historical PIC documentation. |
| 71 | |
| 72 | ## How To Include Pikchr Diagrams In Fossil Documents |
| 73 | |
| 74 | To illustrate how to include Pikchr in Fossil markup, we will use the |
| 75 | following one-line Pikchr. Click to see the code: |
| 76 | |
| 77 | ~~~ pikchr toggle |
| 78 | arrow; box "Hello" "World!" fit; arrow |
| 79 | ~~~ |
| 80 | |
| 81 | For Markdown, the Pikchr code is put inside of a |
| 82 | [fenced code block][fcb]. A fenced code block is the text in between |
| 83 | ``` ... ``` or between |
| 84 | ~~~ ... ~~~ using three or |
| 85 | more ` or ~ characters. The fenced code block normally |
| 86 | displays its content verbatim, but if an "info string" of "pikchr" |
| 87 | follows the opening ``` or ~~~ |