Fossil SCM
Be clearer about the definition of technote comment & id. Improve technote doc.
Commit
51292810f8c2a8db4bbe0aace28bd7d916476c93986e0ab54df6c38d743c60cf
Parent
ae70df75505e0cc…
2 files changed
+3
-3
+20
-3
+3
-3
| --- src/wiki.c | ||
| +++ src/wiki.c | ||
| @@ -1928,16 +1928,16 @@ | ||
| 1928 | 1928 | ** <html><body>...</body></html>. |
| 1929 | 1929 | ** -p|--pre If -h|-H is used and the page or technote has |
| 1930 | 1930 | ** the text/plain mimetype, its HTML-escaped output |
| 1931 | 1931 | ** will be wrapped in <pre>...</pre>. |
| 1932 | 1932 | ** |
| 1933 | -** > fossil wiki (create|commit) (PAGENAME | TECHNOTE-NAME) ?FILE? ?OPTIONS? | |
| 1933 | +** > fossil wiki (create|commit) (PAGENAME | TECHNOTE-COMMENT) ?FILE? ?OPTIONS? | |
| 1934 | 1934 | ** |
| 1935 | 1935 | ** Create a new or commit changes to an existing wiki page or |
| 1936 | 1936 | ** technote from FILE or from standard input. PAGENAME is the |
| 1937 | -** name of the wiki entry or the timeline comment of the | |
| 1938 | -** technote. | |
| 1937 | +** name of the wiki entry. TECHNOTE-COMMENT is the timeline comment of | |
| 1938 | +** the technote. | |
| 1939 | 1939 | ** |
| 1940 | 1940 | ** Options: |
| 1941 | 1941 | ** -M|--mimetype TEXT-FORMAT The mime type of the update. |
| 1942 | 1942 | ** Defaults to the type used by |
| 1943 | 1943 | ** the previous version of the |
| 1944 | 1944 |
| --- src/wiki.c | |
| +++ src/wiki.c | |
| @@ -1928,16 +1928,16 @@ | |
| 1928 | ** <html><body>...</body></html>. |
| 1929 | ** -p|--pre If -h|-H is used and the page or technote has |
| 1930 | ** the text/plain mimetype, its HTML-escaped output |
| 1931 | ** will be wrapped in <pre>...</pre>. |
| 1932 | ** |
| 1933 | ** > fossil wiki (create|commit) (PAGENAME | TECHNOTE-NAME) ?FILE? ?OPTIONS? |
| 1934 | ** |
| 1935 | ** Create a new or commit changes to an existing wiki page or |
| 1936 | ** technote from FILE or from standard input. PAGENAME is the |
| 1937 | ** name of the wiki entry or the timeline comment of the |
| 1938 | ** technote. |
| 1939 | ** |
| 1940 | ** Options: |
| 1941 | ** -M|--mimetype TEXT-FORMAT The mime type of the update. |
| 1942 | ** Defaults to the type used by |
| 1943 | ** the previous version of the |
| 1944 |
| --- src/wiki.c | |
| +++ src/wiki.c | |
| @@ -1928,16 +1928,16 @@ | |
| 1928 | ** <html><body>...</body></html>. |
| 1929 | ** -p|--pre If -h|-H is used and the page or technote has |
| 1930 | ** the text/plain mimetype, its HTML-escaped output |
| 1931 | ** will be wrapped in <pre>...</pre>. |
| 1932 | ** |
| 1933 | ** > fossil wiki (create|commit) (PAGENAME | TECHNOTE-COMMENT) ?FILE? ?OPTIONS? |
| 1934 | ** |
| 1935 | ** Create a new or commit changes to an existing wiki page or |
| 1936 | ** technote from FILE or from standard input. PAGENAME is the |
| 1937 | ** name of the wiki entry. TECHNOTE-COMMENT is the timeline comment of |
| 1938 | ** the technote. |
| 1939 | ** |
| 1940 | ** Options: |
| 1941 | ** -M|--mimetype TEXT-FORMAT The mime type of the update. |
| 1942 | ** Defaults to the type used by |
| 1943 | ** the previous version of the |
| 1944 |
+20
-3
| --- www/event.wiki | ||
| +++ www/event.wiki | ||
| @@ -31,11 +31,12 @@ | ||
| 31 | 31 | * <b>Process Checkpoints</b>. For projects that have a formal process, |
| 32 | 32 | technotes can be used to record the completion or the initiation of |
| 33 | 33 | various process steps. For example, a technote can be used to record |
| 34 | 34 | the successful completion of a long-running test, perhaps with |
| 35 | 35 | performance results and details of where the test was run and who |
| 36 | - ran it recorded in the wiki content. | |
| 36 | + ran it recorded in the wiki content. The technote can be added | |
| 37 | + from a script. | |
| 37 | 38 | |
| 38 | 39 | * <b>News Articles</b>. Significant occurrences in the life cycle of |
| 39 | 40 | a project can be recorded as news articles using technotes. Perhaps the |
| 40 | 41 | domain name of the canonical website for a project changes, or new |
| 41 | 42 | server hardware is obtained. Such happenings are appropriate for |
| @@ -58,11 +59,11 @@ | ||
| 58 | 59 | and technotes. |
| 59 | 60 | |
| 60 | 61 | Technotes show up on the timeline. Click on the hyperlink beside the |
| 61 | 62 | technote title to see the complete text. |
| 62 | 63 | |
| 63 | -<h2>Creating And Editing Technotes</h2> | |
| 64 | +<h2>Creating, Editing and Viewing Technotes</h2> | |
| 64 | 65 | |
| 65 | 66 | There is a hyperlink under the /wikihelp menu that can be used to create |
| 66 | 67 | new technotes. And there is a submenu hyperlink on technote displays for |
| 67 | 68 | editing existing technotes. |
| 68 | 69 | |
| @@ -75,14 +76,30 @@ | ||
| 75 | 76 | </b> |
| 76 | 77 | </blockquote> |
| 77 | 78 | |
| 78 | 79 | This command inserts a light green technote in the timeline at 2021-03-15 13:05:56, with |
| 79 | 80 | the contents of file <b>technote.md</b> and comment "TestTechnote". Specifying a different time using |
| 80 | -<b>-t DATETIME</b> will insert the technote at the specified place in the timeline. | |
| 81 | +<b>-t DATETIME</b> will insert the technote at the specified timestamp location in the timeline. | |
| 82 | +Different technotes can have the same timestamp. | |
| 83 | + | |
| 84 | +The first argument to create, <b>TECHNOTE-COMMENT</b>, is the title text for the technote | |
| 85 | +that appears in the timeline. | |
| 86 | + | |
| 87 | +To view technotes, use the <b>wiki ls</b> command: | |
| 88 | + | |
| 89 | +<blockquote> | |
| 90 | +<b> | |
| 91 | +fossil wiki ls --technote --show-technote-ids<br> | |
| 92 | +<tt>z739263a134bf0da1d28e939f4c4367f51ef4c51 2020-12-19 13:20:19</tt><br> | |
| 93 | +<tt>e15a918a8bed71c2ac091d74dc397b8d3340d5e1 2018-09-22 17:40:10</tt><br> | |
| 94 | +</b> | |
| 95 | +</blockquote> | |
| 96 | + | |
| 97 | +A technote ID is the UUID of the technote. | |
| 81 | 98 | |
| 82 | 99 | Users must have check-in privileges (permission "i") in order to |
| 83 | 100 | create or edit technotes. In addition, users must have create-wiki |
| 84 | 101 | privilege (permission "f") to create new technotes and edit-wiki |
| 85 | 102 | privilege (permission "k") in order to edit existing technotes. |
| 86 | 103 | |
| 87 | 104 | Technote content may be formatted as [/wiki_rules | Fossil wiki], |
| 88 | 105 | [/md_rules | Markdown], or a plain text. |
| 89 | 106 |
| --- www/event.wiki | |
| +++ www/event.wiki | |
| @@ -31,11 +31,12 @@ | |
| 31 | * <b>Process Checkpoints</b>. For projects that have a formal process, |
| 32 | technotes can be used to record the completion or the initiation of |
| 33 | various process steps. For example, a technote can be used to record |
| 34 | the successful completion of a long-running test, perhaps with |
| 35 | performance results and details of where the test was run and who |
| 36 | ran it recorded in the wiki content. |
| 37 | |
| 38 | * <b>News Articles</b>. Significant occurrences in the life cycle of |
| 39 | a project can be recorded as news articles using technotes. Perhaps the |
| 40 | domain name of the canonical website for a project changes, or new |
| 41 | server hardware is obtained. Such happenings are appropriate for |
| @@ -58,11 +59,11 @@ | |
| 58 | and technotes. |
| 59 | |
| 60 | Technotes show up on the timeline. Click on the hyperlink beside the |
| 61 | technote title to see the complete text. |
| 62 | |
| 63 | <h2>Creating And Editing Technotes</h2> |
| 64 | |
| 65 | There is a hyperlink under the /wikihelp menu that can be used to create |
| 66 | new technotes. And there is a submenu hyperlink on technote displays for |
| 67 | editing existing technotes. |
| 68 | |
| @@ -75,14 +76,30 @@ | |
| 75 | </b> |
| 76 | </blockquote> |
| 77 | |
| 78 | This command inserts a light green technote in the timeline at 2021-03-15 13:05:56, with |
| 79 | the contents of file <b>technote.md</b> and comment "TestTechnote". Specifying a different time using |
| 80 | <b>-t DATETIME</b> will insert the technote at the specified place in the timeline. |
| 81 | |
| 82 | Users must have check-in privileges (permission "i") in order to |
| 83 | create or edit technotes. In addition, users must have create-wiki |
| 84 | privilege (permission "f") to create new technotes and edit-wiki |
| 85 | privilege (permission "k") in order to edit existing technotes. |
| 86 | |
| 87 | Technote content may be formatted as [/wiki_rules | Fossil wiki], |
| 88 | [/md_rules | Markdown], or a plain text. |
| 89 |
| --- www/event.wiki | |
| +++ www/event.wiki | |
| @@ -31,11 +31,12 @@ | |
| 31 | * <b>Process Checkpoints</b>. For projects that have a formal process, |
| 32 | technotes can be used to record the completion or the initiation of |
| 33 | various process steps. For example, a technote can be used to record |
| 34 | the successful completion of a long-running test, perhaps with |
| 35 | performance results and details of where the test was run and who |
| 36 | ran it recorded in the wiki content. The technote can be added |
| 37 | from a script. |
| 38 | |
| 39 | * <b>News Articles</b>. Significant occurrences in the life cycle of |
| 40 | a project can be recorded as news articles using technotes. Perhaps the |
| 41 | domain name of the canonical website for a project changes, or new |
| 42 | server hardware is obtained. Such happenings are appropriate for |
| @@ -58,11 +59,11 @@ | |
| 59 | and technotes. |
| 60 | |
| 61 | Technotes show up on the timeline. Click on the hyperlink beside the |
| 62 | technote title to see the complete text. |
| 63 | |
| 64 | <h2>Creating, Editing and Viewing Technotes</h2> |
| 65 | |
| 66 | There is a hyperlink under the /wikihelp menu that can be used to create |
| 67 | new technotes. And there is a submenu hyperlink on technote displays for |
| 68 | editing existing technotes. |
| 69 | |
| @@ -75,14 +76,30 @@ | |
| 76 | </b> |
| 77 | </blockquote> |
| 78 | |
| 79 | This command inserts a light green technote in the timeline at 2021-03-15 13:05:56, with |
| 80 | the contents of file <b>technote.md</b> and comment "TestTechnote". Specifying a different time using |
| 81 | <b>-t DATETIME</b> will insert the technote at the specified timestamp location in the timeline. |
| 82 | Different technotes can have the same timestamp. |
| 83 | |
| 84 | The first argument to create, <b>TECHNOTE-COMMENT</b>, is the title text for the technote |
| 85 | that appears in the timeline. |
| 86 | |
| 87 | To view technotes, use the <b>wiki ls</b> command: |
| 88 | |
| 89 | <blockquote> |
| 90 | <b> |
| 91 | fossil wiki ls --technote --show-technote-ids<br> |
| 92 | <tt>z739263a134bf0da1d28e939f4c4367f51ef4c51 2020-12-19 13:20:19</tt><br> |
| 93 | <tt>e15a918a8bed71c2ac091d74dc397b8d3340d5e1 2018-09-22 17:40:10</tt><br> |
| 94 | </b> |
| 95 | </blockquote> |
| 96 | |
| 97 | A technote ID is the UUID of the technote. |
| 98 | |
| 99 | Users must have check-in privileges (permission "i") in order to |
| 100 | create or edit technotes. In addition, users must have create-wiki |
| 101 | privilege (permission "f") to create new technotes and edit-wiki |
| 102 | privilege (permission "k") in order to edit existing technotes. |
| 103 | |
| 104 | Technote content may be formatted as [/wiki_rules | Fossil wiki], |
| 105 | [/md_rules | Markdown], or a plain text. |
| 106 |