Artifact 3547f7c3824377d7eab0d0aa06fa6cea0f45ba1d:
File www/embeddeddoc.wiki part of check-in [c8893c69ac] - Documentation updates. by drh on 2008-10-05 01:03:25.
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 3c 61 20 68 72 65 66 3d 22 77 69 6b -in <a href="wik 0050: 69 74 68 65 6f 72 79 2e 77 69 6b 69 22 3e 77 69 itheory.wiki">wi 0060: 6b 69 3c 2f 61 3e 0a 74 68 61 74 20 63 61 6e 20 ki</a>.that can 0070: 62 65 20 75 73 65 64 20 74 6f 20 73 74 6f 72 65 be used to store 0080: 20 74 68 65 0a 64 6f 63 75 6d 65 6e 74 61 74 69 the.documentati 0090: 6f 6e 20 66 6f 72 20 61 20 70 72 6f 6a 65 63 74 on for a project 00a0: 2e 20 20 54 68 69 73 20 69 73 20 73 75 66 66 69 . This is suffi 00b0: 63 69 65 6e 74 20 66 6f 72 20 6d 61 6e 79 20 70 cient for many p 00c0: 72 6f 6a 65 63 74 73 2e 0a 49 66 20 79 6f 75 72 rojects..If your 00d0: 20 70 72 6f 6a 65 63 74 20 69 73 20 77 65 6c 6c project is well 00e0: 2d 73 65 72 76 65 64 20 62 79 20 77 69 6b 69 20 -served by wiki 00f0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 74 documentation, t 0100: 68 65 6e 20 79 6f 75 0a 6e 65 65 64 20 72 65 61 hen you.need rea 0110: 64 20 6e 6f 20 66 75 72 74 68 65 72 2e 0a 0a 42 d no further...B 0120: 75 74 20 66 6f 73 73 69 6c 20 61 6c 73 6f 20 73 ut fossil also s 0130: 75 70 70 6f 72 74 73 20 65 6d 62 65 64 64 69 6e upports embeddin 0140: 67 20 70 72 6f 6a 65 63 74 20 64 6f 63 75 6d 65 g project docume 0150: 6e 74 61 74 69 6f 6e 20 61 73 0a 66 69 6c 65 73 ntation as.files 0160: 20 69 6e 20 74 68 65 20 73 6f 75 72 63 65 20 74 in the source t 0170: 72 65 65 2e 20 20 54 68 65 72 65 20 61 72 65 20 ree. There are 0180: 73 65 76 65 72 61 6c 20 70 6f 74 65 6e 74 69 61 several potentia 0190: 6c 20 61 64 76 61 6e 74 61 67 65 73 0a 74 6f 20 l advantages.to 01a0: 74 68 69 73 20 61 70 70 72 6f 61 63 68 3a 0a 0a this approach:.. 01b0: 20 20 31 2e 20 20 54 68 65 20 64 6f 63 75 6d 65 1. The docume 01c0: 6e 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 61 72 ntation files ar 01d0: 65 20 76 65 72 73 69 6f 6e 65 64 20 74 6f 67 65 e versioned toge 01e0: 74 68 65 72 20 77 69 74 68 20 74 68 65 0a 20 20 ther with the. 01f0: 20 20 20 20 73 6f 75 72 63 65 20 63 6f 64 65 20 source code 0200: 66 69 6c 65 73 20 73 6f 20 69 74 20 69 73 20 61 files so it is a 0210: 6c 77 61 79 73 20 63 6c 65 61 72 20 77 68 61 74 lways clear what 0220: 20 76 65 72 73 69 6f 6e 20 6f 66 0a 20 20 20 20 version of. 0230: 20 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 the documentat 0240: 69 6f 6e 20 67 6f 65 73 20 77 69 74 68 20 61 20 ion goes with a 0250: 70 61 72 74 69 63 75 6c 61 72 20 72 65 6c 65 61 particular relea 0260: 73 65 2e 0a 0a 20 20 32 2e 20 20 54 68 65 20 64 se... 2. The d 0270: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c ocumentation fil 0280: 65 73 20 63 61 6e 20 62 65 20 65 64 69 74 65 64 es can be edited 0290: 20 75 73 69 6e 67 20 79 6f 75 72 20 66 61 76 6f using your favo 02a0: 72 69 74 65 0a 20 20 20 20 20 20 74 65 78 74 20 rite. text 02b0: 65 64 69 74 6f 72 20 69 6e 73 74 65 61 64 20 6f editor instead o 02c0: 66 20 68 61 76 69 6e 67 20 74 6f 20 75 73 65 20 f having to use 02d0: 74 68 65 20 77 65 62 2d 62 61 73 65 64 20 77 69 the web-based wi 02e0: 6b 69 0a 20 20 20 20 20 20 65 64 69 74 6f 72 2e ki. editor. 02f0: 0a 0a 20 20 33 2e 20 20 4f 6e 6c 79 20 70 65 6f .. 3. Only peo 0300: 70 6c 65 20 77 69 74 68 20 63 68 65 63 6b 2d 69 ple with check-i 0310: 6e 20 70 72 69 76 69 6c 65 67 65 73 20 63 61 6e n privileges can 0320: 20 6d 6f 64 69 66 79 20 74 68 65 20 64 6f 63 75 modify the docu 0330: 6d 65 6e 74 61 74 69 6f 6e 2e 0a 20 20 20 20 20 mentation.. 0340: 20 28 54 68 69 73 20 6d 69 67 68 74 20 62 65 20 (This might be 0350: 65 69 74 68 65 72 20 61 6e 20 61 64 76 61 6e 74 either an advant 0360: 61 67 65 20 6f 72 20 64 69 73 61 64 76 61 6e 74 age or disadvant 0370: 61 67 65 2c 20 64 65 70 65 6e 64 69 6e 67 0a 20 age, depending. 0380: 20 20 20 20 20 6f 6e 20 74 68 65 20 6e 61 74 75 on the natu 0390: 72 65 20 6f 66 20 79 6f 75 72 20 70 72 6f 6a 65 re of your proje 03a0: 63 74 2e 29 0a 0a 57 65 20 77 69 6c 6c 20 63 61 ct.)..We will ca 03b0: 6c 6c 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e ll documentation 03c0: 20 74 68 61 74 20 69 73 20 69 6e 63 6c 75 64 65 that is include 03d0: 64 20 61 73 20 66 69 6c 65 73 20 69 6e 20 74 68 d as files in th 03e0: 65 20 73 6f 75 72 63 65 20 74 72 65 65 0a 22 65 e source tree."e 03f0: 6d 62 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 mbedded document 0400: 61 74 69 6f 6e 22 2e 0a 0a 3c 68 32 3e 46 6f 73 ation"...<h2>Fos 0410: 73 69 6c 20 53 75 70 70 6f 72 74 20 46 6f 72 20 sil Support For 0420: 45 6d 62 65 64 64 65 64 20 44 6f 63 75 6d 65 6e Embedded Documen 0430: 74 61 74 69 6f 6e 3c 2f 68 32 3e 0a 0a 54 68 65 tation</h2>..The 0440: 20 66 6f 73 73 69 6c 20 77 65 62 20 69 6e 74 65 fossil web inte 0450: 72 66 61 63 65 20 73 75 70 70 6f 72 74 73 20 65 rface supports e 0460: 6d 62 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 mbedded document 0470: 61 74 69 6f 6e 20 75 73 69 6e 67 0a 74 68 65 20 ation using.the 0480: 22 2f 64 6f 63 22 20 70 61 67 65 2e 20 20 54 6f "/doc" page. To 0490: 20 61 63 63 65 73 73 20 65 6d 62 65 64 64 65 64 access embedded 04a0: 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 documentation, 04b0: 6f 6e 65 20 70 6f 69 6e 74 73 0a 61 20 77 65 62 one points.a web 04c0: 20 62 72 6f 77 73 65 72 20 74 6f 20 61 20 66 6f browser to a fo 04d0: 73 73 69 6c 20 55 52 4c 20 6f 66 20 74 68 65 20 ssil URL of the 04e0: 66 6f 6c 6c 6f 77 69 6e 67 20 66 6f 72 6d 3a 0a following form:. 04f0: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 .<blockquote>.<i 0500: 3e 26 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b ><baseurl> 0510: 3c 2f 69 3e 3c 62 69 67 3e 3c 62 3e 2f 64 6f 63 </i><big><b>/doc 0520: 2f 3c 2f 62 3e 3c 2f 62 69 67 3e 3c 69 3e 26 6c /</b></big><i>&l 0530: 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 t;version></i 0540: 3e 3c 62 69 67 3e 3c 62 3e 2f 3c 2f 62 3e 3c 2f ><big><b>/</b></ 0550: 62 69 67 3e 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e big><i><filen 0560: 61 6d 65 26 67 74 3b 3c 2f 69 3e 0a 3c 2f 62 6c ame></i>.</bl 0570: 6f 63 6b 71 75 6f 74 65 3e 0a 0a 54 68 65 20 3c ockquote>..The < 0580: 69 3e 26 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 i><baseurl> 0590: 3b 3c 2f 69 3e 20 69 73 20 74 68 65 20 6d 61 69 ;</i> is the mai 05a0: 6e 20 55 52 4c 20 75 73 65 64 20 74 6f 20 61 63 n URL used to ac 05b0: 63 65 73 73 20 74 68 65 20 66 6f 73 73 69 6c 20 cess the fossil 05c0: 77 65 62 20 73 65 72 76 65 72 2e 0a 46 6f 72 20 web server..For 05d0: 65 78 61 6d 70 6c 65 2c 20 74 68 65 20 3c 69 3e example, the <i> 05e0: 26 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c <baseurl>< 05f0: 2f 69 3e 20 66 6f 72 20 74 68 65 20 66 6f 73 73 /i> for the foss 0600: 69 6c 20 70 72 6f 6a 65 63 74 20 69 74 73 65 6c il project itsel 0610: 66 20 69 73 0a 65 69 74 68 65 72 20 3c 62 3e 68 f is.either <b>h 0620: 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c ttp://www.fossil 0630: 2d 73 63 6d 2e 6f 72 67 2f 66 6f 73 73 69 6c 3c -scm.org/fossil< 0640: 2f 62 3e 20 6f 72 0a 3c 62 3e 68 74 74 70 3a 2f /b> or.<b>http:/ 0650: 2f 77 77 77 2e 68 77 61 63 69 2e 63 6f 6d 2f 63 /www.hwaci.com/c 0660: 67 69 2d 62 69 6e 2f 66 6f 73 73 69 6c 3c 2f 62 gi-bin/fossil</b 0670: 3e 2e 0a 49 66 20 79 6f 75 20 6c 61 75 6e 63 68 >..If you launch 0680: 20 74 68 65 20 77 65 62 20 73 65 72 76 65 72 20 the web server 0690: 75 73 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 6f using the "<b>fo 06a0: 73 73 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e 22 ssil server</b>" 06b0: 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2c 0a 74 command line,.t 06c0: 68 65 6e 20 74 68 65 20 3c 69 3e 26 6c 74 3b 62 hen the <i><b 06d0: 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 3e 20 69 aseurl></i> i 06e0: 73 20 75 73 75 61 6c 6c 79 0a 3c 62 3e 68 74 74 s usually.<b>htt 06f0: 70 3a 2f 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 30 p://localhost:80 0700: 38 30 2f 3c 2f 62 3e 2e 0a 0a 54 68 65 20 3c 69 80/</b>...The <i 0710: 3e 26 6c 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b ><version> 0720: 3c 2f 69 3e 20 69 73 20 61 6e 79 20 75 6e 69 71 </i> is any uniq 0730: 75 65 20 55 55 49 44 20 70 72 65 66 69 78 20 6f ue UUID prefix o 0740: 66 20 74 68 65 20 62 61 73 65 6c 69 6e 65 20 0a f the baseline . 0750: 66 6f 72 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 for the document 0760: 61 74 69 6f 6e 20 79 6f 75 20 77 61 6e 74 20 74 ation you want t 0770: 6f 20 61 63 63 65 73 73 2e 0a 4f 72 20 3c 69 3e o access..Or <i> 0780: 26 6c 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c <version>< 0790: 2f 69 3e 20 63 61 6e 20 62 65 20 6f 6e 65 20 6f /i> can be one o 07a0: 66 20 74 68 65 20 6b 65 79 77 6f 72 64 73 20 22 f the keywords " 07b0: 3c 62 3e 74 69 70 3c 2f 62 3e 22 20 6f 72 0a 22 <b>tip</b>" or." 07c0: 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 2e 20 20 <b>ckout</b>". 07d0: 54 68 65 20 22 3c 62 3e 74 69 70 3c 2f 62 3e 22 The "<b>tip</b>" 07e0: 20 6b 65 79 77 6f 72 64 20 6d 65 61 6e 73 20 74 keyword means t 07f0: 6f 20 75 73 65 20 74 68 65 20 6d 6f 73 74 20 72 o use the most r 0800: 65 63 65 6e 74 6c 79 0a 63 68 65 63 6b 65 64 2d ecently.checked- 0810: 69 6e 20 62 61 73 65 6c 69 6e 65 2e 20 20 54 68 in baseline. Th 0820: 69 73 20 69 73 20 75 73 65 66 75 6c 20 69 66 20 is is useful if 0830: 79 6f 75 20 77 61 6e 74 20 74 6f 20 73 65 65 20 you want to see 0840: 74 68 65 20 76 65 72 79 20 6c 61 74 65 73 74 0a the very latest. 0850: 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 65 20 64 version of the d 0860: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54 ocumentation. T 0870: 68 65 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e he "<b>ckout</b> 0880: 22 20 6b 65 79 77 6f 72 64 73 20 6d 65 61 6e 73 " keywords means 0890: 20 74 6f 0a 70 75 6c 6c 20 74 68 65 20 64 6f 63 to.pull the doc 08a0: 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 20 umentation file 08b0: 66 72 6f 6d 20 74 68 65 20 6c 6f 63 61 6c 20 73 from the local s 08c0: 6f 75 72 63 65 20 74 72 65 65 20 6f 6e 20 64 69 ource tree on di 08d0: 73 6b 2c 20 6e 6f 74 0a 66 72 6f 6d 20 74 68 65 sk, not.from the 08e0: 20 61 6e 79 20 76 65 72 73 69 6f 6e 65 64 20 62 any versioned b 08f0: 61 73 65 6c 69 6e 65 2e 20 20 54 68 65 20 22 3c aseline. The "< 0900: 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 6b 65 79 b>ckout</b>" key 0910: 77 6f 72 64 20 6e 6f 72 6d 61 6c 6c 79 0a 6f 6e word normally.on 0920: 6c 79 20 77 6f 72 6b 73 20 77 68 65 6e 20 79 6f ly works when yo 0930: 75 20 73 74 61 72 74 20 79 6f 75 72 20 73 65 72 u start your ser 0940: 76 65 72 20 75 73 69 6e 67 20 74 68 65 20 22 3c ver using the "< 0950: 62 3e 66 6f 73 73 69 6c 20 73 65 72 76 65 72 3c b>fossil server< 0960: 2f 62 3e 22 0a 6f 72 20 22 3c 62 3e 66 6f 73 73 /b>".or "<b>foss 0970: 69 6c 20 75 69 3c 2f 62 3e 22 0a 63 6f 6d 6d 61 il ui</b>".comma 0980: 6e 64 20 6c 69 6e 65 20 61 6e 64 20 69 73 20 69 nd line and is i 0990: 6e 74 65 6e 74 65 64 20 74 6f 20 73 68 6f 77 20 ntented to show 09a0: 77 68 61 74 20 74 68 65 20 64 6f 63 75 6d 65 6e what the documen 09b0: 74 61 74 69 6f 6e 20 79 6f 75 20 61 72 65 20 63 tation you are c 09c0: 75 72 72 65 6e 74 6c 79 0a 65 64 69 74 69 6e 67 urrently.editing 09d0: 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 62 65 66 6f looks like befo 09e0: 72 65 20 79 6f 75 20 63 68 65 63 6b 20 69 74 20 re you check it 09f0: 69 6e 2e 0a 0a 46 69 6e 61 6c 6c 79 2c 20 74 68 in...Finally, th 0a00: 65 20 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e 61 6d e <i><filenam 0a10: 65 26 67 74 3b 3c 2f 69 3e 20 65 6c 65 6d 65 6e e></i> elemen 0a20: 74 20 6f 66 20 74 68 65 20 55 52 4c 20 69 73 20 t of the URL is 0a30: 74 68 65 20 66 75 6c 6c 0a 70 61 74 68 6e 61 6d the full.pathnam 0a40: 65 20 6f 66 20 74 68 65 20 64 6f 63 75 6d 65 6e e of the documen 0a50: 74 61 74 69 6f 6e 20 66 69 6c 65 20 73 74 61 72 tation file star 0a60: 74 69 6e 67 20 66 72 6f 6d 20 74 68 65 20 72 6f ting from the ro 0a70: 6f 74 20 6f 66 20 74 68 65 20 73 6f 75 72 63 65 ot of the source 0a80: 0a 74 72 65 65 2e 0a 0a 54 68 65 20 6d 69 6d 65 .tree...The mime 0a90: 74 79 70 65 20 28 61 6e 64 20 74 68 75 73 20 74 type (and thus t 0aa0: 68 65 20 72 65 6e 64 65 72 69 6e 67 29 20 6f 66 he rendering) of 0ab0: 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 documentation f 0ac0: 69 6c 65 73 20 69 73 20 0a 64 65 74 65 72 6d 69 iles is .determi 0ad0: 6e 65 64 20 62 79 20 74 68 65 20 66 69 6c 65 20 ned by the file 0ae0: 73 75 66 66 69 78 2e 20 20 46 6f 73 73 69 6c 20 suffix. Fossil 0af0: 63 75 72 72 65 6e 74 6c 79 20 75 6e 64 65 72 73 currently unders 0b00: 74 61 6e 64 73 20 31 39 32 0a 64 69 66 66 65 72 tands 192.differ 0b10: 65 6e 74 20 66 69 6c 65 20 73 75 66 66 69 78 65 ent file suffixe 0b20: 73 2c 20 69 6e 63 6c 75 64 69 6e 67 20 61 6c 6c s, including all 0b30: 20 74 68 65 20 70 6f 70 75 6c 61 72 20 6f 6e 65 the popular one 0b40: 73 20 73 75 63 68 20 61 73 0a 22 2e 63 73 73 22 s such as.".css" 0b50: 2c 20 22 2e 67 69 66 22 2c 20 22 2e 68 74 6d 22 , ".gif", ".htm" 0b60: 2c 20 22 2e 68 74 6d 6c 22 2c 20 22 2e 6a 70 67 , ".html", ".jpg 0b70: 22 2c 20 22 2e 6a 70 65 67 22 2c 20 22 2e 70 6e ", ".jpeg", ".pn 0b80: 67 22 2c 20 61 6e 64 20 22 2e 74 78 74 22 2e 0a g", and ".txt".. 0b90: 0a 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 .Documentation f 0ba0: 69 6c 65 73 20 77 68 6f 73 65 20 6e 61 6d 65 73 iles whose names 0bb0: 20 65 6e 64 20 69 6e 20 22 2e 77 69 6b 69 22 20 end in ".wiki" 0bc0: 75 73 65 20 74 68 65 20 0a 5b 2f 77 69 6b 69 5f use the .[/wiki_ 0bd0: 72 75 6c 65 73 20 7c 20 73 61 6d 65 20 6d 61 72 rules | same mar 0be0: 6b 75 70 20 61 73 20 77 69 6b 69 20 70 61 67 65 kup as wiki page 0bf0: 73 5d 20 2d 0a 61 20 73 61 66 65 20 73 75 62 73 s] -.a safe subs 0c00: 65 74 20 6f 66 20 48 54 4d 4c 20 74 6f 67 65 74 et of HTML toget 0c10: 68 65 72 20 77 69 74 68 20 73 6f 6d 65 20 72 75 her with some ru 0c20: 6c 65 73 20 66 6f 72 20 70 61 72 61 67 72 61 70 les for paragrap 0c30: 68 0a 62 72 65 61 6b 73 2c 20 6c 69 73 74 73 2c h.breaks, lists, 0c40: 20 61 6e 64 20 68 79 70 65 72 6c 69 6e 6b 73 2e and hyperlinks. 0c50: 20 20 54 68 65 20 22 2e 77 69 6b 69 22 20 61 6e The ".wiki" an 0c60: 64 20 22 2e 74 78 74 22 20 70 61 67 65 73 0a 61 d ".txt" pages.a 0c70: 72 65 20 72 65 6e 64 65 72 65 64 20 77 69 74 68 re rendered with 0c80: 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 66 6f the standard fo 0c90: 73 73 69 6c 20 68 65 61 64 65 72 20 61 6e 64 20 ssil header and 0ca0: 66 6f 6f 74 65 72 20 61 64 64 65 64 2e 0a 41 6c footer added..Al 0cb0: 6c 20 6f 74 68 65 72 20 6d 69 6d 65 74 79 70 65 l other mimetype 0cc0: 73 20 61 72 65 20 64 65 6c 69 76 65 72 65 64 20 s are delivered 0cd0: 64 69 72 65 63 74 6c 79 20 74 6f 20 74 68 65 20 directly to the 0ce0: 72 65 71 75 65 73 74 69 6e 67 0a 77 65 62 20 62 requesting.web b 0cf0: 72 6f 77 73 65 72 20 77 69 74 68 6f 75 74 20 69 rowser without i 0d00: 6e 74 65 72 70 72 65 74 61 74 69 6f 6e 2c 20 61 nterpretation, a 0d10: 64 64 69 74 69 6f 6e 73 2c 20 6f 72 20 63 68 61 dditions, or cha 0d20: 6e 67 65 73 2e 0a 0a 3c 68 32 3e 45 78 61 6d 70 nges...<h2>Examp 0d30: 6c 65 73 3c 2f 68 32 3e 0a 0a 54 68 69 73 20 66 les</h2>..This f 0d40: 69 6c 65 20 74 68 61 74 20 79 6f 75 20 61 72 65 ile that you are 0d50: 20 63 75 72 72 65 6e 74 6c 79 20 72 65 61 64 69 currently readi 0d60: 6e 67 20 69 73 20 61 6e 20 65 78 61 6d 70 6c 65 ng is an example 0d70: 20 6f 66 0a 65 6d 62 65 64 64 65 64 20 64 6f 63 of.embedded doc 0d80: 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54 68 65 umentation. The 0d90: 20 6e 61 6d 65 20 6f 66 20 74 68 69 73 20 66 69 name of this fi 0da0: 6c 65 20 69 6e 20 74 68 65 20 66 6f 73 73 69 6c le in the fossil 0db0: 0a 73 6f 75 72 63 65 20 74 72 65 65 20 69 73 20 .source tree is 0dc0: 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 65 64 "<b>www/embedded 0dd0: 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 2e 0a 59 doc.wiki</b>"..Y 0de0: 6f 75 20 61 72 65 20 70 65 72 68 61 70 73 20 6c ou are perhaps l 0df0: 6f 6f 6b 69 6e 67 20 61 74 20 74 68 69 73 0a 66 ooking at this.f 0e00: 69 6c 65 20 75 73 69 6e 67 20 74 68 65 20 55 52 ile using the UR 0e10: 4c 3a 0a 0a 20 20 20 5b 68 74 74 70 3a 2f 2f 77 L:.. [http://w 0e20: 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 ww.fossil-scm.or 0e30: 67 2f 69 6e 64 65 78 2e 68 74 6d 6c 2f 64 6f 63 g/index.html/doc 0e40: 2f 74 69 70 2f 77 77 77 2f 65 6d 62 65 64 64 65 /tip/www/embedde 0e50: 64 64 6f 63 2e 77 69 6b 69 5d 2e 0a 0a 54 68 65 ddoc.wiki]...The 0e60: 20 66 69 72 73 74 20 70 61 72 74 20 6f 66 20 74 first part of t 0e70: 68 69 73 20 70 61 74 68 2c 20 74 68 65 20 22 5b his path, the "[ 0e80: 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 http://www.fossi 0e90: 6c 2d 73 63 6d 2e 6f 72 67 2f 69 6e 64 65 78 2e l-scm.org/index. 0ea0: 68 74 6d 6c 5d 22 2c 0a 69 73 20 74 68 65 20 62 html]",.is the b 0eb0: 61 73 65 20 55 52 4c 2e 20 20 59 6f 75 20 6d 69 ase URL. You mi 0ec0: 67 68 74 20 68 61 76 65 20 6f 72 69 67 69 6e 61 ght have origina 0ed0: 6c 6c 79 20 74 79 70 65 64 3a 0a 5b 68 74 74 70 lly typed:.[http 0ee0: 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 ://www.fossil-sc 0ef0: 6d 2e 6f 72 67 2f 5d 2e 20 20 54 68 65 20 77 65 m.org/]. The we 0f00: 62 20 73 65 72 76 65 72 20 61 74 20 74 68 65 20 b server at the 0f10: 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f www.fossil-scm.o 0f20: 72 67 0a 73 69 74 65 20 61 75 74 6f 6d 61 74 69 rg.site automati 0f30: 63 61 6c 6c 79 20 72 65 64 69 72 65 63 74 73 20 cally redirects 0f40: 73 75 63 68 20 6c 69 6e 6b 73 20 62 79 20 61 70 such links by ap 0f50: 70 65 6e 64 69 6e 67 20 22 69 6e 64 65 78 2e 68 pending "index.h 0f60: 74 6d 6c 22 2e 20 20 54 68 65 0a 22 69 6e 64 65 tml". The."inde 0f70: 78 2e 68 74 6d 6c 22 20 66 69 6c 65 20 6f 6e 20 x.html" file on 0f80: 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f www.fossil-scm.o 0f90: 72 67 20 69 73 20 72 65 61 6c 6c 79 20 61 20 43 rg is really a C 0fa0: 47 49 20 73 63 72 69 70 74 0a 28 64 6f 20 6e 6f GI script.(do no 0fb0: 74 20 62 65 20 6d 69 73 6c 65 61 64 20 62 79 20 t be mislead by 0fc0: 74 68 65 20 6e 61 6d 65 29 20 77 68 69 63 68 20 the name) which 0fd0: 72 75 6e 73 20 74 68 65 20 66 6f 73 73 69 6c 20 runs the fossil 0fe0: 77 65 62 20 73 65 72 76 69 63 65 20 69 6e 0a 43 web service in.C 0ff0: 47 49 20 6d 6f 64 65 2e 20 20 54 68 65 20 22 69 GI mode. The "i 1000: 6e 64 65 78 2e 68 74 6d 6c 22 20 43 47 49 20 73 ndex.html" CGI s 1010: 63 72 69 70 74 20 6c 6f 6f 6b 73 20 6c 69 6b 65 cript looks like 1020: 20 74 68 69 73 3a 0a 0a 3c 62 6c 6f 63 6b 71 75 this:..<blockqu 1030: 6f 74 65 3e 3c 70 72 65 3e 0a 23 21 2f 75 73 72 ote><pre>.#!/usr 1040: 2f 62 69 6e 2f 66 6f 73 73 69 6c 0a 72 65 70 6f /bin/fossil.repo 1050: 73 69 74 6f 72 79 3a 20 2f 66 6f 73 73 69 6c 2f sitory: /fossil/ 1060: 66 6f 73 73 69 6c 2e 66 6f 73 73 69 6c 0a 3c 2f fossil.fossil.</ 1070: 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 pre></blockquote 1080: 3e 0a 0a 54 68 69 73 20 69 73 20 6f 6e 65 20 6f >..This is one o 1090: 66 20 74 68 72 65 65 20 77 61 79 73 20 74 6f 20 f three ways to 10a0: 73 65 74 20 75 70 20 61 20 0a 3c 61 20 68 72 65 set up a .<a hre 10b0: 66 3d 22 71 75 69 63 6b 73 74 61 72 74 2e 77 69 f="quickstart.wi 10c0: 6b 69 23 73 65 72 76 65 72 73 65 74 75 70 22 3e ki#serversetup"> 10d0: 66 6f 73 73 69 6c 20 77 65 62 20 73 65 72 76 65 fossil web serve 10e0: 72 3c 2f 61 3e 2e 0a 0a 54 68 65 20 22 3c 62 3e r</a>...The "<b> 10f0: 2f 74 69 70 2f 3c 2f 62 3e 22 20 70 61 72 74 20 /tip/</b>" part 1100: 6f 66 20 74 68 65 20 55 52 4c 20 74 65 6c 6c 73 of the URL tells 1110: 20 66 6f 73 73 69 6c 20 74 6f 20 75 73 65 0a 74 fossil to use.t 1120: 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e he documentation 1130: 20 66 69 6c 65 73 20 66 72 6f 6d 20 74 68 65 20 files from the 1140: 62 61 73 65 6c 69 6e 65 20 74 68 61 74 20 77 61 baseline that wa 1150: 73 20 63 68 65 63 6b 65 64 20 69 6e 20 6d 6f 73 s checked in mos 1160: 74 0a 72 65 63 65 6e 74 6c 79 2e 20 20 54 68 69 t.recently. Thi 1170: 73 20 66 69 6c 65 20 69 73 20 73 74 6f 72 65 64 s file is stored 1180: 20 69 6e 20 74 68 65 20 66 6f 73 73 69 6c 20 73 in the fossil s 1190: 6f 75 72 63 65 20 74 72 65 65 20 75 6e 64 65 72 ource tree under 11a0: 0a 74 68 65 20 6e 61 6d 65 20 22 3c 62 3e 77 77 .the name "<b>ww 11b0: 77 2f 65 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 w/embeddeddoc.wi 11c0: 6b 69 3c 2f 62 3e 22 20 61 6e 64 20 73 6f 20 74 ki</b>" and so t 11d0: 68 61 74 20 6e 61 6d 65 20 66 6f 72 6d 73 20 74 hat name forms t 11e0: 68 65 0a 6c 61 73 74 20 70 61 72 74 20 6f 66 20 he.last part of 11f0: 74 68 65 20 55 52 4c 2e 0a 0a 41 73 20 49 20 73 the URL...As I s 1200: 69 74 20 77 72 69 74 69 6e 67 20 74 68 69 73 20 it writing this 1210: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 documentation fi 1220: 6c 65 2c 20 49 20 61 6d 20 74 65 73 74 69 6e 67 le, I am testing 1230: 20 6d 79 20 77 6f 72 6b 20 62 79 0a 72 75 6e 6e my work by.runn 1240: 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 6f 73 73 ing the "<b>foss 1250: 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e 22 20 63 il server</b>" c 1260: 6f 6d 6d 61 6e 64 20 6c 69 6e 65 20 61 6e 64 20 ommand line and 1270: 76 69 65 77 69 6e 67 0a 3c 62 3e 68 74 74 70 3a viewing.<b>http: 1280: 2f 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 30 38 30 //localhost:8080 1290: 2f 64 6f 63 2f 63 6b 6f 75 74 2f 77 77 77 2f 65 /doc/ckout/www/e 12a0: 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 3c mbeddeddoc.wiki< 12b0: 2f 62 3e 20 69 6e 0a 46 69 72 65 66 6f 78 2e 20 /b> in.Firefox. 12c0: 20 49 20 61 6d 20 64 6f 69 6e 67 20 74 68 69 73 I am doing this 12d0: 20 65 76 65 6e 20 74 68 6f 75 67 68 20 49 20 68 even though I h 12e0: 61 76 65 20 6e 6f 74 20 79 65 74 20 63 68 65 63 ave not yet chec 12f0: 6b 65 64 20 69 6e 0a 74 68 65 20 22 3c 62 3e 77 ked in.the "<b>w 1300: 77 77 2f 65 6d 62 65 64 64 65 64 64 6f 63 2e 77 ww/embeddeddoc.w 1310: 69 6b 69 3c 2f 62 3e 22 20 66 69 6c 65 20 66 6f iki</b>" file fo 1320: 72 20 74 68 65 20 66 69 72 73 74 20 74 69 6d 65 r the first time 1330: 2e 20 20 55 73 69 6e 67 0a 74 68 65 20 73 70 65 . Using.the spe 1340: 63 69 61 6c 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f cial "<b>ckout</ 1350: 62 3e 22 20 76 65 72 73 69 6f 6e 20 69 64 65 6e b>" version iden 1360: 74 69 66 69 65 72 20 6f 6e 20 74 68 65 20 22 3c tifier on the "< 1370: 62 3e 2f 64 6f 63 3c 2f 62 3e 22 20 70 61 67 65 b>/doc</b>" page 1380: 0a 69 74 20 69 73 20 65 61 73 79 20 74 6f 20 6d .it is easy to m 1390: 61 6b 65 20 6d 75 6c 74 69 70 6c 65 20 63 68 61 ake multiple cha 13a0: 6e 67 65 73 20 74 6f 20 6d 75 6c 74 69 70 6c 65 nges to multiple 13b0: 20 66 69 6c 65 73 20 61 6e 64 20 73 65 65 20 68 files and see h 13c0: 6f 77 20 74 68 65 79 20 61 6c 6c 0a 6c 6f 6f 6b ow they all.look 13d0: 20 74 6f 67 65 74 68 65 72 20 62 65 66 6f 72 65 together before 13e0: 20 63 6f 6d 6d 69 74 74 69 6e 67 20 61 6e 79 74 committing anyt 13f0: 68 69 6e 67 20 74 6f 20 74 68 65 20 72 65 70 6f hing to the repo 1400: 73 69 74 6f 72 79 2e 0a sitory..