Artifact 0522d4b67268ba68ed3195adaf9262734d364129:
File www/embeddeddoc.wiki part of check-in [5523218023a] - Add <title> markup to several of the embedded documentation pages. by drh on 2009-08-24 17:54:24.
0000: 3c 74 69 74 6c 65 3e 4d 61 6e 61 67 69 6e 67 20 <title>Managing 0010: 50 72 6f 6a 65 63 74 20 44 6f 63 75 6d 65 6e 74 Project Document 0020: 61 74 69 6f 6e 3c 2f 74 69 74 6c 65 3e 0a 3c 68 ation</title>.<h 0030: 31 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 72 22 1 align="center" 0040: 3e 4d 61 6e 61 67 69 6e 67 20 50 72 6f 6a 65 63 >Managing Projec 0050: 74 20 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 3c t Documentation< 0060: 2f 68 31 3e 0a 0a 46 6f 73 73 69 6c 20 70 72 6f /h1>..Fossil pro 0070: 76 69 64 65 73 20 61 20 62 75 69 6c 74 2d 69 6e vides a built-in 0080: 20 3c 61 20 68 72 65 66 3d 22 77 69 6b 69 74 68 <a href="wikith 0090: 65 6f 72 79 2e 77 69 6b 69 22 3e 77 69 6b 69 3c eory.wiki">wiki< 00a0: 2f 61 3e 0a 74 68 61 74 20 63 61 6e 20 62 65 20 /a>.that can be 00b0: 75 73 65 64 20 74 6f 20 73 74 6f 72 65 20 74 68 used to store th 00c0: 65 0a 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 e.documentation 00d0: 66 6f 72 20 61 20 70 72 6f 6a 65 63 74 2e 20 20 for a project. 00e0: 54 68 69 73 20 69 73 20 73 75 66 66 69 63 69 65 This is sufficie 00f0: 6e 74 20 66 6f 72 20 6d 61 6e 79 20 70 72 6f 6a nt for many proj 0100: 65 63 74 73 2e 0a 49 66 20 79 6f 75 72 20 70 72 ects..If your pr 0110: 6f 6a 65 63 74 20 69 73 20 77 65 6c 6c 2d 73 65 oject is well-se 0120: 72 76 65 64 20 62 79 20 77 69 6b 69 20 64 6f 63 rved by wiki doc 0130: 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 74 68 65 6e umentation, then 0140: 20 79 6f 75 0a 6e 65 65 64 20 72 65 61 64 20 6e you.need read n 0150: 6f 20 66 75 72 74 68 65 72 2e 0a 0a 42 75 74 20 o further...But 0160: 66 6f 73 73 69 6c 20 61 6c 73 6f 20 73 75 70 70 fossil also supp 0170: 6f 72 74 73 20 65 6d 62 65 64 64 69 6e 67 20 70 orts embedding p 0180: 72 6f 6a 65 63 74 20 64 6f 63 75 6d 65 6e 74 61 roject documenta 0190: 74 69 6f 6e 20 61 73 0a 66 69 6c 65 73 20 69 6e tion as.files in 01a0: 20 74 68 65 20 73 6f 75 72 63 65 20 74 72 65 65 the source tree 01b0: 2e 20 20 54 68 65 72 65 20 61 72 65 20 73 65 76 . There are sev 01c0: 65 72 61 6c 20 70 6f 74 65 6e 74 69 61 6c 20 61 eral potential a 01d0: 64 76 61 6e 74 61 67 65 73 0a 74 6f 20 74 68 69 dvantages.to thi 01e0: 73 20 61 70 70 72 6f 61 63 68 3a 0a 0a 20 20 31 s approach:.. 1 01f0: 2e 20 20 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 . The documenta 0200: 74 69 6f 6e 20 66 69 6c 65 73 20 61 72 65 20 76 tion files are v 0210: 65 72 73 69 6f 6e 65 64 20 74 6f 67 65 74 68 65 ersioned togethe 0220: 72 20 77 69 74 68 20 74 68 65 0a 20 20 20 20 20 r with the. 0230: 20 73 6f 75 72 63 65 20 63 6f 64 65 20 66 69 6c source code fil 0240: 65 73 20 73 6f 20 69 74 20 69 73 20 61 6c 77 61 es so it is alwa 0250: 79 73 20 63 6c 65 61 72 20 77 68 61 74 20 76 65 ys clear what ve 0260: 72 73 69 6f 6e 20 6f 66 0a 20 20 20 20 20 20 74 rsion of. t 0270: 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e he documentation 0280: 20 67 6f 65 73 20 77 69 74 68 20 61 20 70 61 72 goes with a par 0290: 74 69 63 75 6c 61 72 20 72 65 6c 65 61 73 65 2e ticular release. 02a0: 0a 0a 20 20 32 2e 20 20 54 68 65 20 64 6f 63 75 .. 2. The docu 02b0: 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 mentation files 02c0: 63 61 6e 20 62 65 20 65 64 69 74 65 64 20 75 73 can be edited us 02d0: 69 6e 67 20 79 6f 75 72 20 66 61 76 6f 72 69 74 ing your favorit 02e0: 65 0a 20 20 20 20 20 20 74 65 78 74 20 65 64 69 e. text edi 02f0: 74 6f 72 20 69 6e 73 74 65 61 64 20 6f 66 20 68 tor instead of h 0300: 61 76 69 6e 67 20 74 6f 20 75 73 65 20 74 68 65 aving to use the 0310: 20 77 65 62 2d 62 61 73 65 64 20 77 69 6b 69 0a web-based wiki. 0320: 20 20 20 20 20 20 65 64 69 74 6f 72 2e 0a 0a 20 editor... 0330: 20 33 2e 20 20 4f 6e 6c 79 20 70 65 6f 70 6c 65 3. Only people 0340: 20 77 69 74 68 20 63 68 65 63 6b 2d 69 6e 20 70 with check-in p 0350: 72 69 76 69 6c 65 67 65 73 20 63 61 6e 20 6d 6f rivileges can mo 0360: 64 69 66 79 20 74 68 65 20 64 6f 63 75 6d 65 6e dify the documen 0370: 74 61 74 69 6f 6e 2e 0a 20 20 20 20 20 20 28 54 tation.. (T 0380: 68 69 73 20 6d 69 67 68 74 20 62 65 20 65 69 74 his might be eit 0390: 68 65 72 20 61 6e 20 61 64 76 61 6e 74 61 67 65 her an advantage 03a0: 20 6f 72 20 64 69 73 61 64 76 61 6e 74 61 67 65 or disadvantage 03b0: 2c 20 64 65 70 65 6e 64 69 6e 67 0a 20 20 20 20 , depending. 03c0: 20 20 6f 6e 20 74 68 65 20 6e 61 74 75 72 65 20 on the nature 03d0: 6f 66 20 79 6f 75 72 20 70 72 6f 6a 65 63 74 2e of your project. 03e0: 29 0a 0a 57 65 20 77 69 6c 6c 20 63 61 6c 6c 20 )..We will call 03f0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 74 68 documentation th 0400: 61 74 20 69 73 20 69 6e 63 6c 75 64 65 64 20 61 at is included a 0410: 73 20 66 69 6c 65 73 20 69 6e 20 74 68 65 20 73 s files in the s 0420: 6f 75 72 63 65 20 74 72 65 65 0a 22 65 6d 62 65 ource tree."embe 0430: 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 dded documentati 0440: 6f 6e 22 2e 0a 0a 3c 68 32 3e 46 6f 73 73 69 6c on"...<h2>Fossil 0450: 20 53 75 70 70 6f 72 74 20 46 6f 72 20 45 6d 62 Support For Emb 0460: 65 64 64 65 64 20 44 6f 63 75 6d 65 6e 74 61 74 edded Documentat 0470: 69 6f 6e 3c 2f 68 32 3e 0a 0a 54 68 65 20 66 6f ion</h2>..The fo 0480: 73 73 69 6c 20 77 65 62 20 69 6e 74 65 72 66 61 ssil web interfa 0490: 63 65 20 73 75 70 70 6f 72 74 73 20 65 6d 62 65 ce supports embe 04a0: 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 dded documentati 04b0: 6f 6e 20 75 73 69 6e 67 0a 74 68 65 20 22 2f 64 on using.the "/d 04c0: 6f 63 22 20 70 61 67 65 2e 20 20 54 6f 20 61 63 oc" page. To ac 04d0: 63 65 73 73 20 65 6d 62 65 64 64 65 64 20 64 6f cess embedded do 04e0: 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 6f 6e 65 cumentation, one 04f0: 20 70 6f 69 6e 74 73 0a 61 20 77 65 62 20 62 72 points.a web br 0500: 6f 77 73 65 72 20 74 6f 20 61 20 66 6f 73 73 69 owser to a fossi 0510: 6c 20 55 52 4c 20 6f 66 20 74 68 65 20 66 6f 6c l URL of the fol 0520: 6c 6f 77 69 6e 67 20 66 6f 72 6d 3a 0a 0a 3c 62 lowing form:..<b 0530: 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 26 6c lockquote>.<i>&l 0540: 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 t;baseurl></i 0550: 3e 3c 62 69 67 3e 3c 62 3e 2f 64 6f 63 2f 3c 2f ><big><b>/doc/</ 0560: 62 3e 3c 2f 62 69 67 3e 3c 69 3e 26 6c 74 3b 76 b></big><i><v 0570: 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e 3c 62 ersion></i><b 0580: 69 67 3e 3c 62 3e 2f 3c 2f 62 3e 3c 2f 62 69 67 ig><b>/</b></big 0590: 3e 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e 61 6d 65 ><i><filename 05a0: 26 67 74 3b 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b ></i>.</block 05b0: 71 75 6f 74 65 3e 0a 0a 54 68 65 20 3c 69 3e 26 quote>..The <i>& 05c0: 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f lt;baseurl></ 05d0: 69 3e 20 69 73 20 74 68 65 20 6d 61 69 6e 20 55 i> is the main U 05e0: 52 4c 20 75 73 65 64 20 74 6f 20 61 63 63 65 73 RL used to acces 05f0: 73 20 74 68 65 20 66 6f 73 73 69 6c 20 77 65 62 s the fossil web 0600: 20 73 65 72 76 65 72 2e 0a 46 6f 72 20 65 78 61 server..For exa 0610: 6d 70 6c 65 2c 20 74 68 65 20 3c 69 3e 26 6c 74 mple, the <i>< 0620: 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 3e ;baseurl></i> 0630: 20 66 6f 72 20 74 68 65 20 66 6f 73 73 69 6c 20 for the fossil 0640: 70 72 6f 6a 65 63 74 20 69 74 73 65 6c 66 20 69 project itself i 0650: 73 0a 65 69 74 68 65 72 20 3c 62 3e 68 74 74 70 s.either <b>http 0660: 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 ://www.fossil-sc 0670: 6d 2e 6f 72 67 2f 66 6f 73 73 69 6c 3c 2f 62 3e m.org/fossil</b> 0680: 20 6f 72 0a 3c 62 3e 68 74 74 70 3a 2f 2f 77 77 or.<b>http://ww 0690: 77 2e 68 77 61 63 69 2e 63 6f 6d 2f 63 67 69 2d w.hwaci.com/cgi- 06a0: 62 69 6e 2f 66 6f 73 73 69 6c 3c 2f 62 3e 2e 0a bin/fossil</b>.. 06b0: 49 66 20 79 6f 75 20 6c 61 75 6e 63 68 20 74 68 If you launch th 06c0: 65 20 77 65 62 20 73 65 72 76 65 72 20 75 73 69 e web server usi 06d0: 6e 67 20 74 68 65 20 22 3c 62 3e 66 6f 73 73 69 ng the "<b>fossi 06e0: 6c 20 73 65 72 76 65 72 3c 2f 62 3e 22 20 63 6f l server</b>" co 06f0: 6d 6d 61 6e 64 20 6c 69 6e 65 2c 0a 74 68 65 6e mmand line,.then 0700: 20 74 68 65 20 3c 69 3e 26 6c 74 3b 62 61 73 65 the <i><base 0710: 75 72 6c 26 67 74 3b 3c 2f 69 3e 20 69 73 20 75 url></i> is u 0720: 73 75 61 6c 6c 79 0a 3c 62 3e 68 74 74 70 3a 2f sually.<b>http:/ 0730: 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 30 38 30 2f /localhost:8080/ 0740: 3c 2f 62 3e 2e 0a 0a 54 68 65 20 3c 69 3e 26 6c </b>...The <i>&l 0750: 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 t;version></i 0760: 3e 20 69 73 20 61 6e 79 20 75 6e 69 71 75 65 20 > is any unique 0770: 70 72 65 66 69 78 20 6f 66 20 74 68 65 20 63 68 prefix of the ch 0780: 65 63 6b 2d 69 6e 20 49 44 20 66 6f 72 20 0a 74 eck-in ID for .t 0790: 68 65 20 63 68 65 63 6b 2d 69 6e 20 63 6f 6e 74 he check-in cont 07a0: 61 69 6e 69 6e 67 20 74 68 65 20 64 6f 63 75 6d aining the docum 07b0: 65 6e 74 61 74 69 6f 6e 20 79 6f 75 20 77 61 6e entation you wan 07c0: 74 20 74 6f 20 61 63 63 65 73 73 2e 0a 4f 72 20 t to access..Or 07d0: 3c 69 3e 26 6c 74 3b 76 65 72 73 69 6f 6e 26 67 <i><version&g 07e0: 74 3b 3c 2f 69 3e 20 63 61 6e 20 62 65 20 74 68 t;</i> can be th 07f0: 65 20 6e 61 6d 65 20 6f 66 20 61 20 0a 5b 2e 2f e name of a .[./ 0800: 62 72 61 6e 63 68 69 6e 67 2e 77 69 6b 69 20 7c branching.wiki | 0810: 20 62 72 61 6e 63 68 5d 20 69 6e 20 6f 72 64 65 branch] in orde 0820: 72 20 74 6f 20 73 68 6f 77 0a 74 68 65 20 64 6f r to show.the do 0830: 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72 20 cumentation for 0840: 74 68 65 20 6c 61 74 65 73 74 20 76 65 72 73 69 the latest versi 0850: 6f 6e 20 6f 66 20 74 68 61 74 20 62 72 61 6e 63 on of that branc 0860: 68 2e 0a 4f 72 20 3c 69 3e 26 6c 74 3b 76 65 72 h..Or <i><ver 0870: 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e 20 63 61 6e sion></i> can 0880: 20 62 65 20 6f 6e 65 20 6f 66 20 74 68 65 20 6b be one of the k 0890: 65 79 77 6f 72 64 73 20 22 3c 62 3e 74 69 70 3c eywords "<b>tip< 08a0: 2f 62 3e 22 20 6f 72 0a 22 3c 62 3e 63 6b 6f 75 /b>" or."<b>ckou 08b0: 74 3c 2f 62 3e 22 2e 20 20 54 68 65 20 22 3c 62 t</b>". The "<b 08c0: 3e 74 69 70 3c 2f 62 3e 22 20 6b 65 79 77 6f 72 >tip</b>" keywor 08d0: 64 20 6d 65 61 6e 73 20 74 6f 20 75 73 65 20 74 d means to use t 08e0: 68 65 20 6d 6f 73 74 20 72 65 63 65 6e 74 6c 79 he most recently 08f0: 0a 63 68 65 63 6b 65 64 2d 69 6e 2e 20 20 54 68 .checked-in. Th 0900: 69 73 20 69 73 20 75 73 65 66 75 6c 20 69 66 20 is is useful if 0910: 79 6f 75 20 77 61 6e 74 20 74 6f 20 73 65 65 20 you want to see 0920: 74 68 65 20 76 65 72 79 20 6c 61 74 65 73 74 0a the very latest. 0930: 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 64 version of the d 0940: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54 ocumentation. T 0950: 68 65 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e he "<b>ckout</b> 0960: 22 20 6b 65 79 77 6f 72 64 73 20 6d 65 61 6e 73 " keywords means 0970: 20 74 6f 0a 70 75 6c 6c 20 74 68 65 20 64 6f 63 to.pull the doc 0980: 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 20 umentation file 0990: 66 72 6f 6d 20 74 68 65 20 6c 6f 63 61 6c 20 73 from the local s 09a0: 6f 75 72 63 65 20 74 72 65 65 20 6f 6e 20 64 69 ource tree on di 09b0: 73 6b 2c 20 6e 6f 74 0a 66 72 6f 6d 20 74 68 65 sk, not.from the 09c0: 20 61 6e 79 20 63 68 65 63 6b 2d 69 6e 2e 20 20 any check-in. 09d0: 54 68 65 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 The "<b>ckout</b 09e0: 3e 22 20 6b 65 79 77 6f 72 64 20 6e 6f 72 6d 61 >" keyword norma 09f0: 6c 6c 79 0a 6f 6e 6c 79 20 77 6f 72 6b 73 20 77 lly.only works w 0a00: 68 65 6e 20 79 6f 75 20 73 74 61 72 74 20 79 6f hen you start yo 0a10: 75 72 20 73 65 72 76 65 72 20 75 73 69 6e 67 20 ur server using 0a20: 74 68 65 20 22 3c 62 3e 66 6f 73 73 69 6c 20 73 the "<b>fossil s 0a30: 65 72 76 65 72 3c 2f 62 3e 22 0a 6f 72 20 22 3c erver</b>".or "< 0a40: 62 3e 66 6f 73 73 69 6c 20 75 69 3c 2f 62 3e 22 b>fossil ui</b>" 0a50: 0a 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 20 61 6e .command line an 0a60: 64 20 69 73 20 69 6e 74 65 6e 64 65 64 20 74 6f d is intended to 0a70: 20 73 68 6f 77 20 77 68 61 74 20 74 68 65 20 64 show what the d 0a80: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 79 6f 75 ocumentation you 0a90: 20 61 72 65 20 63 75 72 72 65 6e 74 6c 79 0a 65 are currently.e 0aa0: 64 69 74 69 6e 67 20 6c 6f 6f 6b 73 20 6c 69 6b diting looks lik 0ab0: 65 20 62 65 66 6f 72 65 20 79 6f 75 20 63 68 65 e before you che 0ac0: 63 6b 20 69 74 20 69 6e 2e 0a 0a 46 69 6e 61 6c ck it in...Final 0ad0: 6c 79 2c 20 74 68 65 20 3c 69 3e 26 6c 74 3b 66 ly, the <i><f 0ae0: 69 6c 65 6e 61 6d 65 26 67 74 3b 3c 2f 69 3e 20 ilename></i> 0af0: 65 6c 65 6d 65 6e 74 20 6f 66 20 74 68 65 20 55 element of the U 0b00: 52 4c 20 69 73 20 74 68 65 20 66 75 6c 6c 0a 70 RL is the full.p 0b10: 61 74 68 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 athname of the d 0b20: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c ocumentation fil 0b30: 65 20 73 74 61 72 74 69 6e 67 20 66 72 6f 6d 20 e starting from 0b40: 74 68 65 20 72 6f 6f 74 20 6f 66 20 74 68 65 20 the root of the 0b50: 73 6f 75 72 63 65 0a 74 72 65 65 2e 0a 0a 54 68 source.tree...Th 0b60: 65 20 6d 69 6d 65 74 79 70 65 20 28 61 6e 64 20 e mimetype (and 0b70: 74 68 75 73 20 74 68 65 20 72 65 6e 64 65 72 69 thus the renderi 0b80: 6e 67 29 20 6f 66 20 64 6f 63 75 6d 65 6e 74 61 ng) of documenta 0b90: 74 69 6f 6e 20 66 69 6c 65 73 20 69 73 20 0a 64 tion files is .d 0ba0: 65 74 65 72 6d 69 6e 65 64 20 62 79 20 74 68 65 etermined by the 0bb0: 20 66 69 6c 65 20 73 75 66 66 69 78 2e 20 20 46 file suffix. F 0bc0: 6f 73 73 69 6c 20 63 75 72 72 65 6e 74 6c 79 20 ossil currently 0bd0: 75 6e 64 65 72 73 74 61 6e 64 73 20 31 39 32 0a understands 192. 0be0: 64 69 66 66 65 72 65 6e 74 20 66 69 6c 65 20 73 different file s 0bf0: 75 66 66 69 78 65 73 2c 20 69 6e 63 6c 75 64 69 uffixes, includi 0c00: 6e 67 20 61 6c 6c 20 74 68 65 20 70 6f 70 75 6c ng all the popul 0c10: 61 72 20 6f 6e 65 73 20 73 75 63 68 20 61 73 0a ar ones such as. 0c20: 22 2e 63 73 73 22 2c 20 22 2e 67 69 66 22 2c 20 ".css", ".gif", 0c30: 22 2e 68 74 6d 22 2c 20 22 2e 68 74 6d 6c 22 2c ".htm", ".html", 0c40: 20 22 2e 6a 70 67 22 2c 20 22 2e 6a 70 65 67 22 ".jpg", ".jpeg" 0c50: 2c 20 22 2e 70 6e 67 22 2c 20 61 6e 64 20 22 2e , ".png", and ". 0c60: 74 78 74 22 2e 0a 0a 44 6f 63 75 6d 65 6e 74 61 txt"...Documenta 0c70: 74 69 6f 6e 20 66 69 6c 65 73 20 77 68 6f 73 65 tion files whose 0c80: 20 6e 61 6d 65 73 20 65 6e 64 20 69 6e 20 22 2e names end in ". 0c90: 77 69 6b 69 22 20 75 73 65 20 74 68 65 20 0a 5b wiki" use the .[ 0ca0: 2f 77 69 6b 69 5f 72 75 6c 65 73 20 7c 20 73 61 /wiki_rules | sa 0cb0: 6d 65 20 6d 61 72 6b 75 70 20 61 73 20 77 69 6b me markup as wik 0cc0: 69 20 70 61 67 65 73 5d 20 2d 0a 61 20 73 61 66 i pages] -.a saf 0cd0: 65 20 73 75 62 73 65 74 20 6f 66 20 48 54 4d 4c e subset of HTML 0ce0: 20 74 6f 67 65 74 68 65 72 20 77 69 74 68 20 73 together with s 0cf0: 6f 6d 65 20 72 75 6c 65 73 20 66 6f 72 20 70 61 ome rules for pa 0d00: 72 61 67 72 61 70 68 0a 62 72 65 61 6b 73 2c 20 ragraph.breaks, 0d10: 6c 69 73 74 73 2c 20 61 6e 64 20 68 79 70 65 72 lists, and hyper 0d20: 6c 69 6e 6b 73 2e 20 20 54 68 65 20 22 2e 77 69 links. The ".wi 0d30: 6b 69 22 20 61 6e 64 20 22 2e 74 78 74 22 20 70 ki" and ".txt" p 0d40: 61 67 65 73 0a 61 72 65 20 72 65 6e 64 65 72 65 ages.are rendere 0d50: 64 20 77 69 74 68 20 74 68 65 20 73 74 61 6e 64 d with the stand 0d60: 61 72 64 20 66 6f 73 73 69 6c 20 68 65 61 64 65 ard fossil heade 0d70: 72 20 61 6e 64 20 66 6f 6f 74 65 72 20 61 64 64 r and footer add 0d80: 65 64 2e 0a 41 6c 6c 20 6f 74 68 65 72 20 6d 69 ed..All other mi 0d90: 6d 65 74 79 70 65 73 20 61 72 65 20 64 65 6c 69 metypes are deli 0da0: 76 65 72 65 64 20 64 69 72 65 63 74 6c 79 20 74 vered directly t 0db0: 6f 20 74 68 65 20 72 65 71 75 65 73 74 69 6e 67 o the requesting 0dc0: 0a 77 65 62 20 62 72 6f 77 73 65 72 20 77 69 74 .web browser wit 0dd0: 68 6f 75 74 20 69 6e 74 65 72 70 72 65 74 61 74 hout interpretat 0de0: 69 6f 6e 2c 20 61 64 64 69 74 69 6f 6e 73 2c 20 ion, additions, 0df0: 6f 72 20 63 68 61 6e 67 65 73 2e 0a 0a 3c 68 32 or changes...<h2 0e00: 3e 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a >Examples</h2>.. 0e10: 54 68 69 73 20 66 69 6c 65 20 74 68 61 74 20 79 This file that y 0e20: 6f 75 20 61 72 65 20 63 75 72 72 65 6e 74 6c 79 ou are currently 0e30: 20 72 65 61 64 69 6e 67 20 69 73 20 61 6e 20 65 reading is an e 0e40: 78 61 6d 70 6c 65 20 6f 66 0a 65 6d 62 65 64 64 xample of.embedd 0e50: 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e ed documentation 0e60: 2e 20 20 54 68 65 20 6e 61 6d 65 20 6f 66 20 74 . The name of t 0e70: 68 69 73 20 66 69 6c 65 20 69 6e 20 74 68 65 20 his file in the 0e80: 66 6f 73 73 69 6c 0a 73 6f 75 72 63 65 20 74 72 fossil.source tr 0e90: 65 65 20 69 73 20 22 3c 62 3e 77 77 77 2f 65 6d ee is "<b>www/em 0ea0: 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 3c 2f beddeddoc.wiki</ 0eb0: 62 3e 22 2e 0a 59 6f 75 20 61 72 65 20 70 65 72 b>"..You are per 0ec0: 68 61 70 73 20 6c 6f 6f 6b 69 6e 67 20 61 74 20 haps looking at 0ed0: 74 68 69 73 0a 66 69 6c 65 20 75 73 69 6e 67 20 this.file using 0ee0: 74 68 65 20 55 52 4c 3a 0a 0a 20 20 20 5b 68 74 the URL:.. [ht 0ef0: 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d tp://www.fossil- 0f00: 73 63 6d 2e 6f 72 67 2f 69 6e 64 65 78 2e 68 74 scm.org/index.ht 0f10: 6d 6c 2f 64 6f 63 2f 74 69 70 2f 77 77 77 2f 65 ml/doc/tip/www/e 0f20: 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 5d mbeddeddoc.wiki] 0f30: 2e 0a 0a 54 68 65 20 66 69 72 73 74 20 70 61 72 ...The first par 0f40: 74 20 6f 66 20 74 68 69 73 20 70 61 74 68 2c 20 t of this path, 0f50: 74 68 65 20 22 5b 68 74 74 70 3a 2f 2f 77 77 77 the "[http://www 0f60: 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f .fossil-scm.org/ 0f70: 69 6e 64 65 78 2e 68 74 6d 6c 5d 22 2c 0a 69 73 index.html]",.is 0f80: 20 74 68 65 20 62 61 73 65 20 55 52 4c 2e 20 20 the base URL. 0f90: 59 6f 75 20 6d 69 67 68 74 20 68 61 76 65 20 6f You might have o 0fa0: 72 69 67 69 6e 61 6c 6c 79 20 74 79 70 65 64 3a riginally typed: 0fb0: 0a 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 .[http://www.fos 0fc0: 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 5d 2e 20 20 sil-scm.org/]. 0fd0: 54 68 65 20 77 65 62 20 73 65 72 76 65 72 20 61 The web server a 0fe0: 74 20 74 68 65 20 77 77 77 2e 66 6f 73 73 69 6c t the www.fossil 0ff0: 2d 73 63 6d 2e 6f 72 67 0a 73 69 74 65 20 61 75 -scm.org.site au 1000: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 64 69 tomatically redi 1010: 72 65 63 74 73 20 73 75 63 68 20 6c 69 6e 6b 73 rects such links 1020: 20 62 79 20 61 70 70 65 6e 64 69 6e 67 20 22 69 by appending "i 1030: 6e 64 65 78 2e 68 74 6d 6c 22 2e 20 20 54 68 65 ndex.html". The 1040: 0a 22 69 6e 64 65 78 2e 68 74 6d 6c 22 20 66 69 ."index.html" fi 1050: 6c 65 20 6f 6e 20 77 77 77 2e 66 6f 73 73 69 6c le on www.fossil 1060: 2d 73 63 6d 2e 6f 72 67 20 69 73 20 72 65 61 6c -scm.org is real 1070: 6c 79 20 61 20 43 47 49 20 73 63 72 69 70 74 0a ly a CGI script. 1080: 28 64 6f 20 6e 6f 74 20 62 65 20 6d 69 73 6c 65 (do not be misle 1090: 61 64 20 62 79 20 74 68 65 20 6e 61 6d 65 29 20 ad by the name) 10a0: 77 68 69 63 68 20 72 75 6e 73 20 74 68 65 20 66 which runs the f 10b0: 6f 73 73 69 6c 20 77 65 62 20 73 65 72 76 69 63 ossil web servic 10c0: 65 20 69 6e 0a 43 47 49 20 6d 6f 64 65 2e 20 20 e in.CGI mode. 10d0: 54 68 65 20 22 69 6e 64 65 78 2e 68 74 6d 6c 22 The "index.html" 10e0: 20 43 47 49 20 73 63 72 69 70 74 20 6c 6f 6f 6b CGI script look 10f0: 73 20 6c 69 6b 65 20 74 68 69 73 3a 0a 0a 3c 62 s like this:..<b 1100: 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a lockquote><pre>. 1110: 23 21 2f 75 73 72 2f 62 69 6e 2f 66 6f 73 73 69 #!/usr/bin/fossi 1120: 6c 0a 72 65 70 6f 73 69 74 6f 72 79 3a 20 2f 66 l.repository: /f 1130: 6f 73 73 69 6c 2f 66 6f 73 73 69 6c 2e 66 6f 73 ossil/fossil.fos 1140: 73 69 6c 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 sil.</pre></bloc 1150: 6b 71 75 6f 74 65 3e 0a 0a 54 68 69 73 20 69 73 kquote>..This is 1160: 20 6f 6e 65 20 6f 66 20 74 68 72 65 65 20 77 61 one of three wa 1170: 79 73 20 74 6f 20 73 65 74 20 75 70 20 61 20 0a ys to set up a . 1180: 3c 61 20 68 72 65 66 3d 22 71 75 69 63 6b 73 74 <a href="quickst 1190: 61 72 74 2e 77 69 6b 69 23 73 65 72 76 65 72 73 art.wiki#servers 11a0: 65 74 75 70 22 3e 66 6f 73 73 69 6c 20 77 65 62 etup">fossil web 11b0: 20 73 65 72 76 65 72 3c 2f 61 3e 2e 0a 0a 54 68 server</a>...Th 11c0: 65 20 22 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22 e "<b>/tip/</b>" 11d0: 20 70 61 72 74 20 6f 66 20 74 68 65 20 55 52 4c part of the URL 11e0: 20 74 65 6c 6c 73 20 66 6f 73 73 69 6c 20 74 6f tells fossil to 11f0: 20 75 73 65 0a 74 68 65 20 64 6f 63 75 6d 65 6e use.the documen 1200: 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 66 72 6f tation files fro 1210: 6d 20 74 68 65 20 63 68 65 63 6b 2d 69 6e 20 74 m the check-in t 1220: 68 61 74 20 77 61 73 20 63 68 65 63 6b 65 64 20 hat was checked 1230: 69 6e 20 6d 6f 73 74 0a 72 65 63 65 6e 74 6c 79 in most.recently 1240: 2e 20 20 49 66 20 79 6f 75 20 77 61 6e 74 65 64 . If you wanted 1250: 20 74 6f 20 73 65 65 20 61 6e 20 68 69 73 74 6f to see an histo 1260: 72 69 63 61 6c 20 76 65 72 73 69 6f 6e 20 6f 66 rical version of 1270: 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 2c 0a this document,. 1280: 79 6f 75 20 63 6f 75 6c 64 20 73 75 62 73 74 69 you could substi 1290: 74 75 74 65 20 74 68 65 20 6e 61 6d 65 20 6f 66 tute the name of 12a0: 20 61 20 63 68 65 63 6b 2d 69 6e 20 66 6f 72 20 a check-in for 12b0: 22 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22 2e 0a "<b>/tip/</b>".. 12c0: 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 74 6f 20 For example, to 12d0: 73 65 65 20 74 68 65 20 76 65 72 73 69 6f 6e 20 see the version 12e0: 6f 66 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 of this document 12f0: 20 61 73 73 6f 63 69 61 74 65 64 20 77 69 74 68 associated with 1300: 0a 63 68 65 63 6b 2d 69 6e 20 5b 39 62 65 31 62 .check-in [9be1b 1310: 30 30 33 39 32 5d 2c 20 73 69 6d 70 6c 79 20 72 00392], simply r 1320: 65 70 6c 61 63 65 20 74 68 65 20 22 3c 62 3e 2f eplace the "<b>/ 1330: 74 69 70 2f 3c 2f 62 3e 22 20 77 69 74 68 0a 22 tip/</b>" with." 1340: 3c 62 3e 2f 39 62 65 31 62 30 30 33 39 32 2f 3c <b>/9be1b00392/< 1350: 2f 62 3e 22 2e 20 20 59 6f 75 20 63 61 6e 20 61 /b>". You can a 1360: 6c 73 6f 20 73 75 62 73 74 69 74 75 74 65 20 74 lso substitute t 1370: 68 65 20 73 79 6d 62 6f 6c 69 63 20 6e 61 6d 65 he symbolic name 1380: 0a 66 6f 72 20 61 20 70 61 72 74 69 63 75 6c 61 .for a particula 1390: 72 20 76 65 72 73 69 6f 6e 20 6f 72 20 62 72 61 r version or bra 13a0: 6e 63 68 2e 20 20 46 6f 72 20 65 78 61 6d 70 6c nch. For exampl 13b0: 65 2c 20 79 6f 75 20 6d 69 67 68 74 0a 72 65 70 e, you might.rep 13c0: 6c 61 63 65 20 22 3c 62 3e 2f 74 69 70 2f 3c 2f lace "<b>/tip/</ 13d0: 62 3e 22 20 77 69 74 68 20 22 3c 62 3e 2f 74 72 b>" with "<b>/tr 13e0: 75 6e 6b 2f 3c 2f 62 3e 22 20 74 6f 20 67 65 74 unk/</b>" to get 13f0: 20 74 68 65 20 6c 61 74 65 73 74 0a 76 65 72 73 the latest.vers 1400: 69 6f 6e 20 6f 66 20 74 68 69 73 20 64 6f 63 75 ion of this docu 1410: 6d 65 6e 74 20 69 6e 20 74 68 65 20 22 74 72 75 ment in the "tru 1420: 6e 6b 22 20 62 72 61 6e 63 68 2e 20 20 28 41 73 nk" branch. (As 1430: 20 6f 66 20 74 68 69 73 20 77 72 69 74 69 6e 67 of this writing 1440: 2c 0a 74 68 65 20 73 65 6c 66 2d 68 6f 73 74 69 ,.the self-hosti 1450: 6e 67 20 66 6f 73 73 69 6c 20 72 65 70 6f 73 69 ng fossil reposi 1460: 74 6f 72 79 20 6f 6e 6c 79 20 68 61 73 20 61 20 tory only has a 1470: 73 69 6e 67 6c 65 20 62 72 61 6e 63 68 20 22 74 single branch "t 1480: 72 75 6e 6b 22 20 61 6e 64 0a 73 6f 20 22 74 72 runk" and.so "tr 1490: 75 6e 6b 22 20 61 6e 64 20 22 74 69 70 22 20 61 unk" and "tip" a 14a0: 6d 6f 75 6e 74 20 74 6f 20 74 68 65 20 73 61 6d mount to the sam 14b0: 65 20 74 68 69 6e 67 2c 20 62 75 74 20 74 68 65 e thing, but the 14c0: 79 20 77 6f 75 6c 64 20 62 65 20 64 69 66 66 65 y would be diffe 14d0: 72 65 6e 74 0a 69 6e 20 61 20 70 72 6f 6a 65 63 rent.in a projec 14e0: 74 20 77 69 74 68 20 6d 75 6c 74 69 70 6c 65 20 t with multiple 14f0: 62 72 61 6e 63 68 65 73 2e 29 0a 0a 54 68 65 20 branches.)..The 1500: 66 69 6c 65 20 74 68 61 74 20 65 6e 63 6f 64 65 file that encode 1510: 73 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 20 s this document 1520: 69 73 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 is stored in the 1530: 20 66 6f 73 73 69 6c 20 73 6f 75 72 63 65 20 74 fossil source t 1540: 72 65 65 20 75 6e 64 65 72 0a 74 68 65 20 6e 61 ree under.the na 1550: 6d 65 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 me "<b>www/embed 1560: 64 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 deddoc.wiki</b>" 1570: 20 61 6e 64 20 73 6f 20 74 68 61 74 20 6e 61 6d and so that nam 1580: 65 20 66 6f 72 6d 73 20 74 68 65 0a 6c 61 73 74 e forms the.last 1590: 20 70 61 72 74 20 6f 66 20 74 68 65 20 55 52 4c part of the URL 15a0: 20 66 6f 72 20 74 68 69 73 20 64 6f 63 75 6d 65 for this docume 15b0: 6e 74 2e 0a 0a 41 73 20 49 20 73 69 74 20 77 72 nt...As I sit wr 15c0: 69 74 69 6e 67 20 74 68 69 73 20 64 6f 63 75 6d iting this docum 15d0: 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 2c 20 49 entation file, I 15e0: 20 61 6d 20 74 65 73 74 69 6e 67 20 6d 79 20 77 am testing my w 15f0: 6f 72 6b 20 62 79 0a 72 75 6e 6e 69 6e 67 20 74 ork by.running t 1600: 68 65 20 22 3c 62 3e 66 6f 73 73 69 6c 20 73 65 he "<b>fossil se 1610: 72 76 65 72 3c 2f 62 3e 22 20 63 6f 6d 6d 61 6e rver</b>" comman 1620: 64 20 6c 69 6e 65 20 61 6e 64 20 76 69 65 77 69 d line and viewi 1630: 6e 67 0a 3c 62 3e 68 74 74 70 3a 2f 2f 6c 6f 63 ng.<b>http://loc 1640: 61 6c 68 6f 73 74 3a 38 30 38 30 2f 64 6f 63 2f alhost:8080/doc/ 1650: 63 6b 6f 75 74 2f 77 77 77 2f 65 6d 62 65 64 64 ckout/www/embedd 1660: 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 20 69 eddoc.wiki</b> i 1670: 6e 0a 46 69 72 65 66 6f 78 2e 20 20 49 20 61 6d n.Firefox. I am 1680: 20 64 6f 69 6e 67 20 74 68 69 73 20 65 76 65 6e doing this even 1690: 20 74 68 6f 75 67 68 20 49 20 68 61 76 65 20 6e though I have n 16a0: 6f 74 20 79 65 74 20 63 68 65 63 6b 65 64 20 69 ot yet checked i 16b0: 6e 0a 74 68 65 20 22 3c 62 3e 77 77 77 2f 65 6d n.the "<b>www/em 16c0: 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 3c 2f beddeddoc.wiki</ 16d0: 62 3e 22 20 66 69 6c 65 20 66 6f 72 20 74 68 65 b>" file for the 16e0: 20 66 69 72 73 74 20 74 69 6d 65 2e 20 20 55 73 first time. Us 16f0: 69 6e 67 0a 74 68 65 20 73 70 65 63 69 61 6c 20 ing.the special 1700: 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 76 "<b>ckout</b>" v 1710: 65 72 73 69 6f 6e 20 69 64 65 6e 74 69 66 69 65 ersion identifie 1720: 72 20 6f 6e 20 74 68 65 20 22 3c 62 3e 2f 64 6f r on the "<b>/do 1730: 63 3c 2f 62 3e 22 20 70 61 67 65 0a 69 74 20 69 c</b>" page.it i 1740: 73 20 65 61 73 79 20 74 6f 20 6d 61 6b 65 20 6d s easy to make m 1750: 75 6c 74 69 70 6c 65 20 63 68 61 6e 67 65 73 20 ultiple changes 1760: 74 6f 20 6d 75 6c 74 69 70 6c 65 20 66 69 6c 65 to multiple file 1770: 73 20 61 6e 64 20 73 65 65 20 68 6f 77 20 74 68 s and see how th 1780: 65 79 20 61 6c 6c 0a 6c 6f 6f 6b 20 74 6f 67 65 ey all.look toge 1790: 74 68 65 72 20 62 65 66 6f 72 65 20 63 6f 6d 6d ther before comm 17a0: 69 74 74 69 6e 67 20 61 6e 79 74 68 69 6e 67 20 itting anything 17b0: 74 6f 20 74 68 65 20 72 65 70 6f 73 69 74 6f 72 to the repositor 17c0: 79 2e 0a y..