Artifact b0c6d5968194fa9b13c2bc7028106154dbfa4309:
File www/embeddeddoc.wiki part of check-in [904ee40b93] - Change "baseline" to "check-in" in the on-line documentation. by drh on 2009-01-23 00:16:26.
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 70 72 65 66 69 78 20 6f 66 20 74 68 65 ue prefix of the 0740: 20 63 68 65 63 6b 2d 69 6e 20 49 44 20 66 6f 72 check-in ID for 0750: 20 0a 74 68 65 20 63 68 65 63 6b 2d 69 6e 20 63 .the check-in c 0760: 6f 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 64 6f ontaining the do 0770: 63 75 6d 65 6e 74 61 74 69 6f 6e 20 79 6f 75 20 cumentation you 0780: 77 61 6e 74 20 74 6f 20 61 63 63 65 73 73 2e 0a want to access.. 0790: 4f 72 20 3c 69 3e 26 6c 74 3b 76 65 72 73 69 6f Or <i><versio 07a0: 6e 26 67 74 3b 3c 2f 69 3e 20 63 61 6e 20 62 65 n></i> can be 07b0: 20 6f 6e 65 20 6f 66 20 74 68 65 20 6b 65 79 77 one of the keyw 07c0: 6f 72 64 73 20 22 3c 62 3e 74 69 70 3c 2f 62 3e ords "<b>tip</b> 07d0: 22 20 6f 72 0a 22 3c 62 3e 63 6b 6f 75 74 3c 2f " or."<b>ckout</ 07e0: 62 3e 22 2e 20 20 54 68 65 20 22 3c 62 3e 74 69 b>". The "<b>ti 07f0: 70 3c 2f 62 3e 22 20 6b 65 79 77 6f 72 64 20 6d p</b>" keyword m 0800: 65 61 6e 73 20 74 6f 20 75 73 65 20 74 68 65 20 eans to use the 0810: 6d 6f 73 74 20 72 65 63 65 6e 74 6c 79 0a 63 68 most recently.ch 0820: 65 63 6b 65 64 2d 69 6e 2e 20 20 54 68 69 73 20 ecked-in. This 0830: 69 73 20 75 73 65 66 75 6c 20 69 66 20 79 6f 75 is useful if you 0840: 20 77 61 6e 74 20 74 6f 20 73 65 65 20 74 68 65 want to see the 0850: 20 76 65 72 79 20 6c 61 74 65 73 74 0a 76 65 72 very latest.ver 0860: 73 69 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 sion of the docu 0870: 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54 68 65 20 mentation. The 0880: 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 6b "<b>ckout</b>" k 0890: 65 79 77 6f 72 64 73 20 6d 65 61 6e 73 20 74 6f eywords means to 08a0: 0a 70 75 6c 6c 20 74 68 65 20 64 6f 63 75 6d 65 .pull the docume 08b0: 6e 74 61 74 69 6f 6e 20 66 69 6c 65 20 66 72 6f ntation file fro 08c0: 6d 20 74 68 65 20 6c 6f 63 61 6c 20 73 6f 75 72 m the local sour 08d0: 63 65 20 74 72 65 65 20 6f 6e 20 64 69 73 6b 2c ce tree on disk, 08e0: 20 6e 6f 74 0a 66 72 6f 6d 20 74 68 65 20 61 6e not.from the an 08f0: 79 20 63 68 65 63 6b 2d 69 6e 2e 20 20 54 68 65 y check-in. The 0900: 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 "<b>ckout</b>" 0910: 6b 65 79 77 6f 72 64 20 6e 6f 72 6d 61 6c 6c 79 keyword normally 0920: 0a 6f 6e 6c 79 20 77 6f 72 6b 73 20 77 68 65 6e .only works when 0930: 20 79 6f 75 20 73 74 61 72 74 20 79 6f 75 72 20 you start your 0940: 73 65 72 76 65 72 20 75 73 69 6e 67 20 74 68 65 server using the 0950: 20 22 3c 62 3e 66 6f 73 73 69 6c 20 73 65 72 76 "<b>fossil serv 0960: 65 72 3c 2f 62 3e 22 0a 6f 72 20 22 3c 62 3e 66 er</b>".or "<b>f 0970: 6f 73 73 69 6c 20 75 69 3c 2f 62 3e 22 0a 63 6f ossil ui</b>".co 0980: 6d 6d 61 6e 64 20 6c 69 6e 65 20 61 6e 64 20 69 mmand line and i 0990: 73 20 69 6e 64 65 6e 74 65 64 20 74 6f 20 73 68 s indented to sh 09a0: 6f 77 20 77 68 61 74 20 74 68 65 20 64 6f 63 75 ow what the docu 09b0: 6d 65 6e 74 61 74 69 6f 6e 20 79 6f 75 20 61 72 mentation you ar 09c0: 65 20 63 75 72 72 65 6e 74 6c 79 0a 65 64 69 74 e currently.edit 09d0: 69 6e 67 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 62 ing looks like b 09e0: 65 66 6f 72 65 20 79 6f 75 20 63 68 65 63 6b 20 efore you check 09f0: 69 74 20 69 6e 2e 0a 0a 46 69 6e 61 6c 6c 79 2c it in...Finally, 0a00: 20 74 68 65 20 3c 69 3e 26 6c 74 3b 66 69 6c 65 the <i><file 0a10: 6e 61 6d 65 26 67 74 3b 3c 2f 69 3e 20 65 6c 65 name></i> ele 0a20: 6d 65 6e 74 20 6f 66 20 74 68 65 20 55 52 4c 20 ment of the URL 0a30: 69 73 20 74 68 65 20 66 75 6c 6c 0a 70 61 74 68 is the full.path 0a40: 6e 61 6d 65 20 6f 66 20 74 68 65 20 64 6f 63 75 name of the docu 0a50: 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 20 73 mentation file s 0a60: 74 61 72 74 69 6e 67 20 66 72 6f 6d 20 74 68 65 tarting from the 0a70: 20 72 6f 6f 74 20 6f 66 20 74 68 65 20 73 6f 75 root of the sou 0a80: 72 63 65 0a 74 72 65 65 2e 0a 0a 54 68 65 20 6d rce.tree...The m 0a90: 69 6d 65 74 79 70 65 20 28 61 6e 64 20 74 68 75 imetype (and thu 0aa0: 73 20 74 68 65 20 72 65 6e 64 65 72 69 6e 67 29 s the rendering) 0ab0: 20 6f 66 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f of documentatio 0ac0: 6e 20 66 69 6c 65 73 20 69 73 20 0a 64 65 74 65 n files is .dete 0ad0: 72 6d 69 6e 65 64 20 62 79 20 74 68 65 20 66 69 rmined by the fi 0ae0: 6c 65 20 73 75 66 66 69 78 2e 20 20 46 6f 73 73 le suffix. Foss 0af0: 69 6c 20 63 75 72 72 65 6e 74 6c 79 20 75 6e 64 il currently und 0b00: 65 72 73 74 61 6e 64 73 20 31 39 32 0a 64 69 66 erstands 192.dif 0b10: 66 65 72 65 6e 74 20 66 69 6c 65 20 73 75 66 66 ferent file suff 0b20: 69 78 65 73 2c 20 69 6e 63 6c 75 64 69 6e 67 20 ixes, including 0b30: 61 6c 6c 20 74 68 65 20 70 6f 70 75 6c 61 72 20 all the popular 0b40: 6f 6e 65 73 20 73 75 63 68 20 61 73 0a 22 2e 63 ones such as.".c 0b50: 73 73 22 2c 20 22 2e 67 69 66 22 2c 20 22 2e 68 ss", ".gif", ".h 0b60: 74 6d 22 2c 20 22 2e 68 74 6d 6c 22 2c 20 22 2e tm", ".html", ". 0b70: 6a 70 67 22 2c 20 22 2e 6a 70 65 67 22 2c 20 22 jpg", ".jpeg", " 0b80: 2e 70 6e 67 22 2c 20 61 6e 64 20 22 2e 74 78 74 .png", and ".txt 0b90: 22 2e 0a 0a 44 6f 63 75 6d 65 6e 74 61 74 69 6f "...Documentatio 0ba0: 6e 20 66 69 6c 65 73 20 77 68 6f 73 65 20 6e 61 n files whose na 0bb0: 6d 65 73 20 65 6e 64 20 69 6e 20 22 2e 77 69 6b mes end in ".wik 0bc0: 69 22 20 75 73 65 20 74 68 65 20 0a 5b 2f 77 69 i" use the .[/wi 0bd0: 6b 69 5f 72 75 6c 65 73 20 7c 20 73 61 6d 65 20 ki_rules | same 0be0: 6d 61 72 6b 75 70 20 61 73 20 77 69 6b 69 20 70 markup as wiki p 0bf0: 61 67 65 73 5d 20 2d 0a 61 20 73 61 66 65 20 73 ages] -.a safe s 0c00: 75 62 73 65 74 20 6f 66 20 48 54 4d 4c 20 74 6f ubset of HTML to 0c10: 67 65 74 68 65 72 20 77 69 74 68 20 73 6f 6d 65 gether with some 0c20: 20 72 75 6c 65 73 20 66 6f 72 20 70 61 72 61 67 rules for parag 0c30: 72 61 70 68 0a 62 72 65 61 6b 73 2c 20 6c 69 73 raph.breaks, lis 0c40: 74 73 2c 20 61 6e 64 20 68 79 70 65 72 6c 69 6e ts, and hyperlin 0c50: 6b 73 2e 20 20 54 68 65 20 22 2e 77 69 6b 69 22 ks. The ".wiki" 0c60: 20 61 6e 64 20 22 2e 74 78 74 22 20 70 61 67 65 and ".txt" page 0c70: 73 0a 61 72 65 20 72 65 6e 64 65 72 65 64 20 77 s.are rendered w 0c80: 69 74 68 20 74 68 65 20 73 74 61 6e 64 61 72 64 ith the standard 0c90: 20 66 6f 73 73 69 6c 20 68 65 61 64 65 72 20 61 fossil header a 0ca0: 6e 64 20 66 6f 6f 74 65 72 20 61 64 64 65 64 2e nd footer added. 0cb0: 0a 41 6c 6c 20 6f 74 68 65 72 20 6d 69 6d 65 74 .All other mimet 0cc0: 79 70 65 73 20 61 72 65 20 64 65 6c 69 76 65 72 ypes are deliver 0cd0: 65 64 20 64 69 72 65 63 74 6c 79 20 74 6f 20 74 ed directly to t 0ce0: 68 65 20 72 65 71 75 65 73 74 69 6e 67 0a 77 65 he requesting.we 0cf0: 62 20 62 72 6f 77 73 65 72 20 77 69 74 68 6f 75 b browser withou 0d00: 74 20 69 6e 74 65 72 70 72 65 74 61 74 69 6f 6e t interpretation 0d10: 2c 20 61 64 64 69 74 69 6f 6e 73 2c 20 6f 72 20 , additions, or 0d20: 63 68 61 6e 67 65 73 2e 0a 0a 3c 68 32 3e 45 78 changes...<h2>Ex 0d30: 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a 54 68 69 amples</h2>..Thi 0d40: 73 20 66 69 6c 65 20 74 68 61 74 20 79 6f 75 20 s file that you 0d50: 61 72 65 20 63 75 72 72 65 6e 74 6c 79 20 72 65 are currently re 0d60: 61 64 69 6e 67 20 69 73 20 61 6e 20 65 78 61 6d ading is an exam 0d70: 70 6c 65 20 6f 66 0a 65 6d 62 65 64 64 65 64 20 ple of.embedded 0d80: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 documentation. 0d90: 54 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 69 73 The name of this 0da0: 20 66 69 6c 65 20 69 6e 20 74 68 65 20 66 6f 73 file in the fos 0db0: 73 69 6c 0a 73 6f 75 72 63 65 20 74 72 65 65 20 sil.source tree 0dc0: 69 73 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 is "<b>www/embed 0dd0: 64 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 deddoc.wiki</b>" 0de0: 2e 0a 59 6f 75 20 61 72 65 20 70 65 72 68 61 70 ..You are perhap 0df0: 73 20 6c 6f 6f 6b 69 6e 67 20 61 74 20 74 68 69 s looking at thi 0e00: 73 0a 66 69 6c 65 20 75 73 69 6e 67 20 74 68 65 s.file using the 0e10: 20 55 52 4c 3a 0a 0a 20 20 20 5b 68 74 74 70 3a URL:.. [http: 0e20: 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d //www.fossil-scm 0e30: 2e 6f 72 67 2f 69 6e 64 65 78 2e 68 74 6d 6c 2f .org/index.html/ 0e40: 64 6f 63 2f 74 69 70 2f 77 77 77 2f 65 6d 62 65 doc/tip/www/embe 0e50: 64 64 65 64 64 6f 63 2e 77 69 6b 69 5d 2e 0a 0a ddeddoc.wiki]... 0e60: 54 68 65 20 66 69 72 73 74 20 70 61 72 74 20 6f The first part o 0e70: 66 20 74 68 69 73 20 70 61 74 68 2c 20 74 68 65 f this path, the 0e80: 20 22 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f "[http://www.fo 0e90: 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 69 6e 64 ssil-scm.org/ind 0ea0: 65 78 2e 68 74 6d 6c 5d 22 2c 0a 69 73 20 74 68 ex.html]",.is th 0eb0: 65 20 62 61 73 65 20 55 52 4c 2e 20 20 59 6f 75 e base URL. You 0ec0: 20 6d 69 67 68 74 20 68 61 76 65 20 6f 72 69 67 might have orig 0ed0: 69 6e 61 6c 6c 79 20 74 79 70 65 64 3a 0a 5b 68 inally typed:.[h 0ee0: 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c ttp://www.fossil 0ef0: 2d 73 63 6d 2e 6f 72 67 2f 5d 2e 20 20 54 68 65 -scm.org/]. The 0f00: 20 77 65 62 20 73 65 72 76 65 72 20 61 74 20 74 web server at t 0f10: 68 65 20 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 he www.fossil-sc 0f20: 6d 2e 6f 72 67 0a 73 69 74 65 20 61 75 74 6f 6d m.org.site autom 0f30: 61 74 69 63 61 6c 6c 79 20 72 65 64 69 72 65 63 atically redirec 0f40: 74 73 20 73 75 63 68 20 6c 69 6e 6b 73 20 62 79 ts such links by 0f50: 20 61 70 70 65 6e 64 69 6e 67 20 22 69 6e 64 65 appending "inde 0f60: 78 2e 68 74 6d 6c 22 2e 20 20 54 68 65 0a 22 69 x.html". The."i 0f70: 6e 64 65 78 2e 68 74 6d 6c 22 20 66 69 6c 65 20 ndex.html" file 0f80: 6f 6e 20 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 on www.fossil-sc 0f90: 6d 2e 6f 72 67 20 69 73 20 72 65 61 6c 6c 79 20 m.org is really 0fa0: 61 20 43 47 49 20 73 63 72 69 70 74 0a 28 64 6f a CGI script.(do 0fb0: 20 6e 6f 74 20 62 65 20 6d 69 73 6c 65 61 64 20 not be mislead 0fc0: 62 79 20 74 68 65 20 6e 61 6d 65 29 20 77 68 69 by the name) whi 0fd0: 63 68 20 72 75 6e 73 20 74 68 65 20 66 6f 73 73 ch runs the foss 0fe0: 69 6c 20 77 65 62 20 73 65 72 76 69 63 65 20 69 il web service i 0ff0: 6e 0a 43 47 49 20 6d 6f 64 65 2e 20 20 54 68 65 n.CGI mode. The 1000: 20 22 69 6e 64 65 78 2e 68 74 6d 6c 22 20 43 47 "index.html" CG 1010: 49 20 73 63 72 69 70 74 20 6c 6f 6f 6b 73 20 6c I script looks l 1020: 69 6b 65 20 74 68 69 73 3a 0a 0a 3c 62 6c 6f 63 ike this:..<bloc 1030: 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 23 21 2f kquote><pre>.#!/ 1040: 75 73 72 2f 62 69 6e 2f 66 6f 73 73 69 6c 0a 72 usr/bin/fossil.r 1050: 65 70 6f 73 69 74 6f 72 79 3a 20 2f 66 6f 73 73 epository: /foss 1060: 69 6c 2f 66 6f 73 73 69 6c 2e 66 6f 73 73 69 6c il/fossil.fossil 1070: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 .</pre></blockqu 1080: 6f 74 65 3e 0a 0a 54 68 69 73 20 69 73 20 6f 6e ote>..This is on 1090: 65 20 6f 66 20 74 68 72 65 65 20 77 61 79 73 20 e of three ways 10a0: 74 6f 20 73 65 74 20 75 70 20 61 20 0a 3c 61 20 to set up a .<a 10b0: 68 72 65 66 3d 22 71 75 69 63 6b 73 74 61 72 74 href="quickstart 10c0: 2e 77 69 6b 69 23 73 65 72 76 65 72 73 65 74 75 .wiki#serversetu 10d0: 70 22 3e 66 6f 73 73 69 6c 20 77 65 62 20 73 65 p">fossil web se 10e0: 72 76 65 72 3c 2f 61 3e 2e 0a 0a 54 68 65 20 22 rver</a>...The " 10f0: 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22 20 70 61 <b>/tip/</b>" pa 1100: 72 74 20 6f 66 20 74 68 65 20 55 52 4c 20 74 65 rt of the URL te 1110: 6c 6c 73 20 66 6f 73 73 69 6c 20 74 6f 20 75 73 lls fossil to us 1120: 65 0a 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 e.the documentat 1130: 69 6f 6e 20 66 69 6c 65 73 20 66 72 6f 6d 20 74 ion files from t 1140: 68 65 20 63 68 65 63 6b 2d 69 6e 20 74 68 61 74 he check-in that 1150: 20 77 61 73 20 63 68 65 63 6b 65 64 20 69 6e 20 was checked in 1160: 6d 6f 73 74 0a 72 65 63 65 6e 74 6c 79 2e 20 20 most.recently. 1170: 54 68 69 73 20 66 69 6c 65 20 69 73 20 73 74 6f This file is sto 1180: 72 65 64 20 69 6e 20 74 68 65 20 66 6f 73 73 69 red in the fossi 1190: 6c 20 73 6f 75 72 63 65 20 74 72 65 65 20 75 6e l source tree un 11a0: 64 65 72 0a 74 68 65 20 6e 61 6d 65 20 22 3c 62 der.the name "<b 11b0: 3e 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f 63 >www/embeddeddoc 11c0: 2e 77 69 6b 69 3c 2f 62 3e 22 20 61 6e 64 20 73 .wiki</b>" and s 11d0: 6f 20 74 68 61 74 20 6e 61 6d 65 20 66 6f 72 6d o that name form 11e0: 73 20 74 68 65 0a 6c 61 73 74 20 70 61 72 74 20 s the.last part 11f0: 6f 66 20 74 68 65 20 55 52 4c 2e 0a 0a 41 73 20 of the URL...As 1200: 49 20 73 69 74 20 77 72 69 74 69 6e 67 20 74 68 I sit writing th 1210: 69 73 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e is documentation 1220: 20 66 69 6c 65 2c 20 49 20 61 6d 20 74 65 73 74 file, I am test 1230: 69 6e 67 20 6d 79 20 77 6f 72 6b 20 62 79 0a 72 ing my work by.r 1240: 75 6e 6e 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 unning the "<b>f 1250: 6f 73 73 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e ossil server</b> 1260: 22 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 20 61 " command line a 1270: 6e 64 20 76 69 65 77 69 6e 67 0a 3c 62 3e 68 74 nd viewing.<b>ht 1280: 74 70 3a 2f 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 tp://localhost:8 1290: 30 38 30 2f 64 6f 63 2f 63 6b 6f 75 74 2f 77 77 080/doc/ckout/ww 12a0: 77 2f 65 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 w/embeddeddoc.wi 12b0: 6b 69 3c 2f 62 3e 20 69 6e 0a 46 69 72 65 66 6f ki</b> in.Firefo 12c0: 78 2e 20 20 49 20 61 6d 20 64 6f 69 6e 67 20 74 x. I am doing t 12d0: 68 69 73 20 65 76 65 6e 20 74 68 6f 75 67 68 20 his even though 12e0: 49 20 68 61 76 65 20 6e 6f 74 20 79 65 74 20 63 I have not yet c 12f0: 68 65 63 6b 65 64 20 69 6e 0a 74 68 65 20 22 3c hecked in.the "< 1300: 62 3e 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f b>www/embeddeddo 1310: 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 66 69 6c 65 c.wiki</b>" file 1320: 20 66 6f 72 20 74 68 65 20 66 69 72 73 74 20 74 for the first t 1330: 69 6d 65 2e 20 20 55 73 69 6e 67 0a 74 68 65 20 ime. Using.the 1340: 73 70 65 63 69 61 6c 20 22 3c 62 3e 63 6b 6f 75 special "<b>ckou 1350: 74 3c 2f 62 3e 22 20 76 65 72 73 69 6f 6e 20 69 t</b>" version i 1360: 64 65 6e 74 69 66 69 65 72 20 6f 6e 20 74 68 65 dentifier on the 1370: 20 22 3c 62 3e 2f 64 6f 63 3c 2f 62 3e 22 20 70 "<b>/doc</b>" p 1380: 61 67 65 0a 69 74 20 69 73 20 65 61 73 79 20 74 age.it is easy t 1390: 6f 20 6d 61 6b 65 20 6d 75 6c 74 69 70 6c 65 20 o make multiple 13a0: 63 68 61 6e 67 65 73 20 74 6f 20 6d 75 6c 74 69 changes to multi 13b0: 70 6c 65 20 66 69 6c 65 73 20 61 6e 64 20 73 65 ple files and se 13c0: 65 20 68 6f 77 20 74 68 65 79 20 61 6c 6c 0a 6c e how they all.l 13d0: 6f 6f 6b 20 74 6f 67 65 74 68 65 72 20 62 65 66 ook together bef 13e0: 6f 72 65 20 63 6f 6d 6d 69 74 74 69 6e 67 20 61 ore committing a 13f0: 6e 79 74 68 69 6e 67 20 74 6f 20 74 68 65 20 72 nything to the r 1400: 65 70 6f 73 69 74 6f 72 79 2e 0a epository..