Fossil SCM
Documentation updates: Revise the change list. Continue migrating from the term "Event" over to "Technical Note". Update the wiki documentation to acknowledge the ability to use Markdown for the past two years.
Commit
de6a590a0f6b6f3bd9a43afab89ce343c4471e2a
Parent
767c97c603633a8…
6 files changed
+1
+2
-2
+6
+22
-8
+30
-30
+6
-2
+1
| --- src/sitemap.c | ||
| +++ src/sitemap.c | ||
| @@ -91,10 +91,11 @@ | ||
| 91 | 91 | @ </ul></li> |
| 92 | 92 | @ <li>On-line Documentation |
| 93 | 93 | @ <ul> |
| 94 | 94 | @ <li>%z(href("%R/help"))List of All Commands and Web Pages</a></li> |
| 95 | 95 | @ <li>%z(href("%R/test-all-help"))All "help" text on a single page</a></li> |
| 96 | + @ <li>%z(href("%R/mimetype_list"))Filename suffix to mimetype map</a></li> | |
| 96 | 97 | @ </ul></li> |
| 97 | 98 | @ <li>%z(href("%R/setup"))Administration Pages</a> |
| 98 | 99 | @ <ul> |
| 99 | 100 | @ <li>%z(href("%R/modreq"))Pending Moderation Requests</a></li> |
| 100 | 101 | @ <li>%z(href("%R/admin_log"))Admin log</a></li> |
| 101 | 102 |
| --- src/sitemap.c | |
| +++ src/sitemap.c | |
| @@ -91,10 +91,11 @@ | |
| 91 | @ </ul></li> |
| 92 | @ <li>On-line Documentation |
| 93 | @ <ul> |
| 94 | @ <li>%z(href("%R/help"))List of All Commands and Web Pages</a></li> |
| 95 | @ <li>%z(href("%R/test-all-help"))All "help" text on a single page</a></li> |
| 96 | @ </ul></li> |
| 97 | @ <li>%z(href("%R/setup"))Administration Pages</a> |
| 98 | @ <ul> |
| 99 | @ <li>%z(href("%R/modreq"))Pending Moderation Requests</a></li> |
| 100 | @ <li>%z(href("%R/admin_log"))Admin log</a></li> |
| 101 |
| --- src/sitemap.c | |
| +++ src/sitemap.c | |
| @@ -91,10 +91,11 @@ | |
| 91 | @ </ul></li> |
| 92 | @ <li>On-line Documentation |
| 93 | @ <ul> |
| 94 | @ <li>%z(href("%R/help"))List of All Commands and Web Pages</a></li> |
| 95 | @ <li>%z(href("%R/test-all-help"))All "help" text on a single page</a></li> |
| 96 | @ <li>%z(href("%R/mimetype_list"))Filename suffix to mimetype map</a></li> |
| 97 | @ </ul></li> |
| 98 | @ <li>%z(href("%R/setup"))Administration Pages</a> |
| 99 | @ <ul> |
| 100 | @ <li>%z(href("%R/modreq"))Pending Moderation Requests</a></li> |
| 101 | @ <li>%z(href("%R/admin_log"))Admin log</a></li> |
| 102 |
+2
-2
| --- src/timeline.c | ||
| +++ src/timeline.c | ||
| @@ -1449,11 +1449,11 @@ | ||
| 1449 | 1449 | }else if( zType[0]=='w' ){ |
| 1450 | 1450 | zEType = "wiki edit"; |
| 1451 | 1451 | }else if( zType[0]=='t' ){ |
| 1452 | 1452 | zEType = "ticket change"; |
| 1453 | 1453 | }else if( zType[0]=='e' ){ |
| 1454 | - zEType = "event"; | |
| 1454 | + zEType = "technical note"; | |
| 1455 | 1455 | }else if( zType[0]=='g' ){ |
| 1456 | 1456 | zEType = "tag"; |
| 1457 | 1457 | } |
| 1458 | 1458 | } |
| 1459 | 1459 | if( zUser ){ |
| @@ -1815,11 +1815,11 @@ | ||
| 1815 | 1815 | ** -p|--path PATH Output items affecting PATH only. |
| 1816 | 1816 | ** PATH can be a file or a sub directory. |
| 1817 | 1817 | ** --offset P skip P changes |
| 1818 | 1818 | ** -t|--type TYPE Output items from the given types only, such as: |
| 1819 | 1819 | ** ci = file commits only |
| 1820 | -** e = events only | |
| 1820 | +** e = technical notes only | |
| 1821 | 1821 | ** t = tickets only |
| 1822 | 1822 | ** w = wiki commits only |
| 1823 | 1823 | ** -v|--verbose Output the list of files changed by each commit |
| 1824 | 1824 | ** and the type of each change (edited, deleted, |
| 1825 | 1825 | ** etc.) after the checkin comment. |
| 1826 | 1826 |
| --- src/timeline.c | |
| +++ src/timeline.c | |
| @@ -1449,11 +1449,11 @@ | |
| 1449 | }else if( zType[0]=='w' ){ |
| 1450 | zEType = "wiki edit"; |
| 1451 | }else if( zType[0]=='t' ){ |
| 1452 | zEType = "ticket change"; |
| 1453 | }else if( zType[0]=='e' ){ |
| 1454 | zEType = "event"; |
| 1455 | }else if( zType[0]=='g' ){ |
| 1456 | zEType = "tag"; |
| 1457 | } |
| 1458 | } |
| 1459 | if( zUser ){ |
| @@ -1815,11 +1815,11 @@ | |
| 1815 | ** -p|--path PATH Output items affecting PATH only. |
| 1816 | ** PATH can be a file or a sub directory. |
| 1817 | ** --offset P skip P changes |
| 1818 | ** -t|--type TYPE Output items from the given types only, such as: |
| 1819 | ** ci = file commits only |
| 1820 | ** e = events only |
| 1821 | ** t = tickets only |
| 1822 | ** w = wiki commits only |
| 1823 | ** -v|--verbose Output the list of files changed by each commit |
| 1824 | ** and the type of each change (edited, deleted, |
| 1825 | ** etc.) after the checkin comment. |
| 1826 |
| --- src/timeline.c | |
| +++ src/timeline.c | |
| @@ -1449,11 +1449,11 @@ | |
| 1449 | }else if( zType[0]=='w' ){ |
| 1450 | zEType = "wiki edit"; |
| 1451 | }else if( zType[0]=='t' ){ |
| 1452 | zEType = "ticket change"; |
| 1453 | }else if( zType[0]=='e' ){ |
| 1454 | zEType = "technical note"; |
| 1455 | }else if( zType[0]=='g' ){ |
| 1456 | zEType = "tag"; |
| 1457 | } |
| 1458 | } |
| 1459 | if( zUser ){ |
| @@ -1815,11 +1815,11 @@ | |
| 1815 | ** -p|--path PATH Output items affecting PATH only. |
| 1816 | ** PATH can be a file or a sub directory. |
| 1817 | ** --offset P skip P changes |
| 1818 | ** -t|--type TYPE Output items from the given types only, such as: |
| 1819 | ** ci = file commits only |
| 1820 | ** e = technical notes only |
| 1821 | ** t = tickets only |
| 1822 | ** w = wiki commits only |
| 1823 | ** -v|--verbose Output the list of files changed by each commit |
| 1824 | ** and the type of each change (edited, deleted, |
| 1825 | ** etc.) after the checkin comment. |
| 1826 |
+6
| --- www/changes.wiki | ||
| +++ www/changes.wiki | ||
| @@ -20,12 +20,18 @@ | ||
| 20 | 20 | [/help?cmd=ui|ui], or |
| 21 | 21 | [/help?cmd=http|http] commands. |
| 22 | 22 | * Embedded html documents that begin with |
| 23 | 23 | <doc class="fossil-doc"> are displayed with standard |
| 24 | 24 | headers and footers added. |
| 25 | + * Renamed "Events" to "Technical Notes", while updating the technote | |
| 26 | + display and control pages. Add support for technotes as plain text | |
| 27 | + or as Markdown. | |
| 25 | 28 | * Added the [/md_rules] pages containing summary instructions on the |
| 26 | 29 | Markdown format. |
| 30 | + * Improvements to the /login page. Some hyperlinks to pages that require | |
| 31 | + "anonymous" privileges are displayed even if the current user is "nobody" | |
| 32 | + but automatically redirect to /login. | |
| 27 | 33 | * The [/help?cmd=/doc|/doc] web-page will now try to deliver the file |
| 28 | 34 | "404.md" from the top-level directory (if such a file exists) in |
| 29 | 35 | place of its built-in 404 text. |
| 30 | 36 | * Download of Tarballs and ZIP Archives by user "nobody" is now enabled |
| 31 | 37 | by default in new repositories. |
| 32 | 38 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -20,12 +20,18 @@ | |
| 20 | [/help?cmd=ui|ui], or |
| 21 | [/help?cmd=http|http] commands. |
| 22 | * Embedded html documents that begin with |
| 23 | <doc class="fossil-doc"> are displayed with standard |
| 24 | headers and footers added. |
| 25 | * Added the [/md_rules] pages containing summary instructions on the |
| 26 | Markdown format. |
| 27 | * The [/help?cmd=/doc|/doc] web-page will now try to deliver the file |
| 28 | "404.md" from the top-level directory (if such a file exists) in |
| 29 | place of its built-in 404 text. |
| 30 | * Download of Tarballs and ZIP Archives by user "nobody" is now enabled |
| 31 | by default in new repositories. |
| 32 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -20,12 +20,18 @@ | |
| 20 | [/help?cmd=ui|ui], or |
| 21 | [/help?cmd=http|http] commands. |
| 22 | * Embedded html documents that begin with |
| 23 | <doc class="fossil-doc"> are displayed with standard |
| 24 | headers and footers added. |
| 25 | * Renamed "Events" to "Technical Notes", while updating the technote |
| 26 | display and control pages. Add support for technotes as plain text |
| 27 | or as Markdown. |
| 28 | * Added the [/md_rules] pages containing summary instructions on the |
| 29 | Markdown format. |
| 30 | * Improvements to the /login page. Some hyperlinks to pages that require |
| 31 | "anonymous" privileges are displayed even if the current user is "nobody" |
| 32 | but automatically redirect to /login. |
| 33 | * The [/help?cmd=/doc|/doc] web-page will now try to deliver the file |
| 34 | "404.md" from the top-level directory (if such a file exists) in |
| 35 | place of its built-in 404 text. |
| 36 | * Download of Tarballs and ZIP Archives by user "nobody" is now enabled |
| 37 | by default in new repositories. |
| 38 |
+22
-8
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -1,7 +1,7 @@ | ||
| 1 | -<title>Managing Project Documentation</title> | |
| 2 | -<h1 align="center">Managing Project Documentation</h1> | |
| 1 | +<title>Project Documentation</title> | |
| 2 | +<h1 align="center">Project Documentation</h1> | |
| 3 | 3 | |
| 4 | 4 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 5 | 5 | that can be used to store the |
| 6 | 6 | documentation for a project. This is sufficient for many projects. |
| 7 | 7 | If your project is well-served by wiki documentation, then you |
| @@ -63,26 +63,40 @@ | ||
| 63 | 63 | Finally, the <i><filename></i> element of the URL is the |
| 64 | 64 | pathname of the documentation file relative to the root of the source |
| 65 | 65 | tree. |
| 66 | 66 | |
| 67 | 67 | The mimetype (and thus the rendering) of documentation files is |
| 68 | -determined by the file suffix. Fossil currently understands 197 | |
| 69 | -different file suffixes, including all the popular ones such as | |
| 70 | -".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". | |
| 68 | +determined by the file suffix. Fossil currently understands | |
| 69 | +[/mimetype_list|many different file suffixes], | |
| 70 | +including all the popular ones such as ".css", ".gif", ".htm", | |
| 71 | +".html", ".jpg", ".jpeg", ".png", and ".txt". | |
| 71 | 72 | |
| 72 | 73 | Documentation files whose names end in ".wiki" use the |
| 73 | 74 | [/wiki_rules | same markup as wiki pages] - |
| 74 | 75 | a safe subset of HTML together with some wiki rules for paragraph |
| 75 | 76 | breaks, lists, and hyperlinks. |
| 76 | 77 | Documentation files ending in ".md" or ".markdown" use the |
| 77 | -Markdown markup langauge. | |
| 78 | +[/md_rules | Markdown markup langauge]. | |
| 78 | 79 | Documentation files ending in ".txt" are plain text. |
| 79 | 80 | Wiki, markdown, and plain text documentation files |
| 80 | 81 | are rendered with the standard fossil header and footer added. |
| 81 | -All other mimetypes (including ".html" files) | |
| 82 | -are delivered directly to the requesting | |
| 82 | +Most other mimetypes are delivered directly to the requesting | |
| 83 | 83 | web browser without interpretation, additions, or changes. |
| 84 | + | |
| 85 | +Files with the mimetype "text/html" (the .html or .htm suffix) are | |
| 86 | +usually rendered directly to the browser without interpretation. | |
| 87 | +However, if the file begins with a <div> element like this: | |
| 88 | + | |
| 89 | + <b><div class='fossil-doc' data-title='<i>Title Text</i>'></b> | |
| 90 | + | |
| 91 | +Then the standard Fossil header and footer are added to the document | |
| 92 | +prior to being displayed. The "class='fossil-doc'" attribute is | |
| 93 | +required for this to occur. The "data-title='...'" attribute is | |
| 94 | +optional, but if it is present the text will become the title displayed | |
| 95 | +in the Fossil header. An example of this can be seen in the text | |
| 96 | +of the [/artifact/84b4b3d041d93a?txt=1 | Index Of Fossil Documentation] | |
| 97 | +document. | |
| 84 | 98 | |
| 85 | 99 | <h2>Examples</h2> |
| 86 | 100 | |
| 87 | 101 | This file that you are currently reading is an example of |
| 88 | 102 | embedded documentation. The name of this file in the fossil |
| 89 | 103 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -1,7 +1,7 @@ | |
| 1 | <title>Managing Project Documentation</title> |
| 2 | <h1 align="center">Managing Project Documentation</h1> |
| 3 | |
| 4 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 5 | that can be used to store the |
| 6 | documentation for a project. This is sufficient for many projects. |
| 7 | If your project is well-served by wiki documentation, then you |
| @@ -63,26 +63,40 @@ | |
| 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 | |
| 67 | The mimetype (and thus the rendering) of documentation files is |
| 68 | determined by the file suffix. Fossil currently understands 197 |
| 69 | different file suffixes, including all the popular ones such as |
| 70 | ".css", ".gif", ".htm", ".html", ".jpg", ".jpeg", ".png", and ".txt". |
| 71 | |
| 72 | Documentation files whose names end in ".wiki" use the |
| 73 | [/wiki_rules | same markup as wiki pages] - |
| 74 | a safe subset of HTML together with some wiki rules for paragraph |
| 75 | breaks, lists, and hyperlinks. |
| 76 | Documentation files ending in ".md" or ".markdown" use the |
| 77 | Markdown markup langauge. |
| 78 | Documentation files ending in ".txt" are plain text. |
| 79 | Wiki, markdown, and plain text documentation files |
| 80 | are rendered with the standard fossil header and footer added. |
| 81 | All other mimetypes (including ".html" files) |
| 82 | are delivered directly to the requesting |
| 83 | web browser without interpretation, additions, or changes. |
| 84 | |
| 85 | <h2>Examples</h2> |
| 86 | |
| 87 | This file that you are currently reading is an example of |
| 88 | embedded documentation. The name of this file in the fossil |
| 89 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -1,7 +1,7 @@ | |
| 1 | <title>Project Documentation</title> |
| 2 | <h1 align="center">Project Documentation</h1> |
| 3 | |
| 4 | Fossil provides a built-in <a href="wikitheory.wiki">wiki</a> |
| 5 | that can be used to store the |
| 6 | documentation for a project. This is sufficient for many projects. |
| 7 | If your project is well-served by wiki documentation, then you |
| @@ -63,26 +63,40 @@ | |
| 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 | |
| 67 | The mimetype (and thus the rendering) of documentation files is |
| 68 | determined by the file suffix. Fossil currently understands |
| 69 | [/mimetype_list|many different file suffixes], |
| 70 | including all the popular ones such as ".css", ".gif", ".htm", |
| 71 | ".html", ".jpg", ".jpeg", ".png", and ".txt". |
| 72 | |
| 73 | Documentation files whose names end in ".wiki" use the |
| 74 | [/wiki_rules | same markup as wiki pages] - |
| 75 | a safe subset of HTML together with some wiki rules for paragraph |
| 76 | breaks, lists, and hyperlinks. |
| 77 | Documentation files ending in ".md" or ".markdown" use the |
| 78 | [/md_rules | Markdown markup langauge]. |
| 79 | Documentation files ending in ".txt" are plain text. |
| 80 | Wiki, markdown, and plain text documentation files |
| 81 | are rendered with the standard fossil header and footer added. |
| 82 | Most other mimetypes are delivered directly to the requesting |
| 83 | web browser without interpretation, additions, or changes. |
| 84 | |
| 85 | Files with the mimetype "text/html" (the .html or .htm suffix) are |
| 86 | usually rendered directly to the browser without interpretation. |
| 87 | However, if the file begins with a <div> element like this: |
| 88 | |
| 89 | <b><div class='fossil-doc' data-title='<i>Title Text</i>'></b> |
| 90 | |
| 91 | Then the standard Fossil header and footer are added to the document |
| 92 | prior to being displayed. The "class='fossil-doc'" attribute is |
| 93 | required for this to occur. The "data-title='...'" attribute is |
| 94 | optional, but if it is present the text will become the title displayed |
| 95 | in the Fossil header. An example of this can be seen in the text |
| 96 | of the [/artifact/84b4b3d041d93a?txt=1 | Index Of Fossil Documentation] |
| 97 | document. |
| 98 | |
| 99 | <h2>Examples</h2> |
| 100 | |
| 101 | This file that you are currently reading is an example of |
| 102 | embedded documentation. The name of this file in the fossil |
| 103 |
+30
-30
| --- www/event.wiki | ||
| +++ www/event.wiki | ||
| @@ -1,19 +1,21 @@ | ||
| 1 | -<title>Events</title> | |
| 1 | +<title>Technical Notes</title> | |
| 2 | 2 | |
| 3 | -<h2>What Is An "Event"?</h2> | |
| 3 | +<h2>What Is An "Technote"?</h2> | |
| 4 | 4 | |
| 5 | -In Fossil, and "event" is a special kind of [./wikitheory.wiki | wiki page] | |
| 5 | +In Fossil, a "technical note" or "technote" (formerly called an "event") | |
| 6 | +is a special kind of [./wikitheory.wiki | wiki page] | |
| 6 | 7 | that is associated with a point in time rather than having a page name. |
| 7 | -Each event causes a single entry to appear on the [/timeline | Timeline Page]. | |
| 8 | -Clicking on the hyperlink of the timeline entry cause a jump to the wiki | |
| 9 | -content for the event. The wiki content, the timeline entry text, the | |
| 8 | +Each technote causes a single entry to appear on the | |
| 9 | +[/timeline?y=e | Timeline Page]. | |
| 10 | +Clicking on the timeline link will display the text of the technote. | |
| 11 | +The wiki content, the timeline entry text, the | |
| 10 | 12 | time of the event, and the timeline background color can all be edited. |
| 11 | 13 | |
| 12 | -As with check-ins, wiki, and tickets, all events automatically synchronize | |
| 13 | -to other repositories. Hence, events can be viewed, created, and edited | |
| 14 | -off-line. And the complete edit history for events is maintained | |
| 14 | +As with check-ins, wiki, and tickets, all technotes automatically synchronize | |
| 15 | +to other repositories. Hence, technotes can be viewed, created, and edited | |
| 16 | +off-line. And the complete edit history for technotes is maintained | |
| 15 | 17 | for auditing purposes. |
| 16 | 18 | |
| 17 | 19 | Possible uses for events include: |
| 18 | 20 | |
| 19 | 21 | * <b>Milestones</b>. Project milestones, such as releases or beta-test |
| @@ -41,35 +43,33 @@ | ||
| 41 | 43 | |
| 42 | 44 | * <b>Announcements</b>. Changes to the composition of the development |
| 43 | 45 | team or acquisition of new project sponsors can be communicated as |
| 44 | 46 | announcements which can be implemented as events. |
| 45 | 47 | |
| 46 | -No project is required to use events. But events can help many projects | |
| 48 | +No project is required to use technotes. But technotes can help many projects | |
| 47 | 49 | stay better organized and provide a better historical record of the |
| 48 | 50 | development progress. |
| 49 | 51 | |
| 50 | -<h2>Viewing Events</h2> | |
| 52 | +<h2>Viewing Technotes</h2> | |
| 51 | 53 | |
| 52 | -Because events are considered a special kind of wiki, | |
| 54 | +Because technotes are considered a special kind of wiki, | |
| 53 | 55 | users must have permission to read wiki in order read events. |
| 54 | 56 | Enable the "j" permission under the /Setup/Users menu in order |
| 55 | 57 | to give specific users or user classes the ability to view wiki |
| 56 | -and events. | |
| 57 | - | |
| 58 | -Events show up on the timeline. Click on the hyperlink beside the | |
| 59 | -event title to see the details of the event. | |
| 60 | - | |
| 61 | -<h2>Creating And Editing Events</h2> | |
| 62 | - | |
| 63 | -There is a hyperlink under the /Wiki menu that can be used to create | |
| 64 | -new events. And there is a submenu hyperlink on event displays for | |
| 65 | -editing existing events. | |
| 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. | |
| 66 | 68 | |
| 67 | 69 | Users must have check-in privileges (permission "i") in order to |
| 68 | -create or edit events. In addition, users must have create-wiki | |
| 69 | -privilege (permission "f") to create new events and edit-wiki | |
| 70 | -privilege (permission "k") in order to edit existing events. | |
| 71 | - | |
| 72 | -If the first non-whitespace text of the event wiki content is | |
| 73 | -<title>...</title> then that markup is omitted from | |
| 74 | -the body of the wiki pages and is instead displayed as the page | |
| 75 | -title. | |
| 70 | +create or edit technotes. In addition, users must have create-wiki | |
| 71 | +privilege (permission "f") to create new technotes and edit-wiki | |
| 72 | +privilege (permission "k") in order to edit existing technotes. | |
| 73 | + | |
| 74 | +Technote content may be formatted as [/wiki_rules | Fossil wiki], | |
| 75 | +[/md_rules | Markdown], or a plain text. | |
| 76 | 76 |
| --- www/event.wiki | |
| +++ www/event.wiki | |
| @@ -1,19 +1,21 @@ | |
| 1 | <title>Events</title> |
| 2 | |
| 3 | <h2>What Is An "Event"?</h2> |
| 4 | |
| 5 | In Fossil, and "event" is a special kind of [./wikitheory.wiki | wiki page] |
| 6 | that is associated with a point in time rather than having a page name. |
| 7 | Each event causes a single entry to appear on the [/timeline | Timeline Page]. |
| 8 | Clicking on the hyperlink of the timeline entry cause a jump to the wiki |
| 9 | content for the event. The wiki content, the timeline entry text, the |
| 10 | time of the event, and the timeline background color can all be edited. |
| 11 | |
| 12 | As with check-ins, wiki, and tickets, all events automatically synchronize |
| 13 | to other repositories. Hence, events can be viewed, created, and edited |
| 14 | off-line. And the complete edit history for events is maintained |
| 15 | for auditing purposes. |
| 16 | |
| 17 | Possible uses for events include: |
| 18 | |
| 19 | * <b>Milestones</b>. Project milestones, such as releases or beta-test |
| @@ -41,35 +43,33 @@ | |
| 41 | |
| 42 | * <b>Announcements</b>. Changes to the composition of the development |
| 43 | team or acquisition of new project sponsors can be communicated as |
| 44 | announcements which can be implemented as events. |
| 45 | |
| 46 | No project is required to use events. But events can help many projects |
| 47 | stay better organized and provide a better historical record of the |
| 48 | development progress. |
| 49 | |
| 50 | <h2>Viewing Events</h2> |
| 51 | |
| 52 | Because events are considered a special kind of wiki, |
| 53 | users must have permission to read wiki in order read events. |
| 54 | Enable the "j" permission under the /Setup/Users menu in order |
| 55 | to give specific users or user classes the ability to view wiki |
| 56 | and events. |
| 57 | |
| 58 | Events show up on the timeline. Click on the hyperlink beside the |
| 59 | event title to see the details of the event. |
| 60 | |
| 61 | <h2>Creating And Editing Events</h2> |
| 62 | |
| 63 | There is a hyperlink under the /Wiki menu that can be used to create |
| 64 | new events. And there is a submenu hyperlink on event displays for |
| 65 | editing existing events. |
| 66 | |
| 67 | Users must have check-in privileges (permission "i") in order to |
| 68 | create or edit events. In addition, users must have create-wiki |
| 69 | privilege (permission "f") to create new events and edit-wiki |
| 70 | privilege (permission "k") in order to edit existing events. |
| 71 | |
| 72 | If the first non-whitespace text of the event wiki content is |
| 73 | <title>...</title> then that markup is omitted from |
| 74 | the body of the wiki pages and is instead displayed as the page |
| 75 | title. |
| 76 |
| --- www/event.wiki | |
| +++ www/event.wiki | |
| @@ -1,19 +1,21 @@ | |
| 1 | <title>Technical Notes</title> |
| 2 | |
| 3 | <h2>What Is An "Technote"?</h2> |
| 4 | |
| 5 | In Fossil, a "technical note" or "technote" (formerly called an "event") |
| 6 | is a special kind of [./wikitheory.wiki | wiki page] |
| 7 | that is associated with a point in time rather than having a page name. |
| 8 | Each technote causes a single entry to appear on the |
| 9 | [/timeline?y=e | Timeline Page]. |
| 10 | Clicking on the timeline link will display the text of the technote. |
| 11 | The wiki content, the timeline entry text, the |
| 12 | time of the event, and the timeline background color can all be edited. |
| 13 | |
| 14 | As with check-ins, wiki, and tickets, all technotes automatically synchronize |
| 15 | to other repositories. Hence, technotes can be viewed, created, and edited |
| 16 | off-line. And the complete edit history for technotes is maintained |
| 17 | for auditing purposes. |
| 18 | |
| 19 | Possible uses for events include: |
| 20 | |
| 21 | * <b>Milestones</b>. Project milestones, such as releases or beta-test |
| @@ -41,35 +43,33 @@ | |
| 43 | |
| 44 | * <b>Announcements</b>. Changes to the composition of the development |
| 45 | team or acquisition of new project sponsors can be communicated as |
| 46 | announcements which can be implemented as events. |
| 47 | |
| 48 | No project is required to use technotes. But technotes can help many projects |
| 49 | stay better organized and provide a better historical record of the |
| 50 | development progress. |
| 51 | |
| 52 | <h2>Viewing Technotes</h2> |
| 53 | |
| 54 | Because technotes are considered a special kind of wiki, |
| 55 | users must have permission to read wiki in order read events. |
| 56 | Enable the "j" permission under the /Setup/Users menu in order |
| 57 | to give specific users or user classes the ability to view wiki |
| 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 | |
| 69 | Users must have check-in privileges (permission "i") in order to |
| 70 | create or edit technotes. In addition, users must have create-wiki |
| 71 | privilege (permission "f") to create new technotes and edit-wiki |
| 72 | privilege (permission "k") in order to edit existing technotes. |
| 73 | |
| 74 | Technote content may be formatted as [/wiki_rules | Fossil wiki], |
| 75 | [/md_rules | Markdown], or a plain text. |
| 76 |
+6
-2
| --- www/wikitheory.wiki | ||
| +++ www/wikitheory.wiki | ||
| @@ -5,12 +5,12 @@ | ||
| 5 | 5 | |
| 6 | 6 | * Stand-alone wiki pages. |
| 7 | 7 | * Description and comments in [./bugtheory.wiki | bug reports]. |
| 8 | 8 | * Check-in comments. |
| 9 | 9 | * [./embeddeddoc.wiki | Embedded documentation] files whose |
| 10 | - name ends in "wiki". | |
| 11 | - * [./event.wiki | Event descriptions]. | |
| 10 | + name ends in ".wiki". | |
| 11 | + * [./event.wiki | Technical notes]. | |
| 12 | 12 | |
| 13 | 13 | The [/wiki_rules | formatting rules] for fossil wiki |
| 14 | 14 | are designed to be simple and intuitive. The idea is that wiki provides |
| 15 | 15 | paragraph breaks, numbered and bulleted lists, and hyperlinking for |
| 16 | 16 | simple documents together with a safe subset of HTML for more complex |
| @@ -31,10 +31,14 @@ | ||
| 31 | 31 | 3. Where the fossil wiki markup language is insufficient, HTML is |
| 32 | 32 | used. HTML is a standard language familiar to most programmers so |
| 33 | 33 | there is nothing new to learn. And, though cumbersome, the HTML |
| 34 | 34 | does not need to be used very often so is not a burden. |
| 35 | 35 | |
| 36 | +UPDATE: Since 2012, Fossil also contains a [/md_rules | Markdown] | |
| 37 | +rendering engine. Markdown can optionally be used to format | |
| 38 | +[./embeddeddoc.wiki | embedded documents], wiki pages, | |
| 39 | +[./event.wiki | technical notes], and bug report text. | |
| 36 | 40 | |
| 37 | 41 | <h2>Stand-alone Wiki Pages</h2> |
| 38 | 42 | |
| 39 | 43 | Each wiki page has its own revision history which is independent of |
| 40 | 44 | the sequence of check-ins (check-ins). Wiki pages can branch and merge |
| 41 | 45 |
| --- www/wikitheory.wiki | |
| +++ www/wikitheory.wiki | |
| @@ -5,12 +5,12 @@ | |
| 5 | |
| 6 | * Stand-alone wiki pages. |
| 7 | * Description and comments in [./bugtheory.wiki | bug reports]. |
| 8 | * Check-in comments. |
| 9 | * [./embeddeddoc.wiki | Embedded documentation] files whose |
| 10 | name ends in "wiki". |
| 11 | * [./event.wiki | Event descriptions]. |
| 12 | |
| 13 | The [/wiki_rules | formatting rules] for fossil wiki |
| 14 | are designed to be simple and intuitive. The idea is that wiki provides |
| 15 | paragraph breaks, numbered and bulleted lists, and hyperlinking for |
| 16 | simple documents together with a safe subset of HTML for more complex |
| @@ -31,10 +31,14 @@ | |
| 31 | 3. Where the fossil wiki markup language is insufficient, HTML is |
| 32 | used. HTML is a standard language familiar to most programmers so |
| 33 | there is nothing new to learn. And, though cumbersome, the HTML |
| 34 | does not need to be used very often so is not a burden. |
| 35 | |
| 36 | |
| 37 | <h2>Stand-alone Wiki Pages</h2> |
| 38 | |
| 39 | Each wiki page has its own revision history which is independent of |
| 40 | the sequence of check-ins (check-ins). Wiki pages can branch and merge |
| 41 |
| --- www/wikitheory.wiki | |
| +++ www/wikitheory.wiki | |
| @@ -5,12 +5,12 @@ | |
| 5 | |
| 6 | * Stand-alone wiki pages. |
| 7 | * Description and comments in [./bugtheory.wiki | bug reports]. |
| 8 | * Check-in comments. |
| 9 | * [./embeddeddoc.wiki | Embedded documentation] files whose |
| 10 | name ends in ".wiki". |
| 11 | * [./event.wiki | Technical notes]. |
| 12 | |
| 13 | The [/wiki_rules | formatting rules] for fossil wiki |
| 14 | are designed to be simple and intuitive. The idea is that wiki provides |
| 15 | paragraph breaks, numbered and bulleted lists, and hyperlinking for |
| 16 | simple documents together with a safe subset of HTML for more complex |
| @@ -31,10 +31,14 @@ | |
| 31 | 3. Where the fossil wiki markup language is insufficient, HTML is |
| 32 | used. HTML is a standard language familiar to most programmers so |
| 33 | there is nothing new to learn. And, though cumbersome, the HTML |
| 34 | does not need to be used very often so is not a burden. |
| 35 | |
| 36 | UPDATE: Since 2012, Fossil also contains a [/md_rules | Markdown] |
| 37 | rendering engine. Markdown can optionally be used to format |
| 38 | [./embeddeddoc.wiki | embedded documents], wiki pages, |
| 39 | [./event.wiki | technical notes], and bug report text. |
| 40 | |
| 41 | <h2>Stand-alone Wiki Pages</h2> |
| 42 | |
| 43 | Each wiki page has its own revision history which is independent of |
| 44 | the sequence of check-ins (check-ins). Wiki pages can branch and merge |
| 45 |