Artifact f88b184a333b7171411afbbe66576ac22100389a:
File www/embeddeddoc.wiki part of check-in [8d8a41d195] - Documentation updates. by drh on 2008-07-15 13:46:00.
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 5b 2f 77 69 6b 69 20 7c 20 77 69 6b -in [/wiki | wik 0050: 69 5d 20 74 68 61 74 20 63 61 6e 20 62 65 20 75 i] that can be u 0060: 73 65 64 20 74 6f 20 73 74 6f 72 65 20 74 68 65 sed to store the 0070: 0a 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 .documentation f 0080: 6f 72 20 61 20 70 72 6f 6a 65 63 74 2e 20 20 54 or a project. T 0090: 68 69 73 20 69 73 20 73 75 66 66 69 63 69 65 6e his is sufficien 00a0: 74 20 66 6f 72 20 6d 61 6e 79 20 70 72 6f 6a 65 t for many proje 00b0: 63 74 73 2e 0a 49 66 20 79 6f 75 72 20 70 72 6f cts..If your pro 00c0: 6a 65 63 74 20 69 73 20 77 65 6c 6c 2d 73 65 72 ject is well-ser 00d0: 76 65 64 20 62 79 20 77 69 6b 69 20 64 6f 63 75 ved by wiki docu 00e0: 6d 65 6e 74 61 74 69 6f 6e 2c 20 74 68 65 6e 20 mentation, then 00f0: 79 6f 75 0a 6e 65 65 64 20 72 65 61 64 20 6e 6f you.need read no 0100: 20 66 75 72 74 68 65 72 2e 0a 0a 42 75 74 20 66 further...But f 0110: 6f 73 73 69 6c 20 61 6c 73 6f 20 73 75 70 70 6f ossil also suppo 0120: 72 74 73 20 65 6d 62 65 64 64 69 6e 67 20 70 72 rts embedding pr 0130: 6f 6a 65 63 74 20 64 6f 63 75 6d 65 6e 74 61 74 oject documentat 0140: 69 6f 6e 20 61 73 0a 66 69 6c 65 73 20 69 6e 20 ion as.files in 0150: 74 68 65 20 73 6f 75 72 63 65 20 74 72 65 65 2e the source tree. 0160: 20 20 54 68 65 72 65 20 61 72 65 20 73 65 76 65 There are seve 0170: 72 61 6c 20 70 6f 74 65 6e 74 69 61 6c 20 61 64 ral potential ad 0180: 76 61 6e 74 61 67 65 73 0a 74 6f 20 74 68 69 73 vantages.to this 0190: 20 61 70 70 72 6f 61 63 68 3a 0a 0a 20 20 31 2e approach:.. 1. 01a0: 20 20 54 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 The documentat 01b0: 69 6f 6e 20 66 69 6c 65 73 20 61 72 65 20 76 65 ion files are ve 01c0: 72 73 69 6f 6e 65 64 20 74 6f 67 65 74 68 65 72 rsioned together 01d0: 20 77 69 74 68 20 74 68 65 0a 20 20 20 20 20 20 with the. 01e0: 73 6f 75 72 63 65 20 63 6f 64 65 20 66 69 6c 65 source code file 01f0: 73 20 73 6f 20 69 74 20 69 73 20 61 6c 77 61 79 s so it is alway 0200: 73 20 63 6c 65 61 72 20 77 68 61 74 20 76 65 72 s clear what ver 0210: 73 69 6f 6e 20 6f 66 0a 20 20 20 20 20 20 74 68 sion of. th 0220: 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 e documentation 0230: 67 6f 65 73 20 77 69 74 68 20 61 20 70 61 72 74 goes with a part 0240: 69 63 75 6c 61 72 20 72 65 6c 65 61 73 65 2e 0a icular release.. 0250: 0a 20 20 32 2e 20 20 54 68 65 20 64 6f 63 75 6d . 2. The docum 0260: 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 63 entation files c 0270: 61 6e 20 62 65 20 65 64 69 74 65 64 20 75 73 69 an be edited usi 0280: 6e 67 20 79 6f 75 72 20 66 61 76 6f 72 69 74 65 ng your favorite 0290: 0a 20 20 20 20 20 20 74 65 78 74 20 65 64 69 74 . text edit 02a0: 6f 72 20 69 6e 73 74 65 61 64 20 6f 66 20 68 61 or instead of ha 02b0: 76 69 6e 67 20 74 6f 20 75 73 65 20 74 68 65 20 ving to use the 02c0: 77 65 62 2d 62 61 73 65 64 20 77 69 6b 69 0a 20 web-based wiki. 02d0: 20 20 20 20 20 65 64 69 74 6f 72 2e 0a 0a 20 20 editor... 02e0: 33 2e 20 20 4f 6e 6c 79 20 70 65 6f 70 6c 65 20 3. Only people 02f0: 77 69 74 68 20 63 68 65 63 6b 2d 69 6e 20 70 72 with check-in pr 0300: 69 76 69 6c 65 67 65 73 20 63 61 6e 20 6d 6f 64 ivileges can mod 0310: 69 66 79 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 ify the document 0320: 61 74 69 6f 6e 2e 0a 20 20 20 20 20 20 28 54 68 ation.. (Th 0330: 69 73 20 6d 69 67 68 74 20 62 65 20 65 69 74 68 is might be eith 0340: 65 72 20 61 6e 20 61 64 76 61 6e 74 61 67 65 20 er an advantage 0350: 6f 72 20 64 69 73 61 64 76 61 6e 74 61 67 65 2c or disadvantage, 0360: 20 64 65 70 65 6e 64 69 6e 67 0a 20 20 20 20 20 depending. 0370: 20 6f 6e 20 74 68 65 20 6e 61 74 75 72 65 20 6f on the nature o 0380: 66 20 79 6f 75 72 20 70 72 6f 6a 65 63 74 2e 29 f your project.) 0390: 0a 0a 57 65 20 77 69 6c 6c 20 63 61 6c 6c 20 64 ..We will call d 03a0: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 74 68 61 ocumentation tha 03b0: 74 20 69 73 20 69 6e 63 6c 75 64 65 64 20 61 73 t is included as 03c0: 20 66 69 6c 65 73 20 69 6e 20 74 68 65 20 73 6f files in the so 03d0: 75 72 63 65 20 74 72 65 65 0a 22 65 6d 62 65 64 urce tree."embed 03e0: 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f ded documentatio 03f0: 6e 22 2e 0a 0a 3c 68 32 3e 46 6f 73 73 69 6c 20 n"...<h2>Fossil 0400: 53 75 70 70 6f 72 74 20 46 6f 72 20 45 6d 62 65 Support For Embe 0410: 64 64 65 64 20 44 6f 63 75 6d 65 6e 74 61 74 69 dded Documentati 0420: 6f 6e 3c 2f 68 32 3e 0a 0a 54 68 65 20 66 6f 73 on</h2>..The fos 0430: 73 69 6c 20 77 65 62 20 69 6e 74 65 72 66 61 63 sil web interfac 0440: 65 20 73 75 70 70 6f 72 74 73 20 65 6d 62 65 64 e supports embed 0450: 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f ded documentatio 0460: 6e 20 75 73 69 6e 67 0a 74 68 65 20 22 2f 64 6f n using.the "/do 0470: 63 22 20 70 61 67 65 2e 20 20 54 6f 20 61 63 63 c" page. To acc 0480: 65 73 73 20 65 6d 62 65 64 64 65 64 20 64 6f 63 ess embedded doc 0490: 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 6f 6e 65 20 umentation, one 04a0: 70 6f 69 6e 74 73 0a 61 20 77 65 62 20 62 72 6f points.a web bro 04b0: 77 73 65 72 20 74 6f 20 61 20 66 6f 73 73 69 6c wser to a fossil 04c0: 20 55 52 4c 20 6f 66 20 74 68 65 20 66 6f 6c 6c URL of the foll 04d0: 6f 77 69 6e 67 20 66 6f 72 6d 3a 0a 0a 3c 62 6c owing form:..<bl 04e0: 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e 26 6c 74 ockquote>.<i>< 04f0: 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 3e ;baseurl></i> 0500: 3c 62 69 67 3e 3c 62 3e 2f 64 6f 63 2f 3c 2f 62 <big><b>/doc/</b 0510: 3e 3c 2f 62 69 67 3e 3c 69 3e 26 6c 74 3b 76 65 ></big><i><ve 0520: 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e 3c 62 69 rsion></i><bi 0530: 67 3e 3c 62 3e 2f 3c 2f 62 3e 3c 2f 62 69 67 3e g><b>/</b></big> 0540: 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e 61 6d 65 26 <i><filename& 0550: 67 74 3b 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 gt;</i>.</blockq 0560: 75 6f 74 65 3e 0a 0a 54 68 65 20 3c 69 3e 26 6c uote>..The <i>&l 0570: 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 t;baseurl></i 0580: 3e 20 69 73 20 74 68 65 20 6d 61 69 6e 20 55 52 > is the main UR 0590: 4c 20 75 73 65 64 20 74 6f 20 61 63 63 65 73 73 L used to access 05a0: 20 74 68 65 20 66 6f 73 73 69 6c 20 77 65 62 20 the fossil web 05b0: 73 65 72 76 65 72 2e 0a 46 6f 72 20 65 78 61 6d server..For exam 05c0: 70 6c 65 2c 20 74 68 65 20 3c 69 3e 26 6c 74 3b ple, the <i>< 05d0: 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 3e 20 baseurl></i> 05e0: 66 6f 72 20 74 68 65 20 66 6f 73 73 69 6c 20 70 for the fossil p 05f0: 72 6f 6a 65 63 74 20 69 74 73 65 6c 66 20 69 73 roject itself is 0600: 0a 65 69 74 68 65 72 20 3c 62 3e 68 74 74 70 3a .either <b>http: 0610: 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d //www.fossil-scm 0620: 2e 6f 72 67 2f 66 6f 73 73 69 6c 3c 2f 62 3e 20 .org/fossil</b> 0630: 6f 72 0a 3c 62 3e 68 74 74 70 3a 2f 2f 77 77 77 or.<b>http://www 0640: 2e 68 77 61 63 69 2e 63 6f 6d 2f 63 67 69 2d 62 .hwaci.com/cgi-b 0650: 69 6e 2f 66 6f 73 73 69 6c 3c 2f 62 3e 2e 0a 49 in/fossil</b>..I 0660: 66 20 79 6f 75 20 6c 61 75 6e 63 68 20 74 68 65 f you launch the 0670: 20 77 65 62 20 73 65 72 76 65 72 20 75 73 69 6e web server usin 0680: 67 20 74 68 65 20 22 3c 62 3e 66 6f 73 73 69 6c g the "<b>fossil 0690: 20 73 65 72 76 65 72 3c 2f 62 3e 22 20 63 6f 6d server</b>" com 06a0: 6d 61 6e 64 20 6c 69 6e 65 2c 0a 74 68 65 6e 20 mand line,.then 06b0: 74 68 65 20 3c 69 3e 26 6c 74 3b 62 61 73 65 75 the <i><baseu 06c0: 72 6c 26 67 74 3b 3c 2f 69 3e 20 69 73 20 75 73 rl></i> is us 06d0: 75 61 6c 6c 79 0a 3c 62 3e 68 74 74 70 3a 2f 2f ually.<b>http:// 06e0: 6c 6f 63 61 6c 68 6f 73 74 3a 38 30 38 30 2f 3c localhost:8080/< 06f0: 2f 62 3e 2e 0a 0a 54 68 65 20 3c 69 3e 26 6c 74 /b>...The <i>< 0700: 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e ;version></i> 0710: 20 69 73 20 61 6e 79 20 75 6e 69 71 75 65 20 55 is any unique U 0720: 55 49 44 20 70 72 65 66 69 78 20 6f 66 20 74 68 UID prefix of th 0730: 65 20 62 61 73 65 6c 69 6e 65 20 0a 66 6f 72 20 e baseline .for 0740: 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f the documentatio 0750: 6e 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 61 63 n you want to ac 0760: 63 65 73 73 2e 0a 4f 72 20 3c 69 3e 26 6c 74 3b cess..Or <i>< 0770: 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e 20 version></i> 0780: 63 61 6e 20 62 65 20 6f 6e 65 20 6f 66 20 74 68 can be one of th 0790: 65 20 6b 65 79 77 6f 72 64 73 20 22 3c 62 3e 74 e keywords "<b>t 07a0: 69 70 3c 2f 62 3e 22 20 6f 72 0a 22 3c 62 3e 63 ip</b>" or."<b>c 07b0: 6b 6f 75 74 3c 2f 62 3e 22 2e 20 20 54 68 65 20 kout</b>". The 07c0: 22 3c 62 3e 74 69 70 3c 2f 62 3e 22 20 6b 65 79 "<b>tip</b>" key 07d0: 77 6f 72 64 20 6d 65 61 6e 73 20 74 6f 20 75 73 word means to us 07e0: 65 20 74 68 65 20 6d 6f 73 74 20 72 65 63 65 6e e the most recen 07f0: 74 6c 79 0a 63 68 65 63 6b 65 64 2d 69 6e 20 62 tly.checked-in b 0800: 61 73 65 6c 69 6e 65 2e 20 20 54 68 69 73 20 69 aseline. This i 0810: 73 20 75 73 65 66 75 6c 20 69 66 20 79 6f 75 20 s useful if you 0820: 77 61 6e 74 20 74 6f 20 73 65 65 20 74 68 65 20 want to see the 0830: 76 65 72 79 20 6c 61 74 65 73 74 0a 76 65 72 73 very latest.vers 0840: 69 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d ion of the docum 0850: 65 6e 74 61 74 69 6f 6e 2e 20 20 54 68 65 20 22 entation. The " 0860: 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 6b 65 <b>ckout</b>" ke 0870: 79 77 6f 72 64 73 20 6d 65 61 6e 73 20 74 6f 0a ywords means to. 0880: 70 75 6c 6c 20 74 68 65 20 64 6f 63 75 6d 65 6e pull the documen 0890: 74 61 74 69 6f 6e 20 66 69 6c 65 20 66 72 6f 6d tation file from 08a0: 20 74 68 65 20 6c 6f 63 61 6c 20 73 6f 75 72 63 the local sourc 08b0: 65 20 74 72 65 65 20 6f 6e 20 64 69 73 6b 2c 20 e tree on disk, 08c0: 6e 6f 74 0a 66 72 6f 6d 20 74 68 65 20 61 6e 79 not.from the any 08d0: 20 76 65 72 73 69 6f 6e 65 64 20 62 61 73 65 6c versioned basel 08e0: 69 6e 65 2e 20 20 54 68 65 20 22 3c 62 3e 63 6b ine. The "<b>ck 08f0: 6f 75 74 3c 2f 62 3e 22 20 6b 65 79 77 6f 72 64 out</b>" keyword 0900: 20 6e 6f 72 6d 61 6c 6c 79 0a 6f 6e 6c 79 20 77 normally.only w 0910: 6f 72 6b 73 20 77 68 65 6e 20 79 6f 75 20 73 74 orks when you st 0920: 61 72 74 20 79 6f 75 72 20 73 65 72 76 65 72 20 art your server 0930: 75 73 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 6f using the "<b>fo 0940: 73 73 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e 22 ssil server</b>" 0950: 0a 6f 72 20 22 3c 62 3e 66 6f 73 73 69 6c 20 75 .or "<b>fossil u 0960: 69 3c 2f 62 3e 22 0a 63 6f 6d 6d 61 6e 64 20 6c i</b>".command l 0970: 69 6e 65 20 61 6e 64 20 69 73 20 69 6e 74 65 6e ine and is inten 0980: 74 65 64 20 74 6f 20 73 68 6f 77 20 77 68 61 74 ted to show what 0990: 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 the documentati 09a0: 6f 6e 20 79 6f 75 20 61 72 65 20 63 75 72 72 65 on you are curre 09b0: 6e 74 6c 79 0a 65 64 69 74 69 6e 67 20 6c 6f 6f ntly.editing loo 09c0: 6b 73 20 6c 69 6b 65 20 62 65 66 6f 72 65 20 79 ks like before y 09d0: 6f 75 20 63 68 65 63 6b 20 69 74 20 69 6e 2e 0a ou check it in.. 09e0: 0a 46 69 6e 61 6c 6c 79 2c 20 74 68 65 20 3c 69 .Finally, the <i 09f0: 3e 26 6c 74 3b 66 69 6c 65 6e 61 6d 65 26 67 74 ><filename> 0a00: 3b 3c 2f 69 3e 20 65 6c 65 6d 65 6e 74 20 6f 66 ;</i> element of 0a10: 20 74 68 65 20 55 52 4c 20 69 73 20 74 68 65 20 the URL is the 0a20: 66 75 6c 6c 0a 70 61 74 68 6e 61 6d 65 20 6f 66 full.pathname of 0a30: 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 the documentati 0a40: 6f 6e 20 66 69 6c 65 20 73 74 61 72 74 69 6e 67 on file starting 0a50: 20 66 72 6f 6d 20 74 68 65 20 72 6f 6f 74 20 6f from the root o 0a60: 66 20 74 68 65 20 73 6f 75 72 63 65 0a 74 72 65 f the source.tre 0a70: 65 2e 0a 0a 54 68 65 20 6d 69 6d 65 74 79 70 65 e...The mimetype 0a80: 20 28 61 6e 64 20 74 68 75 73 20 74 68 65 20 72 (and thus the r 0a90: 65 6e 64 65 72 69 6e 67 29 20 6f 66 20 64 6f 63 endering) of doc 0aa0: 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 73 umentation files 0ab0: 20 69 73 20 0a 64 65 74 65 72 6d 69 6e 65 64 20 is .determined 0ac0: 62 79 20 74 68 65 20 66 69 6c 65 20 73 75 66 66 by the file suff 0ad0: 69 78 2e 20 20 46 6f 73 73 69 6c 20 63 75 72 72 ix. Fossil curr 0ae0: 65 6e 74 6c 79 20 75 6e 64 65 72 73 74 61 6e 64 ently understand 0af0: 73 20 74 68 65 0a 66 6f 6c 6c 6f 77 69 6e 67 20 s the.following 0b00: 66 69 6c 65 20 73 75 66 66 69 78 65 73 20 6f 72 file suffixes or 0b10: 20 65 6d 62 65 64 64 65 64 20 64 6f 63 75 6d 65 embedded docume 0b20: 6e 74 73 3a 0a 0a 20 20 2a 20 20 2e 63 73 73 0a nts:.. * .css. 0b30: 20 20 2a 20 20 2e 67 69 66 0a 20 20 2a 20 20 2e * .gif. * . 0b40: 68 74 6d 0a 20 20 2a 20 20 2e 68 74 6d 6c 0a 20 htm. * .html. 0b50: 20 2a 20 20 2e 6a 70 67 0a 20 20 2a 20 20 2e 6a * .jpg. * .j 0b60: 70 65 67 0a 20 20 2a 20 20 2e 70 6e 67 0a 20 20 peg. * .png. 0b70: 2a 20 20 2e 74 78 74 0a 20 20 2a 20 20 2e 77 69 * .txt. * .wi 0b80: 6b 69 0a 0a 44 6f 63 75 6d 65 6e 74 61 74 69 6f ki..Documentatio 0b90: 6e 20 66 69 6c 65 73 20 77 68 6f 73 65 20 6e 61 n files whose na 0ba0: 6d 65 73 20 65 6e 64 20 69 6e 20 22 2e 77 69 6b mes end in ".wik 0bb0: 69 22 20 75 73 65 20 74 68 65 20 0a 5b 2f 77 69 i" use the .[/wi 0bc0: 6b 69 5f 72 75 6c 65 73 20 7c 20 73 61 6d 65 20 ki_rules | same 0bd0: 6d 61 72 6b 75 70 20 61 73 20 77 69 6b 69 20 70 markup as wiki p 0be0: 61 67 65 73 5d 20 2d 0a 61 20 73 61 66 65 20 73 ages] -.a safe s 0bf0: 75 62 73 65 74 20 6f 66 20 48 54 4d 4c 20 74 6f ubset of HTML to 0c00: 67 65 74 68 65 72 20 77 69 74 68 20 73 6f 6d 65 gether with some 0c10: 20 72 75 6c 65 73 20 66 6f 72 20 70 61 72 61 67 rules for parag 0c20: 72 61 70 68 0a 62 72 65 61 6b 73 2c 20 6c 69 73 raph.breaks, lis 0c30: 74 73 2c 20 61 6e 64 20 68 79 70 65 72 6c 69 6e ts, and hyperlin 0c40: 6b 73 2e 20 20 54 68 65 20 22 2e 77 69 6b 69 22 ks. The ".wiki" 0c50: 20 61 6e 64 20 22 2e 74 78 74 22 20 70 61 67 65 and ".txt" page 0c60: 73 0a 61 72 65 20 72 65 6e 64 65 72 65 64 20 77 s.are rendered w 0c70: 69 74 68 20 74 68 65 20 73 74 61 6e 64 61 72 64 ith the standard 0c80: 20 66 6f 73 73 69 6c 20 68 65 61 64 65 72 20 61 fossil header a 0c90: 6e 64 20 66 6f 6f 74 65 72 20 61 64 64 65 64 2e nd footer added. 0ca0: 0a 41 6c 6c 20 6f 74 68 65 72 20 6d 69 6d 65 74 .All other mimet 0cb0: 79 70 65 73 20 61 72 65 20 64 65 6c 69 76 65 72 ypes are deliver 0cc0: 65 64 20 64 69 72 65 63 74 6c 79 20 74 6f 20 74 ed directly to t 0cd0: 68 65 20 72 65 71 75 65 73 74 69 6e 67 0a 77 65 he requesting.we 0ce0: 62 20 62 72 6f 77 73 65 72 20 77 69 74 68 6f 75 b browser withou 0cf0: 74 20 69 6e 74 65 72 70 72 65 74 61 74 69 6f 6e t interpretation 0d00: 2c 20 61 64 64 69 74 69 6f 6e 73 2c 20 6f 72 20 , additions, or 0d10: 63 68 61 6e 67 65 73 2e 0a 0a 54 68 65 20 6c 69 changes...The li 0d20: 73 74 20 6f 66 20 61 6c 6c 6f 77 65 64 20 73 75 st of allowed su 0d30: 66 66 69 78 65 73 20 66 6f 72 20 65 6d 62 65 64 ffixes for embed 0d40: 64 65 64 20 64 6f 63 75 6d 65 6e 74 73 20 69 73 ded documents is 0d50: 20 6c 69 6b 65 6c 79 20 74 6f 0a 67 72 6f 77 20 likely to.grow 0d60: 61 6e 64 20 62 65 63 6f 6d 65 20 75 73 65 72 2d and become user- 0d70: 63 6f 6e 66 69 67 75 72 61 62 6c 65 20 69 6e 20 configurable in 0d80: 66 75 74 75 72 65 20 72 65 6c 65 61 73 65 73 20 future releases 0d90: 6f 66 20 66 6f 73 73 69 6c 2e 0a 0a 3c 68 32 3e of fossil...<h2> 0da0: 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a 54 Examples</h2>..T 0db0: 68 69 73 20 66 69 6c 65 20 74 68 61 74 20 79 6f his file that yo 0dc0: 75 20 61 72 65 20 63 75 72 72 65 6e 74 6c 79 20 u are currently 0dd0: 72 65 61 64 69 6e 67 20 69 73 20 61 6e 20 65 78 reading is an ex 0de0: 61 6d 70 6c 65 20 6f 66 0a 65 6d 62 65 64 64 65 ample of.embedde 0df0: 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e d documentation. 0e00: 20 20 54 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 The name of th 0e10: 69 73 20 66 69 6c 65 20 69 6e 20 74 68 65 20 66 is file in the f 0e20: 6f 73 73 69 6c 0a 73 6f 75 72 63 65 20 74 72 65 ossil.source tre 0e30: 65 20 69 73 20 22 3c 62 3e 77 77 77 2f 65 6d 62 e is "<b>www/emb 0e40: 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 eddeddoc.wiki</b 0e50: 3e 22 2e 0a 59 6f 75 20 61 72 65 20 70 65 72 68 >"..You are perh 0e60: 61 70 73 20 6c 6f 6f 6b 69 6e 67 20 61 74 20 74 aps looking at t 0e70: 68 69 73 0a 66 69 6c 65 20 75 73 69 6e 67 20 74 his.file using t 0e80: 68 65 20 55 52 4c 3a 20 20 0a 5b 68 74 74 70 3a he URL: .[http: 0e90: 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d //www.fossil-scm 0ea0: 2e 6f 72 67 2f 69 6e 64 65 78 2e 68 74 6d 6c 2f .org/index.html/ 0eb0: 64 6f 63 2f 74 69 70 2f 77 77 77 2f 65 6d 62 65 doc/tip/www/embe 0ec0: 64 64 65 64 64 6f 63 2e 77 69 6b 69 5d 2e 0a 0a ddeddoc.wiki]... 0ed0: 54 68 65 20 66 69 72 73 74 20 70 61 72 74 20 6f The first part o 0ee0: 66 20 74 68 69 73 20 70 61 74 68 2c 20 74 68 65 f this path, the 0ef0: 20 22 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f "[http://www.fo 0f00: 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 69 6e 64 ssil-scm.org/ind 0f10: 65 78 2e 68 74 6d 6c 5d 22 2c 0a 69 73 20 74 68 ex.html]",.is th 0f20: 65 20 62 61 73 65 20 55 52 4c 2e 20 20 59 6f 75 e base URL. You 0f30: 20 6d 69 67 68 74 20 68 61 76 65 20 6f 72 69 67 might have orig 0f40: 69 6e 61 6c 6c 79 20 74 79 70 65 64 3a 0a 5b 68 inally typed:.[h 0f50: 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c ttp://www.fossil 0f60: 2d 73 63 6d 2e 6f 72 67 2f 5d 2e 20 20 54 68 65 -scm.org/]. The 0f70: 20 77 65 62 20 73 65 72 76 65 72 20 61 74 20 74 web server at t 0f80: 68 65 20 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 he www.fossil-sc 0f90: 6d 2e 6f 72 67 0a 73 69 74 65 20 61 75 74 6f 6d m.org.site autom 0fa0: 61 74 69 63 61 6c 6c 79 20 72 65 64 69 72 65 63 atically redirec 0fb0: 74 73 20 73 75 63 68 20 6c 69 6e 6b 73 20 62 79 ts such links by 0fc0: 20 61 70 70 65 6e 64 69 6e 67 20 22 69 6e 64 65 appending "inde 0fd0: 78 2e 68 74 6d 6c 22 2e 20 20 54 68 65 0a 22 69 x.html". The."i 0fe0: 6e 64 65 78 2e 68 74 6d 6c 22 20 66 69 6c 65 20 ndex.html" file 0ff0: 6f 6e 20 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 on www.fossil-sc 1000: 6d 2e 6f 72 67 20 69 73 20 72 65 61 6c 6c 79 20 m.org is really 1010: 61 20 43 47 49 20 73 63 72 69 70 74 0a 28 64 6f a CGI script.(do 1020: 20 6e 6f 74 20 62 65 20 6d 69 73 6c 65 61 64 20 not be mislead 1030: 62 79 20 74 68 65 20 6e 61 6d 65 29 20 77 68 69 by the name) whi 1040: 63 68 20 72 75 6e 73 20 74 68 65 20 66 6f 73 73 ch runs the foss 1050: 69 6c 20 77 65 62 20 73 65 72 76 69 63 65 20 69 il web service i 1060: 6e 0a 43 47 49 20 6d 6f 64 65 2e 20 20 54 68 65 n.CGI mode. The 1070: 20 22 69 6e 64 65 78 2e 68 74 6d 6c 22 20 43 47 "index.html" CG 1080: 49 20 73 63 72 69 70 74 20 6c 6f 6f 6b 73 20 6c I script looks l 1090: 69 6b 65 20 74 68 69 73 3a 0a 0a 3c 62 6c 6f 63 ike this:..<bloc 10a0: 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 23 21 2f kquote><pre>.#!/ 10b0: 75 73 72 2f 62 69 6e 2f 66 6f 73 73 69 6c 0a 72 usr/bin/fossil.r 10c0: 65 70 6f 73 69 74 6f 72 79 3a 20 2f 66 6f 73 73 epository: /foss 10d0: 69 6c 2f 66 6f 73 73 69 6c 2e 66 6f 73 73 69 6c il/fossil.fossil 10e0: 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 .</pre></blockqu 10f0: 6f 74 65 3e 0a 0a 54 68 69 73 20 69 73 20 6f 6e ote>..This is on 1100: 65 20 6f 66 20 74 68 72 65 65 20 77 61 79 73 20 e of three ways 1110: 74 6f 20 73 65 74 20 75 70 20 61 20 0a 3c 61 20 to set up a .<a 1120: 68 72 65 66 3d 22 71 75 69 63 6b 73 74 61 72 74 href="quickstart 1130: 2e 77 69 6b 69 23 73 65 72 76 65 72 73 65 74 75 .wiki#serversetu 1140: 70 22 3e 66 6f 73 73 69 6c 20 77 65 62 20 73 65 p">fossil web se 1150: 72 76 65 72 3c 2f 61 3e 2e 0a 0a 54 68 65 20 22 rver</a>...The " 1160: 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22 20 70 61 <b>/tip/</b>" pa 1170: 72 74 20 6f 66 20 74 68 65 20 55 52 4c 20 74 65 rt of the URL te 1180: 6c 6c 73 20 66 6f 73 73 69 6c 20 74 6f 20 75 73 lls fossil to us 1190: 65 0a 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 e.the documentat 11a0: 69 6f 6e 20 66 69 6c 65 73 20 66 72 6f 6d 20 74 ion files from t 11b0: 68 65 20 62 61 73 65 6c 69 6e 65 20 74 68 61 74 he baseline that 11c0: 20 77 61 73 20 63 68 65 63 6b 65 64 20 69 6e 20 was checked in 11d0: 6d 6f 73 74 0a 72 65 63 65 6e 74 6c 79 2e 20 20 most.recently. 11e0: 54 68 69 73 20 66 69 6c 65 20 69 73 20 73 74 6f This file is sto 11f0: 72 65 64 20 69 6e 20 74 68 65 20 66 6f 73 73 69 red in the fossi 1200: 6c 20 73 6f 75 72 63 65 20 74 72 65 65 20 75 6e l source tree un 1210: 64 65 72 0a 74 68 65 20 6e 61 6d 65 20 22 3c 62 der.the name "<b 1220: 3e 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f 63 >www/embeddeddoc 1230: 2e 77 69 6b 69 3c 2f 62 3e 22 20 61 6e 64 20 73 .wiki</b>" and s 1240: 6f 20 74 68 61 74 20 6e 61 6d 65 20 66 6f 72 6d o that name form 1250: 73 20 74 68 65 0a 6c 61 73 74 20 70 61 72 74 20 s the.last part 1260: 6f 66 20 74 68 65 20 55 52 4c 2e 0a 0a 41 73 20 of the URL...As 1270: 49 20 73 69 74 20 77 72 69 74 69 6e 67 20 74 68 I sit writing th 1280: 69 73 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e is documentation 1290: 20 66 69 6c 65 2c 20 49 20 61 6d 20 74 65 73 74 file, I am test 12a0: 69 6e 67 20 6d 79 20 77 6f 72 6b 20 62 79 0a 72 ing my work by.r 12b0: 75 6e 6e 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 unning the "<b>f 12c0: 6f 73 73 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e ossil server</b> 12d0: 22 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 20 61 " command line a 12e0: 6e 64 20 76 69 65 77 69 6e 67 0a 3c 62 3e 68 74 nd viewing.<b>ht 12f0: 74 70 3a 2f 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 tp://localhost:8 1300: 30 38 30 2f 64 6f 63 2f 63 6b 6f 75 74 2f 77 77 080/doc/ckout/ww 1310: 77 2f 65 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 w/embeddeddoc.wi 1320: 6b 69 3c 2f 62 3e 20 69 6e 0a 46 69 72 65 66 6f ki</b> in.Firefo 1330: 78 2e 20 20 49 20 61 6d 20 64 6f 69 6e 67 20 74 x. I am doing t 1340: 68 69 73 20 65 76 65 6e 20 74 68 6f 75 67 68 20 his even though 1350: 49 20 68 61 76 65 20 6e 6f 74 20 79 65 74 20 63 I have not yet c 1360: 68 65 63 6b 65 64 20 69 6e 0a 74 68 65 20 22 3c hecked in.the "< 1370: 62 3e 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f b>www/embeddeddo 1380: 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 66 69 6c 65 c.wiki</b>" file 1390: 20 66 6f 72 20 74 68 65 20 66 69 72 73 74 20 74 for the first t 13a0: 69 6d 65 2e 20 20 55 73 69 6e 67 0a 74 68 65 20 ime. Using.the 13b0: 73 70 65 63 69 61 6c 20 22 3c 62 3e 63 6b 6f 75 special "<b>ckou 13c0: 74 3c 2f 62 3e 22 20 76 65 72 73 69 6f 6e 20 69 t</b>" version i 13d0: 64 65 6e 74 69 66 69 65 72 20 6f 6e 20 74 68 65 dentifier on the 13e0: 20 22 3c 62 3e 2f 64 6f 63 3c 2f 62 3e 22 20 70 "<b>/doc</b>" p 13f0: 61 67 65 0a 69 74 20 69 73 20 65 61 73 79 20 74 age.it is easy t 1400: 6f 20 6d 61 6b 65 20 6d 75 6c 74 69 70 6c 65 20 o make multiple 1410: 63 68 61 6e 67 65 73 20 74 6f 20 6d 75 6c 74 69 changes to multi 1420: 70 6c 65 20 66 69 6c 65 73 20 61 6e 64 20 73 65 ple files and se 1430: 65 20 68 6f 77 20 74 68 65 79 20 61 6c 6c 0a 6c e how they all.l 1440: 6f 6f 6b 20 74 6f 67 65 74 68 65 72 20 62 65 66 ook together bef 1450: 6f 72 65 20 63 6f 6d 6d 69 74 74 69 6e 67 20 61 ore committing a 1460: 6e 79 74 68 69 6e 67 20 74 6f 20 74 68 65 20 72 nything to the r 1470: 65 70 6f 73 69 74 6f 72 79 2e 0a epository..