Artifact 97f93908600bdd2dc3f0b52ecf2f81b80c1b2d4d:
File www/embeddeddoc.wiki part of check-in [4b826eed14] - Add a page describing how to do embedded documentation. by drh on 2008-05-19 15:10:55.
0000: 3c 68 31 3e 4d 61 6e 61 67 69 6e 67 20 50 72 6f <h1>Managing Pro 0010: 6a 65 63 74 20 44 6f 63 75 6d 65 6e 74 61 74 69 ject Documentati 0020: 6f 6e 3c 2f 68 31 3e 0a 0a 46 6f 73 73 69 6c 20 on</h1>..Fossil 0030: 70 72 6f 76 69 64 65 73 20 61 20 62 75 69 6c 74 provides a built 0040: 2d 69 6e 20 77 69 6b 69 20 77 68 69 63 68 20 63 -in wiki which c 0050: 61 6e 20 62 65 20 75 73 65 64 20 74 6f 20 73 74 an be used to st 0060: 6f 72 65 20 74 68 65 0a 64 6f 63 75 6d 65 6e 74 ore the.document 0070: 61 74 69 6f 6e 20 66 6f 72 20 61 20 70 72 6f 6a ation for a proj 0080: 65 63 74 2e 20 20 54 68 69 73 20 69 73 20 73 75 ect. This is su 0090: 66 66 69 63 69 65 6e 74 20 66 6f 72 20 6d 61 6e fficient for man 00a0: 79 20 70 72 6f 6a 65 63 74 73 2e 0a 49 66 20 79 y projects..If y 00b0: 6f 75 72 20 70 72 6f 6a 65 63 74 20 69 73 20 77 our project is w 00c0: 65 6c 6c 2d 73 65 72 76 65 64 20 62 79 20 77 69 ell-served by wi 00d0: 6b 69 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e ki documentation 00e0: 2c 20 74 68 65 6e 20 79 6f 75 0a 6e 65 65 64 20 , then you.need 00f0: 72 65 61 64 20 6e 6f 20 66 75 72 74 68 65 72 2e read no further. 0100: 0a 0a 42 75 74 20 66 6f 73 73 69 6c 20 61 6c 73 ..But fossil als 0110: 6f 20 73 75 70 70 6f 72 74 73 20 65 6d 62 65 64 o supports embed 0120: 64 69 6e 67 20 70 72 6f 6a 65 63 74 20 64 6f 63 ding project doc 0130: 75 6d 65 6e 74 61 74 69 6f 6e 20 61 73 0a 66 69 umentation as.fi 0140: 6c 65 73 20 69 6e 20 74 68 65 20 73 6f 75 72 63 les in the sourc 0150: 65 20 74 72 65 65 2e 20 20 54 68 65 72 65 20 61 e tree. There a 0160: 72 65 20 73 65 76 65 72 61 6c 20 70 6f 74 65 6e re several poten 0170: 74 69 61 6c 20 61 64 76 61 6e 74 61 67 65 73 0a tial advantages. 0180: 74 6f 20 74 68 69 73 20 61 70 70 72 6f 61 63 68 to this approach 0190: 3a 0a 0a 20 20 31 2e 20 20 54 68 65 20 64 6f 63 :.. 1. The doc 01a0: 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 73 umentation files 01b0: 20 61 72 65 20 76 65 72 73 69 6f 6e 65 64 20 74 are versioned t 01c0: 6f 67 65 74 68 65 72 20 77 69 74 68 20 74 68 65 ogether with the 01d0: 0a 20 20 20 20 20 20 73 6f 75 72 63 65 20 63 6f . source co 01e0: 64 65 20 66 69 6c 65 73 20 73 6f 20 69 74 20 69 de files so it i 01f0: 73 20 61 6c 77 61 79 73 20 63 6c 65 61 72 20 77 s always clear w 0200: 68 61 74 20 76 65 72 73 69 6f 6e 20 6f 66 0a 20 hat version of. 0210: 20 20 20 20 20 74 68 65 20 64 6f 63 75 6d 65 6e the documen 0220: 74 61 74 69 6f 6e 20 67 6f 65 73 20 77 69 74 68 tation goes with 0230: 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 72 65 a particular re 0240: 6c 65 61 73 65 2e 0a 0a 20 20 32 2e 20 20 54 68 lease... 2. Th 0250: 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 e documentation 0260: 66 69 6c 65 73 20 63 61 6e 20 62 65 20 65 64 69 files can be edi 0270: 74 65 64 20 75 73 69 6e 67 20 79 6f 75 72 20 66 ted using your f 0280: 61 76 6f 72 69 74 65 0a 20 20 20 20 20 20 74 65 avorite. te 0290: 78 74 20 65 64 69 74 6f 72 20 69 6e 73 74 65 61 xt editor instea 02a0: 64 20 6f 66 20 68 61 76 69 6e 67 20 74 6f 20 75 d of having to u 02b0: 73 65 20 74 68 65 20 77 65 62 2d 62 61 73 65 64 se the web-based 02c0: 20 77 69 6b 69 0a 20 20 20 20 20 20 65 64 69 74 wiki. edit 02d0: 6f 72 2e 0a 0a 20 20 33 2e 20 20 4f 6e 6c 79 20 or... 3. Only 02e0: 70 65 6f 70 6c 65 20 77 69 74 68 20 63 68 65 63 people with chec 02f0: 6b 2d 69 6e 20 70 72 69 76 69 6c 65 67 65 73 20 k-in privileges 0300: 63 61 6e 20 6d 6f 64 69 66 79 20 74 68 65 20 64 can modify the d 0310: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 0a 20 20 ocumentation.. 0320: 20 20 20 20 28 54 68 69 73 20 6d 69 67 68 74 20 (This might 0330: 62 65 20 65 69 74 68 65 72 20 61 6e 20 61 64 76 be either an adv 0340: 61 6e 74 61 67 65 20 6f 72 20 64 69 73 61 64 76 antage or disadv 0350: 61 6e 74 61 67 65 2c 20 64 65 70 65 6e 64 69 6e antage, dependin 0360: 67 0a 20 20 20 20 20 20 6f 6e 20 74 68 65 20 6e g. on the n 0370: 61 74 75 72 65 20 6f 66 20 79 6f 75 72 20 70 72 ature of your pr 0380: 6f 6a 65 63 74 2e 29 0a 0a 57 65 20 77 69 6c 6c oject.)..We will 0390: 20 63 61 6c 6c 20 64 6f 63 75 6d 65 6e 74 61 74 call documentat 03a0: 69 6f 6e 20 69 73 20 69 6e 63 6c 75 64 65 64 20 ion is included 03b0: 61 73 20 66 69 6c 65 73 20 69 6e 20 74 68 65 20 as files in the 03c0: 73 6f 75 72 63 65 20 74 72 65 65 0a 22 65 6d 62 source tree."emb 03d0: 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 edded documentat 03e0: 69 6f 6e 22 2e 0a 0a 3c 68 32 3e 46 6f 73 73 69 ion"...<h2>Fossi 03f0: 6c 20 53 75 70 70 6f 72 74 20 46 6f 72 20 45 6d l Support For Em 0400: 62 65 64 64 65 64 20 44 6f 63 75 6d 65 6e 74 61 bedded Documenta 0410: 74 69 6f 6e 3c 2f 68 32 3e 0a 0a 54 68 65 20 66 tion</h2>..The f 0420: 6f 73 73 69 6c 20 77 65 62 20 69 6e 74 65 72 66 ossil web interf 0430: 61 63 65 20 73 75 70 70 6f 72 74 73 20 65 6d 62 ace supports emb 0440: 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 edded documentat 0450: 69 6f 6e 20 75 73 69 6e 67 0a 74 68 65 20 22 2f ion using.the "/ 0460: 64 6f 63 22 20 70 61 67 65 2e 20 20 54 6f 20 61 doc" page. To a 0470: 63 63 65 73 73 20 65 6d 62 65 64 64 65 64 20 64 ccess embedded d 0480: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 6f 6e ocumentation, on 0490: 65 20 70 6f 69 6e 74 73 0a 61 20 77 65 62 20 62 e points.a web b 04a0: 72 6f 77 73 65 72 20 74 6f 20 61 20 66 6f 73 73 rowser to a foss 04b0: 69 6c 20 55 52 4c 20 6f 66 20 74 68 65 20 66 6f il URL of the fo 04c0: 6c 6c 6f 77 69 6e 67 20 66 6f 72 6d 3a 0a 0a 3c llowing form:..< 04d0: 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 26 blockquote>.<i>& 04e0: 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f lt;baseurl></ 04f0: 69 3e 3c 62 69 67 3e 3c 62 3e 2f 64 6f 63 2f 3c i><big><b>/doc/< 0500: 2f 62 3e 3c 2f 62 69 67 3e 3c 69 3e 26 6c 74 3b /b></big><i>< 0510: 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e 3c version></i>< 0520: 62 69 67 3e 3c 62 3e 2f 3c 2f 62 3e 3c 2f 62 69 big><b>/</b></bi 0530: 67 3e 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e 61 6d g><i><filenam 0540: 65 26 67 74 3b 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 e></i>.</bloc 0550: 6b 71 75 6f 74 65 3e 0a 0a 54 68 65 20 3c 69 3e kquote>..The <i> 0560: 26 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c <baseurl>< 0570: 2f 69 3e 20 69 73 20 74 68 65 20 6d 61 69 6e 20 /i> is the main 0580: 55 52 4c 20 75 73 65 64 20 74 6f 20 61 63 63 65 URL used to acce 0590: 73 73 20 74 68 65 20 66 6f 73 73 69 6c 20 77 65 ss the fossil we 05a0: 62 20 73 65 72 76 65 72 2e 0a 46 6f 72 20 65 78 b server..For ex 05b0: 61 6d 70 6c 65 2c 20 74 68 65 20 3c 69 3e 26 6c ample, the <i>&l 05c0: 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 t;baseurl></i 05d0: 3e 20 66 6f 72 20 74 68 65 20 66 6f 73 73 69 6c > for the fossil 05e0: 20 70 72 6f 6a 65 63 74 20 69 74 73 65 6c 66 20 project itself 05f0: 69 73 0a 65 69 74 68 65 72 20 3c 62 3e 68 74 74 is.either <b>htt 0600: 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 p://www.fossil-s 0610: 63 6d 2e 6f 72 67 2f 66 6f 73 73 69 6c 3c 2f 62 cm.org/fossil</b 0620: 3e 20 6f 72 0a 3c 62 3e 68 74 74 70 3a 2f 2f 77 > or.<b>http://w 0630: 77 77 2e 68 77 61 63 69 2e 63 6f 6d 2f 63 67 69 ww.hwaci.com/cgi 0640: 2d 62 69 6e 2f 66 6f 73 73 69 6c 3c 2f 62 3e 2e -bin/fossil</b>. 0650: 0a 49 66 20 79 6f 75 20 6c 61 75 6e 63 68 20 74 .If you launch t 0660: 68 65 20 77 65 62 20 73 65 72 76 65 72 20 75 73 he web server us 0670: 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 6f 73 73 ing the "<b>foss 0680: 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e 22 20 63 il server</b>" c 0690: 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2c 0a 74 68 65 ommand line,.the 06a0: 6e 20 74 68 65 20 3c 69 3e 26 6c 74 3b 62 61 73 n the <i><bas 06b0: 65 75 72 6c 26 67 74 3b 3c 2f 69 3e 20 69 73 20 eurl></i> is 06c0: 75 73 75 61 6c 6c 79 0a 3c 62 3e 68 74 74 70 3a usually.<b>http: 06d0: 2f 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 30 38 30 //localhost:8080 06e0: 2f 3c 2f 62 3e 2e 0a 0a 54 68 65 20 3c 69 3e 26 /</b>...The <i>& 06f0: 6c 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f lt;version></ 0700: 69 3e 20 69 73 20 61 6e 79 20 75 6e 69 71 75 65 i> is any unique 0710: 20 55 55 49 44 20 70 72 65 66 69 78 20 6f 66 20 UUID prefix of 0720: 74 68 65 20 62 61 73 65 6c 69 6e 65 20 0a 66 6f the baseline .fo 0730: 72 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 r the documentat 0740: 69 6f 6e 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 ion you want to 0750: 61 63 63 65 73 73 2e 0a 4f 72 20 3c 69 3e 26 6c access..Or <i>&l 0760: 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 t;version></i 0770: 3e 20 63 61 6e 20 62 65 20 6f 6e 65 20 6f 66 20 > can be one of 0780: 74 68 65 20 6b 65 79 77 6f 72 64 73 20 22 3c 62 the keywords "<b 0790: 3e 74 69 70 3c 2f 62 3e 22 20 6f 72 0a 22 3c 62 >tip</b>" or."<b 07a0: 3e 63 6b 6f 75 74 3c 2f 62 3e 22 2e 20 20 54 68 >ckout</b>". Th 07b0: 65 20 22 3c 62 3e 74 69 70 3c 2f 62 3e 22 20 6b e "<b>tip</b>" k 07c0: 65 79 77 6f 72 64 20 6d 65 61 6e 73 20 74 6f 20 eyword means to 07d0: 75 73 65 20 74 68 65 20 6d 6f 73 74 20 72 65 63 use the most rec 07e0: 65 6e 74 6c 79 0a 63 68 65 63 6b 65 64 2d 69 6e ently.checked-in 07f0: 20 62 61 73 65 6c 69 6e 65 2e 20 20 54 68 69 73 baseline. This 0800: 20 69 73 20 75 73 65 66 75 6c 20 69 66 20 79 6f is useful if yo 0810: 75 20 77 61 6e 74 20 74 6f 20 73 65 65 20 74 68 u want to see th 0820: 65 20 76 65 72 79 20 6c 61 74 65 73 74 0a 76 65 e very latest.ve 0830: 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 rsion of the doc 0840: 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54 68 65 umentation. The 0850: 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 "<b>ckout</b>" 0860: 6b 65 79 77 6f 72 64 73 20 6d 65 61 6e 73 20 74 keywords means t 0870: 6f 0a 70 75 6c 6c 20 74 68 65 20 64 6f 63 75 6d o.pull the docum 0880: 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 20 66 72 entation file fr 0890: 6f 6d 20 74 68 65 20 6c 6f 63 61 6c 20 73 6f 75 om the local sou 08a0: 72 63 65 20 74 72 65 65 20 6f 6e 20 64 69 73 6b rce tree on disk 08b0: 2c 20 6e 6f 74 0a 66 72 6f 6d 20 74 68 65 20 61 , not.from the a 08c0: 6e 79 20 76 65 72 73 69 6f 6e 65 64 20 62 61 73 ny versioned bas 08d0: 65 6c 69 6e 65 2e 20 20 54 68 65 20 22 3c 62 3e eline. The "<b> 08e0: 63 6b 6f 75 74 3c 2f 62 3e 22 20 6b 65 79 77 6f ckout</b>" keywo 08f0: 72 64 20 6e 6f 72 6d 61 6c 6c 79 0a 6f 6e 6c 79 rd normally.only 0900: 20 77 6f 72 6b 73 20 77 68 65 6e 20 79 6f 75 20 works when you 0910: 73 74 61 72 74 20 79 6f 75 72 20 73 65 72 76 65 start your serve 0920: 72 20 75 73 69 6e 67 20 74 68 65 20 22 3c 62 3e r using the "<b> 0930: 66 6f 73 73 69 6c 20 73 65 72 76 65 72 3c 2f 62 fossil server</b 0940: 3e 22 0a 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 20 >".command line 0950: 61 6e 64 20 69 73 20 69 6e 74 65 6e 74 65 64 20 and is intented 0960: 74 6f 20 73 68 6f 77 20 77 68 61 74 20 74 68 65 to show what the 0970: 20 64 6f 63 75 6d 65 6e 61 74 69 6f 6e 20 79 6f documenation yo 0980: 75 20 61 72 65 20 63 75 72 72 65 6e 74 6c 79 0a u are currently. 0990: 65 64 69 74 69 6e 67 20 6c 6f 6f 6b 73 20 6c 69 editing looks li 09a0: 6b 65 20 62 65 66 6f 72 65 20 79 6f 75 20 63 68 ke before you ch 09b0: 65 63 6b 20 69 74 20 69 6e 2e 0a 0a 46 69 6e 61 eck it in...Fina 09c0: 6c 6c 79 2c 20 74 68 65 20 3c 69 3e 26 6c 74 3b lly, the <i>< 09d0: 66 69 6c 65 6e 61 6d 65 26 67 74 3b 3c 2f 69 3e filename></i> 09e0: 20 65 6c 65 6d 65 6e 74 20 6f 66 20 74 68 65 20 element of the 09f0: 55 52 4c 20 69 73 20 74 68 65 20 66 75 6c 6c 0a URL is the full. 0a00: 70 61 74 68 6e 61 6d 65 20 6f 66 20 74 68 65 20 pathname of the 0a10: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 documentation fi 0a20: 6c 65 20 73 74 61 72 74 69 6e 67 20 66 72 6f 6d le starting from 0a30: 20 74 68 65 20 72 6f 6f 74 20 6f 66 20 74 68 65 the root of the 0a40: 20 73 6f 75 72 63 65 0a 74 72 65 65 2e 0a 0a 54 source.tree...T 0a50: 68 65 20 6d 69 6d 65 74 79 70 65 20 28 61 6e 64 he mimetype (and 0a60: 20 74 68 75 73 20 74 68 65 20 72 65 6e 64 65 72 thus the render 0a70: 69 6e 67 29 20 6f 66 20 64 6f 63 75 6d 65 6e 74 ing) of document 0a80: 61 74 69 6f 6e 20 66 69 6c 65 73 20 69 73 20 0a ation files is . 0a90: 64 65 74 65 72 6d 69 6e 65 64 20 62 79 20 74 68 determined by th 0aa0: 65 20 66 69 6c 65 20 73 75 66 66 69 78 2e 20 20 e file suffix. 0ab0: 46 6f 73 73 69 6c 20 63 75 72 72 65 6e 74 6c 79 Fossil currently 0ac0: 20 75 6e 64 65 72 73 74 61 6e 64 73 20 74 68 65 understands the 0ad0: 0a 66 6f 6c 6c 6f 77 69 6e 67 20 66 69 6c 65 20 .following file 0ae0: 73 75 66 66 69 78 65 73 20 6f 72 20 65 6d 62 65 suffixes or embe 0af0: 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 73 3a 0a dded documents:. 0b00: 0a 20 20 2a 20 20 2e 63 73 73 0a 20 20 2a 20 20 . * .css. * 0b10: 2e 67 69 66 0a 20 20 2a 20 20 2e 68 74 6d 0a 20 .gif. * .htm. 0b20: 20 2a 20 20 2e 68 74 6d 6c 0a 20 20 2a 20 20 2e * .html. * . 0b30: 6a 70 67 0a 20 20 2a 20 20 2e 6a 70 65 67 0a 20 jpg. * .jpeg. 0b40: 20 2a 20 20 2e 70 6e 67 0a 20 20 2a 20 20 2e 74 * .png. * .t 0b50: 78 74 0a 20 20 2a 20 20 2e 77 69 6b 69 0a 0a 44 xt. * .wiki..D 0b60: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c ocumentation fil 0b70: 65 73 20 77 68 6f 73 65 20 6e 61 6d 65 73 20 65 es whose names e 0b80: 6e 64 20 69 6e 20 22 2e 77 69 6b 69 22 20 75 73 nd in ".wiki" us 0b90: 65 20 74 68 65 20 0a 3c 61 20 68 72 65 66 3d 22 e the .<a href=" 0ba0: 2e 2e 2f 77 69 6b 69 5f 72 75 6c 65 73 22 3e 73 ../wiki_rules">s 0bb0: 61 6d 65 20 6d 61 72 6b 75 70 20 61 73 20 77 69 ame markup as wi 0bc0: 6b 69 20 70 61 67 65 73 3c 2f 61 3e 20 2d 0a 61 ki pages</a> -.a 0bd0: 20 73 61 66 65 20 73 75 62 73 65 74 20 6f 66 20 safe subset of 0be0: 48 54 4d 4c 20 74 6f 67 65 74 68 65 72 20 77 69 HTML together wi 0bf0: 74 68 20 73 6f 6d 65 20 72 75 6c 65 73 20 66 6f th some rules fo 0c00: 72 20 70 61 72 61 67 72 61 70 68 0a 62 72 65 61 r paragraph.brea 0c10: 6b 73 2c 20 6c 69 73 74 73 2c 20 61 6e 64 20 68 ks, lists, and h 0c20: 79 70 65 72 6c 69 6e 6b 73 2e 20 20 54 68 65 20 yperlinks. The 0c30: 22 2e 77 69 6b 69 22 20 61 6e 64 20 22 2e 74 78 ".wiki" and ".tx 0c40: 74 22 20 70 61 67 65 73 0a 61 72 65 20 72 65 6e t" pages.are ren 0c50: 64 65 72 65 64 20 77 69 74 68 20 74 68 65 20 73 dered with the s 0c60: 74 61 6e 64 61 72 64 20 66 6f 73 73 69 6c 20 68 tandard fossil h 0c70: 65 61 64 65 72 20 61 6e 64 20 66 6f 6f 74 65 72 eader and footer 0c80: 20 61 64 64 65 64 2e 0a 41 6c 6c 20 6f 74 68 65 added..All othe 0c90: 72 20 6d 69 6d 65 74 69 6d 65 73 20 61 72 65 20 r mimetimes are 0ca0: 64 65 6c 69 76 65 72 65 64 20 64 69 72 65 63 74 delivered direct 0cb0: 6c 79 20 74 6f 20 74 68 65 20 72 65 71 75 65 73 ly to the reques 0cc0: 74 69 6e 67 0a 77 65 62 20 62 72 6f 77 73 65 72 ting.web browser 0cd0: 20 77 69 74 68 20 69 6e 74 65 72 70 72 65 74 61 with interpreta 0ce0: 74 69 6f 6e 2c 20 61 64 64 69 74 69 6f 6e 73 2c tion, additions, 0cf0: 20 6f 72 20 63 68 61 6e 67 65 73 2e 0a 0a 54 68 or changes...Th 0d00: 65 20 6c 69 73 74 20 6f 66 20 61 6c 6c 6f 77 65 e list of allowe 0d10: 64 20 73 75 66 66 69 78 65 73 20 66 6f 72 20 65 d suffixes for e 0d20: 6d 62 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 mbedded document 0d30: 73 20 69 73 20 6c 69 6b 65 6c 79 20 74 6f 0a 67 s is likely to.g 0d40: 72 6f 77 20 61 6e 64 20 62 65 63 6f 6d 65 20 75 row and become u 0d50: 73 65 72 2d 63 6f 6e 66 69 67 75 72 61 62 6c 65 ser-configurable 0d60: 20 69 6e 20 66 75 74 75 72 65 20 72 65 6c 65 61 in future relea 0d70: 73 65 73 20 6f 66 20 66 6f 73 73 69 6c 2e 0a 0a ses of fossil... 0d80: 3c 68 32 3e 45 78 61 6d 70 6c 65 73 3c 2f 68 32 <h2>Examples</h2 0d90: 3e 0a 0a 54 68 69 73 20 66 69 6c 65 20 74 68 61 >..This file tha 0da0: 74 20 79 6f 75 20 61 72 65 20 63 75 72 72 65 6e t you are curren 0db0: 74 6c 79 20 72 65 61 64 69 6e 67 20 69 73 20 61 tly reading is a 0dc0: 6e 20 65 78 61 6d 70 6c 65 20 6f 66 0a 65 6d 62 n example of.emb 0dd0: 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 edded documentat 0de0: 69 6f 6e 2e 20 20 54 68 65 20 6e 61 6d 65 20 6f ion. The name o 0df0: 66 20 74 68 69 73 20 66 69 6c 65 20 69 6e 20 74 f this file in t 0e00: 68 65 20 66 6f 73 73 69 6c 0a 73 6f 75 72 63 65 he fossil.source 0e10: 20 74 72 65 65 20 69 73 20 22 3c 62 3e 77 77 77 tree is "<b>www 0e20: 2f 65 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 6b /embeddeddoc.wik 0e30: 69 3c 2f 62 3e 22 2e 0a 59 6f 75 20 61 72 65 20 i</b>"..You are 0e40: 70 65 72 68 61 70 73 20 6c 6f 6f 6b 69 6e 67 20 perhaps looking 0e50: 61 74 20 74 68 69 73 0a 66 69 6c 65 20 75 73 69 at this.file usi 0e60: 6e 67 20 74 68 65 20 55 52 4c 3a 20 20 0a 5b 68 ng the URL: .[h 0e70: 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c ttp://www.fossil 0e80: 2d 73 63 6d 2e 6f 72 67 2f 69 6e 64 65 78 2e 68 -scm.org/index.h 0e90: 74 6d 6c 2f 64 6f 63 2f 74 69 70 2f 77 77 77 2f tml/doc/tip/www/ 0ea0: 65 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 embeddeddoc.wiki 0eb0: 5d 2e 0a 0a 54 68 65 20 66 69 72 73 74 20 70 61 ]...The first pa 0ec0: 72 74 20 6f 66 20 74 68 69 73 20 70 61 74 68 2c rt of this path, 0ed0: 20 74 68 65 20 22 5b 68 74 74 70 3a 2f 2f 77 77 the "[http://ww 0ee0: 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 w.fossil-scm.org 0ef0: 2f 69 6e 64 65 78 2e 68 74 6d 6c 5d 22 2c 0a 69 /index.html]",.i 0f00: 73 20 74 68 65 20 62 61 73 65 20 55 52 4c 2e 20 s the base URL. 0f10: 20 59 6f 75 20 6d 69 67 68 74 20 68 61 76 65 20 You might have 0f20: 6f 72 69 67 69 6e 61 6c 6c 79 20 74 79 70 65 64 originally typed 0f30: 3a 0a 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f :.[http://www.fo 0f40: 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 5d 2e 20 ssil-scm.org/]. 0f50: 20 54 68 65 20 77 65 62 20 73 65 72 76 65 72 20 The web server 0f60: 61 74 20 74 68 65 20 77 77 77 2e 66 6f 73 73 69 at the www.fossi 0f70: 6c 2d 73 63 6d 2e 6f 72 67 0a 73 69 74 65 20 61 l-scm.org.site a 0f80: 75 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 64 utomatically red 0f90: 69 72 65 63 74 73 20 73 75 63 68 20 6c 69 6e 6b irects such link 0fa0: 73 20 62 79 20 61 70 70 65 6e 64 69 6e 67 20 22 s by appending " 0fb0: 69 6e 64 65 78 2e 68 74 6d 6c 22 2e 20 20 54 68 index.html". Th 0fc0: 65 0a 22 69 6e 64 65 78 2e 68 74 6d 6c 22 20 66 e."index.html" f 0fd0: 69 6c 65 20 6f 6e 20 77 77 77 2e 66 6f 73 73 69 ile on www.fossi 0fe0: 6c 2d 73 63 6d 2e 6f 72 67 20 69 73 20 72 65 61 l-scm.org is rea 0ff0: 6c 6c 79 20 61 20 43 47 49 20 73 63 72 69 70 74 lly a CGI script 1000: 0a 28 64 6f 20 6e 6f 74 20 62 65 20 6d 69 73 6c .(do not be misl 1010: 65 61 64 20 62 79 20 74 68 65 20 6e 61 6d 65 29 ead by the name) 1020: 20 77 68 69 63 68 20 72 75 6e 73 20 74 68 65 20 which runs the 1030: 66 6f 73 73 69 6c 20 77 65 62 20 73 65 72 76 69 fossil web servi 1040: 63 65 20 69 6e 0a 43 47 49 20 6d 6f 64 65 2e 20 ce in.CGI mode. 1050: 20 54 68 65 20 22 69 6e 64 65 78 2e 68 74 6d 6c The "index.html 1060: 22 20 43 47 49 20 73 63 72 69 70 74 20 6c 6f 6f " CGI script loo 1070: 6b 73 20 6c 69 6b 65 20 74 68 69 73 3a 0a 0a 3c ks like this:..< 1080: 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e blockquote><pre> 1090: 0a 23 21 2f 75 73 72 2f 62 69 6e 2f 66 6f 73 73 .#!/usr/bin/foss 10a0: 69 6c 0a 72 65 70 6f 73 69 74 6f 72 79 3a 20 2f il.repository: / 10b0: 66 6f 73 73 69 6c 2f 66 6f 73 73 69 6c 2e 66 6f fossil/fossil.fo 10c0: 73 73 69 6c 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f ssil.</pre></blo 10d0: 63 6b 71 75 6f 74 65 3e 0a 0a 54 68 69 73 20 69 ckquote>..This i 10e0: 73 20 6f 6e 65 20 6f 66 20 74 68 72 65 65 20 77 s one of three w 10f0: 61 79 73 20 74 6f 20 73 65 74 20 75 70 20 61 20 ays to set up a 1100: 0a 3c 61 20 68 72 65 66 3d 22 71 75 69 63 6b 73 .<a href="quicks 1110: 74 61 72 74 2e 77 69 6b 69 23 73 65 72 76 65 72 tart.wiki#server 1120: 73 65 74 75 70 22 3e 66 6f 73 73 69 6c 20 77 65 setup">fossil we 1130: 62 20 73 65 72 76 65 72 3c 2f 61 3e 2e 0a 0a 54 b server</a>...T 1140: 68 65 20 22 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e he "<b>/tip/</b> 1150: 22 20 70 61 72 74 20 6f 66 20 74 68 65 20 55 52 " part of the UR 1160: 4c 20 74 65 6c 6c 73 20 66 6f 73 73 69 6c 20 74 L tells fossil t 1170: 6f 20 75 73 65 0a 74 68 65 20 64 6f 63 75 6d 65 o use.the docume 1180: 6e 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 66 72 ntation files fr 1190: 6f 6d 20 74 68 65 20 62 61 73 65 6c 69 6e 65 20 om the baseline 11a0: 74 68 61 74 20 77 61 73 20 63 68 65 63 6b 65 64 that was checked 11b0: 20 69 6e 20 6d 6f 73 74 0a 72 65 63 65 6e 74 6c in most.recentl 11c0: 79 2e 20 20 54 68 69 73 20 66 69 6c 65 20 69 73 y. This file is 11d0: 20 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20 66 stored in the f 11e0: 6f 73 73 69 6c 20 73 6f 75 72 63 65 20 74 72 65 ossil source tre 11f0: 65 20 75 6e 64 65 72 0a 74 68 65 20 6e 61 6d 65 e under.the name 1200: 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 65 "<b>www/embedde 1210: 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 61 ddoc.wiki</b>" a 1220: 6e 64 20 73 6f 20 74 68 61 74 20 6e 61 6d 65 20 nd so that name 1230: 66 6f 72 6d 73 20 74 68 65 0a 6c 61 73 74 20 70 forms the.last p 1240: 61 72 74 20 6f 66 20 74 68 65 20 55 52 4c 2e 0a art of the URL.. 1250: 0a 41 73 20 49 20 73 69 74 20 77 72 69 74 69 6e .As I sit writin 1260: 67 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 61 g this documenta 1270: 74 69 6f 6e 20 66 69 6c 65 2c 20 49 20 61 6d 20 tion file, I am 1280: 74 65 73 74 69 6e 67 20 6d 79 20 77 6f 72 6b 20 testing my work 1290: 62 79 0a 72 75 6e 6e 69 6e 67 20 74 68 65 20 22 by.running the " 12a0: 3c 62 3e 66 6f 73 73 69 6c 20 73 65 72 76 65 72 <b>fossil server 12b0: 3c 2f 62 3e 22 20 63 6f 6d 6d 61 6e 64 20 6c 69 </b>" command li 12c0: 6e 65 20 61 6e 64 20 76 69 65 77 69 6e 67 0a 3c ne and viewing.< 12d0: 62 3e 68 74 74 70 3a 2f 2f 6c 6f 63 61 6c 68 6f b>http://localho 12e0: 73 74 3a 38 30 38 30 2f 64 6f 63 2f 63 6b 6f 75 st:8080/doc/ckou 12f0: 74 2f 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f t/www/embeddeddo 1300: 63 2e 77 69 6b 69 3c 2f 62 3e 20 69 6e 0a 46 69 c.wiki</b> in.Fi 1310: 72 65 66 6f 78 2e 20 20 49 20 61 6d 20 64 6f 69 refox. I am doi 1320: 6e 67 20 74 68 69 73 20 65 76 65 6e 20 74 68 6f ng this even tho 1330: 75 67 68 20 49 20 68 61 76 65 20 6e 6f 74 20 79 ugh I have not y 1340: 65 74 20 63 68 65 63 6b 65 64 20 69 6e 0a 74 68 et checked in.th 1350: 65 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 e "<b>www/embedd 1360: 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 eddoc.wiki</b>" 1370: 66 69 6c 65 20 66 6f 72 20 74 68 65 20 66 69 72 file for the fir 1380: 73 74 20 74 69 6d 65 2e 20 20 55 73 69 6e 67 0a st time. Using. 1390: 74 68 65 20 73 70 65 63 69 61 6c 20 22 3c 62 3e the special "<b> 13a0: 63 6b 6f 75 74 3c 2f 62 3e 22 20 76 65 72 73 69 ckout</b>" versi 13b0: 6f 6e 20 69 64 65 6e 74 69 66 69 65 72 20 6f 6e on identifier on 13c0: 20 74 68 65 20 22 3c 62 3e 2f 64 6f 63 3c 2f 62 the "<b>/doc</b 13d0: 3e 22 20 70 61 67 65 0a 69 74 20 69 73 20 65 61 >" page.it is ea 13e0: 73 79 20 74 6f 20 6d 61 6b 65 20 6d 75 6c 74 69 sy to make multi 13f0: 70 6c 65 20 63 68 61 6e 67 65 73 20 74 6f 20 6d ple changes to m 1400: 75 6c 74 69 70 6c 65 20 66 69 6c 65 73 20 61 6e ultiple files an 1410: 64 20 73 65 65 20 68 6f 77 20 74 68 65 79 20 61 d see how they a 1420: 6c 6c 0a 6c 6f 6f 6b 20 74 6f 67 65 74 68 65 72 ll.look together 1430: 20 62 65 66 6f 72 65 20 63 6f 6d 6d 69 74 74 69 before committi 1440: 6e 67 20 61 6e 79 74 68 69 6e 67 20 74 6f 20 74 ng anything to t 1450: 68 65 20 72 65 70 6f 73 69 74 6f 72 79 2e 0a he repository..