Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Documentation tweaks. No changes to code. |
|---|---|
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
6ba52ae7619f9ea57fb295db7fb626c0 |
| User & Date: | drh 2009-02-21 13:09:40.000 |
Context
|
2009-02-21
| ||
| 18:52 | typo fix check-in: 5b29f6f65f user: bharder tags: trunk | |
| 13:09 | Documentation tweaks. No changes to code. check-in: 6ba52ae761 user: drh tags: trunk | |
|
2009-02-13
| ||
| 20:30 | Doc update for branch and co. check-in: bc857ecd92 user: kejoki tags: trunk | |
Changes
Changes to www/bugtheory.wiki.
| ︙ | ︙ | |||
36 37 38 39 40 41 42 43 44 45 46 47 48 49 | between repositories in the same way as every other artifact. In fact, the sync algorithm has no knowledge of the meaning of the artifacts it is syncing. As far as the sync algorithm is concerned, all artifacts are alike. After the sync has occurs, the individual repositories must make sense of the meaning of the various artifacts for themselves. <h2>Interpretation Of Ticket Change Artifacts</h2> Every ticket change artifact contains (among other things) * a timestamp, * a ticket ID, and * one or more name/value pairs. | > > > | 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | between repositories in the same way as every other artifact. In fact, the sync algorithm has no knowledge of the meaning of the artifacts it is syncing. As far as the sync algorithm is concerned, all artifacts are alike. After the sync has occurs, the individual repositories must make sense of the meaning of the various artifacts for themselves. <h2>Interpretation Of Ticket Change Artifacts</h2> <i>Note: The following is implementation detail which can be safely ignored by casual users of fossil.</i> Every ticket change artifact contains (among other things) * a timestamp, * a ticket ID, and * one or more name/value pairs. |
| ︙ | ︙ |
Changes to www/embeddeddoc.wiki.
| ︙ | ︙ | |||
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | <b>http://www.hwaci.com/cgi-bin/fossil</b>. If you launch the web server using the "<b>fossil server</b>" command line, then the <i><baseurl></i> is usually <b>http://localhost:8080/</b>. The <i><version></i> is any unique prefix of the check-in ID for the check-in containing the documentation you want to access. Or <i><version></i> can be one of the keywords "<b>tip</b>" or "<b>ckout</b>". The "<b>tip</b>" keyword means to use the most recently checked-in. This is useful if you want to see the very latest version of the documentation. The "<b>ckout</b>" keywords means to pull the documentation file from the local source tree on disk, not from the any check-in. The "<b>ckout</b>" keyword normally only works when you start your server using the "<b>fossil server</b>" or "<b>fossil ui</b>" | > > > | | 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | <b>http://www.hwaci.com/cgi-bin/fossil</b>. If you launch the web server using the "<b>fossil server</b>" command line, then the <i><baseurl></i> is usually <b>http://localhost:8080/</b>. The <i><version></i> is any unique prefix of the check-in ID for the check-in containing the documentation you want to access. Or <i><version></i> can be the name of a [./branching.wiki | branch] in order to show the documentation for the latest version of that branch. Or <i><version></i> can be one of the keywords "<b>tip</b>" or "<b>ckout</b>". The "<b>tip</b>" keyword means to use the most recently checked-in. This is useful if you want to see the very latest version of the documentation. The "<b>ckout</b>" keywords means to pull the documentation file from the local source tree on disk, not from the any check-in. The "<b>ckout</b>" keyword normally only works when you start your server using the "<b>fossil server</b>" or "<b>fossil ui</b>" command line and is intended to show what the documentation you are currently editing looks like before you check it in. Finally, the <i><filename></i> element of the URL is the full pathname of the documentation file starting from the root of the source tree. The mimetype (and thus the rendering) of documentation files is |
| ︙ | ︙ |
Changes to www/qandc.wiki.
| ︙ | ︙ | |||
22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
<li> Integrated <a href="wikitheory.wiki">wiki</a>. </li>
<li> Integrated <a href="bugtheory.wiki">bug tracking</a> </li>
<li> Immutable artifacts </li>
<li> Self-contained, stand-alone executable that can be run in
a <a href="http://en.wikipedia.org/wiki/Chroot">chroot jail</a> </li>
<li> Simple, well-defined,
<a href="fileformat.wiki">enduring file format</a> </li>
</ol>
</blockquote>
<b>Why should I use this rather than Trac?</b>
<blockquote>
<ol>
| > | 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
<li> Integrated <a href="wikitheory.wiki">wiki</a>. </li>
<li> Integrated <a href="bugtheory.wiki">bug tracking</a> </li>
<li> Immutable artifacts </li>
<li> Self-contained, stand-alone executable that can be run in
a <a href="http://en.wikipedia.org/wiki/Chroot">chroot jail</a> </li>
<li> Simple, well-defined,
<a href="fileformat.wiki">enduring file format</a> </li>
<li> Integrated <a href="webui.wiki">web interface</a> </li>
</ol>
</blockquote>
<b>Why should I use this rather than Trac?</b>
<blockquote>
<ol>
|
| ︙ | ︙ |
Changes to www/webui.wiki.
| ︙ | ︙ | |||
43 44 45 46 47 48 49 | available TCP port to use on its own) and then automatically launches your web browser to point at that server. If you run the "ui" command from within an open check-out, you can omit the repository name: <b>fossil ui</b> The latter case is a very useful short-cut when you are working on a | | | 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | available TCP port to use on its own) and then automatically launches your web browser to point at that server. If you run the "ui" command from within an open check-out, you can omit the repository name: <b>fossil ui</b> The latter case is a very useful short-cut when you are working on a fossil project and you what to quickly do some work with the web interface. Notice that fossil automatically finds an unused TCP port to run the server own and automatically points your web browser to the correct URL. So there is never any fumbling around trying to find an open port or to type arcane strings into your browser URL entry box. The interface just pops right up, ready to run. The fossil web interface is also very easy to setup and run on a |
| ︙ | ︙ |
Changes to www/wikitheory.wiki.
| ︙ | ︙ | |||
25 26 27 28 29 30 31 |
2. The wiki markup used by fossil, though limited, is common to most
other wiki engines, is intuitive, and is sufficient for 90% of
all formatting tasks.
3. Where the fossil wiki markup language is insufficient, HTML is
used. HTML is a standard language familiar to most programmers so
there is nothing new to learn. And, though cumbersome, the HTML
| | | | 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
2. The wiki markup used by fossil, though limited, is common to most
other wiki engines, is intuitive, and is sufficient for 90% of
all formatting tasks.
3. Where the fossil wiki markup language is insufficient, HTML is
used. HTML is a standard language familiar to most programmers so
there is nothing new to learn. And, though cumbersome, the HTML
does not need to be used very often so is not a burden.
<h2>Stand-alone Wiki Pages</h2>
Each wiki page has its own revision history which is independent of
the sequence of check-ins (check-ins). Wiki pages can branch and merge
just like check-ins, though as of this writing (2008-07-29) there is
no mechanism in the user interface to support branching and merging.
The current implementation of the wiki shows the version of the wiki
page that has the most recent timestamp.
In other words, if two users make unrelated changes to the same wiki
page on separate repositories and those repositories are synced,
the wiki page will fork. The web interface will display whichever edit
was checked in last. The other edit can be found in the history. The
file format will support merging the branches back together, but there
is no mechanism in the user interface (yet) to perform the merge.
Every change to a wiki page is a separate
[./fileformat.wiki | control artifact]
|
| ︙ | ︙ | |||
61 62 63 64 65 66 67 | Some project prefer to store their documentation in wiki. There is nothing wrong with that. But other projects prefer to keep documentation as part of the source tree, so that it is versioned along with the source tree and so that only developers with check-in privileges can change it. Embedded documentation serves this latter purpose. Both forms of documentation use the exact same wiki markup language. Some projects may choose to | | > > | 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | Some project prefer to store their documentation in wiki. There is nothing wrong with that. But other projects prefer to keep documentation as part of the source tree, so that it is versioned along with the source tree and so that only developers with check-in privileges can change it. Embedded documentation serves this latter purpose. Both forms of documentation use the exact same wiki markup language. Some projects may choose to use both forms of documentation at the same time. Because the same format is used, it is trival to move file from wiki to embedded documentation or back again as the project evolves. <h2>Bug-reports and check-in comments</h2> The comments on check-ins and the text in the descriptions of bug reports both use wiki formatting. Exactly the same set of formatting rules apply. There is never a need to learn one formatting language for documentation and a different markup for bugs or for check-in comments. |