Artifact f65cddb5e8dd51abc57f90e88132cb3c55338a55:
File www/embeddeddoc.wiki part of check-in [5c65487c5f] - Add documentation (advocacy-type documentation) on the fossil web interface. Created links from the homepage. by drh on 2009-01-25 23:30:07.
0000: 3c 68 31 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 <h1 align="cente 0010: 72 22 3e 4d 61 6e 61 67 69 6e 67 20 50 72 6f 6a r">Managing Proj 0020: 65 63 74 20 44 6f 63 75 6d 65 6e 74 61 74 69 6f ect Documentatio 0030: 6e 3c 2f 68 31 3e 0a 0a 46 6f 73 73 69 6c 20 70 n</h1>..Fossil p 0040: 72 6f 76 69 64 65 73 20 61 20 62 75 69 6c 74 2d rovides a built- 0050: 69 6e 20 3c 61 20 68 72 65 66 3d 22 77 69 6b 69 in <a href="wiki 0060: 74 68 65 6f 72 79 2e 77 69 6b 69 22 3e 77 69 6b theory.wiki">wik 0070: 69 3c 2f 61 3e 0a 74 68 61 74 20 63 61 6e 20 62 i</a>.that can b 0080: 65 20 75 73 65 64 20 74 6f 20 73 74 6f 72 65 20 e used to store 0090: 74 68 65 0a 64 6f 63 75 6d 65 6e 74 61 74 69 6f the.documentatio 00a0: 6e 20 66 6f 72 20 61 20 70 72 6f 6a 65 63 74 2e n for a project. 00b0: 20 20 54 68 69 73 20 69 73 20 73 75 66 66 69 63 This is suffic 00c0: 69 65 6e 74 20 66 6f 72 20 6d 61 6e 79 20 70 72 ient for many pr 00d0: 6f 6a 65 63 74 73 2e 0a 49 66 20 79 6f 75 72 20 ojects..If your 00e0: 70 72 6f 6a 65 63 74 20 69 73 20 77 65 6c 6c 2d project is well- 00f0: 73 65 72 76 65 64 20 62 79 20 77 69 6b 69 20 64 served by wiki d 0100: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 74 68 ocumentation, th 0110: 65 6e 20 79 6f 75 0a 6e 65 65 64 20 72 65 61 64 en you.need read 0120: 20 6e 6f 20 66 75 72 74 68 65 72 2e 0a 0a 42 75 no further...Bu 0130: 74 20 66 6f 73 73 69 6c 20 61 6c 73 6f 20 73 75 t fossil also su 0140: 70 70 6f 72 74 73 20 65 6d 62 65 64 64 69 6e 67 pports embedding 0150: 20 70 72 6f 6a 65 63 74 20 64 6f 63 75 6d 65 6e project documen 0160: 74 61 74 69 6f 6e 20 61 73 0a 66 69 6c 65 73 20 tation as.files 0170: 69 6e 20 74 68 65 20 73 6f 75 72 63 65 20 74 72 in the source tr 0180: 65 65 2e 20 20 54 68 65 72 65 20 61 72 65 20 73 ee. There are s 0190: 65 76 65 72 61 6c 20 70 6f 74 65 6e 74 69 61 6c everal potential 01a0: 20 61 64 76 61 6e 74 61 67 65 73 0a 74 6f 20 74 advantages.to t 01b0: 68 69 73 20 61 70 70 72 6f 61 63 68 3a 0a 0a 20 his approach:.. 01c0: 20 31 2e 20 20 54 68 65 20 64 6f 63 75 6d 65 6e 1. The documen 01d0: 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 61 72 65 tation files are 01e0: 20 76 65 72 73 69 6f 6e 65 64 20 74 6f 67 65 74 versioned toget 01f0: 68 65 72 20 77 69 74 68 20 74 68 65 0a 20 20 20 her with the. 0200: 20 20 20 73 6f 75 72 63 65 20 63 6f 64 65 20 66 source code f 0210: 69 6c 65 73 20 73 6f 20 69 74 20 69 73 20 61 6c iles so it is al 0220: 77 61 79 73 20 63 6c 65 61 72 20 77 68 61 74 20 ways clear what 0230: 76 65 72 73 69 6f 6e 20 6f 66 0a 20 20 20 20 20 version of. 0240: 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 the documentati 0250: 6f 6e 20 67 6f 65 73 20 77 69 74 68 20 61 20 70 on goes with a p 0260: 61 72 74 69 63 75 6c 61 72 20 72 65 6c 65 61 73 articular releas 0270: 65 2e 0a 0a 20 20 32 2e 20 20 54 68 65 20 64 6f e... 2. The do 0280: 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 cumentation file 0290: 73 20 63 61 6e 20 62 65 20 65 64 69 74 65 64 20 s can be edited 02a0: 75 73 69 6e 67 20 79 6f 75 72 20 66 61 76 6f 72 using your favor 02b0: 69 74 65 0a 20 20 20 20 20 20 74 65 78 74 20 65 ite. text e 02c0: 64 69 74 6f 72 20 69 6e 73 74 65 61 64 20 6f 66 ditor instead of 02d0: 20 68 61 76 69 6e 67 20 74 6f 20 75 73 65 20 74 having to use t 02e0: 68 65 20 77 65 62 2d 62 61 73 65 64 20 77 69 6b he web-based wik 02f0: 69 0a 20 20 20 20 20 20 65 64 69 74 6f 72 2e 0a i. editor.. 0300: 0a 20 20 33 2e 20 20 4f 6e 6c 79 20 70 65 6f 70 . 3. Only peop 0310: 6c 65 20 77 69 74 68 20 63 68 65 63 6b 2d 69 6e le with check-in 0320: 20 70 72 69 76 69 6c 65 67 65 73 20 63 61 6e 20 privileges can 0330: 6d 6f 64 69 66 79 20 74 68 65 20 64 6f 63 75 6d modify the docum 0340: 65 6e 74 61 74 69 6f 6e 2e 0a 20 20 20 20 20 20 entation.. 0350: 28 54 68 69 73 20 6d 69 67 68 74 20 62 65 20 65 (This might be e 0360: 69 74 68 65 72 20 61 6e 20 61 64 76 61 6e 74 61 ither an advanta 0370: 67 65 20 6f 72 20 64 69 73 61 64 76 61 6e 74 61 ge or disadvanta 0380: 67 65 2c 20 64 65 70 65 6e 64 69 6e 67 0a 20 20 ge, depending. 0390: 20 20 20 20 6f 6e 20 74 68 65 20 6e 61 74 75 72 on the natur 03a0: 65 20 6f 66 20 79 6f 75 72 20 70 72 6f 6a 65 63 e of your projec 03b0: 74 2e 29 0a 0a 57 65 20 77 69 6c 6c 20 63 61 6c t.)..We will cal 03c0: 6c 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 l documentation 03d0: 74 68 61 74 20 69 73 20 69 6e 63 6c 75 64 65 64 that is included 03e0: 20 61 73 20 66 69 6c 65 73 20 69 6e 20 74 68 65 as files in the 03f0: 20 73 6f 75 72 63 65 20 74 72 65 65 0a 22 65 6d source tree."em 0400: 62 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 bedded documenta 0410: 74 69 6f 6e 22 2e 0a 0a 3c 68 32 3e 46 6f 73 73 tion"...<h2>Foss 0420: 69 6c 20 53 75 70 70 6f 72 74 20 46 6f 72 20 45 il Support For E 0430: 6d 62 65 64 64 65 64 20 44 6f 63 75 6d 65 6e 74 mbedded Document 0440: 61 74 69 6f 6e 3c 2f 68 32 3e 0a 0a 54 68 65 20 ation</h2>..The 0450: 66 6f 73 73 69 6c 20 77 65 62 20 69 6e 74 65 72 fossil web inter 0460: 66 61 63 65 20 73 75 70 70 6f 72 74 73 20 65 6d face supports em 0470: 62 65 64 64 65 64 20 64 6f 63 75 6d 65 6e 74 61 bedded documenta 0480: 74 69 6f 6e 20 75 73 69 6e 67 0a 74 68 65 20 22 tion using.the " 0490: 2f 64 6f 63 22 20 70 61 67 65 2e 20 20 54 6f 20 /doc" page. To 04a0: 61 63 63 65 73 73 20 65 6d 62 65 64 64 65 64 20 access embedded 04b0: 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2c 20 6f documentation, o 04c0: 6e 65 20 70 6f 69 6e 74 73 0a 61 20 77 65 62 20 ne points.a web 04d0: 62 72 6f 77 73 65 72 20 74 6f 20 61 20 66 6f 73 browser to a fos 04e0: 73 69 6c 20 55 52 4c 20 6f 66 20 74 68 65 20 66 sil URL of the f 04f0: 6f 6c 6c 6f 77 69 6e 67 20 66 6f 72 6d 3a 0a 0a ollowing form:.. 0500: 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 0a 3c 69 3e <blockquote>.<i> 0510: 26 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c <baseurl>< 0520: 2f 69 3e 3c 62 69 67 3e 3c 62 3e 2f 64 6f 63 2f /i><big><b>/doc/ 0530: 3c 2f 62 3e 3c 2f 62 69 67 3e 3c 69 3e 26 6c 74 </b></big><i>< 0540: 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c 2f 69 3e ;version></i> 0550: 3c 62 69 67 3e 3c 62 3e 2f 3c 2f 62 3e 3c 2f 62 <big><b>/</b></b 0560: 69 67 3e 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e 61 ig><i><filena 0570: 6d 65 26 67 74 3b 3c 2f 69 3e 0a 3c 2f 62 6c 6f me></i>.</blo 0580: 63 6b 71 75 6f 74 65 3e 0a 0a 54 68 65 20 3c 69 ckquote>..The <i 0590: 3e 26 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b ><baseurl> 05a0: 3c 2f 69 3e 20 69 73 20 74 68 65 20 6d 61 69 6e </i> is the main 05b0: 20 55 52 4c 20 75 73 65 64 20 74 6f 20 61 63 63 URL used to acc 05c0: 65 73 73 20 74 68 65 20 66 6f 73 73 69 6c 20 77 ess the fossil w 05d0: 65 62 20 73 65 72 76 65 72 2e 0a 46 6f 72 20 65 eb server..For e 05e0: 78 61 6d 70 6c 65 2c 20 74 68 65 20 3c 69 3e 26 xample, the <i>& 05f0: 6c 74 3b 62 61 73 65 75 72 6c 26 67 74 3b 3c 2f lt;baseurl></ 0600: 69 3e 20 66 6f 72 20 74 68 65 20 66 6f 73 73 69 i> for the fossi 0610: 6c 20 70 72 6f 6a 65 63 74 20 69 74 73 65 6c 66 l project itself 0620: 20 69 73 0a 65 69 74 68 65 72 20 3c 62 3e 68 74 is.either <b>ht 0630: 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d tp://www.fossil- 0640: 73 63 6d 2e 6f 72 67 2f 66 6f 73 73 69 6c 3c 2f scm.org/fossil</ 0650: 62 3e 20 6f 72 0a 3c 62 3e 68 74 74 70 3a 2f 2f b> or.<b>http:// 0660: 77 77 77 2e 68 77 61 63 69 2e 63 6f 6d 2f 63 67 www.hwaci.com/cg 0670: 69 2d 62 69 6e 2f 66 6f 73 73 69 6c 3c 2f 62 3e i-bin/fossil</b> 0680: 2e 0a 49 66 20 79 6f 75 20 6c 61 75 6e 63 68 20 ..If you launch 0690: 74 68 65 20 77 65 62 20 73 65 72 76 65 72 20 75 the web server u 06a0: 73 69 6e 67 20 74 68 65 20 22 3c 62 3e 66 6f 73 sing the "<b>fos 06b0: 73 69 6c 20 73 65 72 76 65 72 3c 2f 62 3e 22 20 sil server</b>" 06c0: 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2c 0a 74 68 command line,.th 06d0: 65 6e 20 74 68 65 20 3c 69 3e 26 6c 74 3b 62 61 en the <i><ba 06e0: 73 65 75 72 6c 26 67 74 3b 3c 2f 69 3e 20 69 73 seurl></i> is 06f0: 20 75 73 75 61 6c 6c 79 0a 3c 62 3e 68 74 74 70 usually.<b>http 0700: 3a 2f 2f 6c 6f 63 61 6c 68 6f 73 74 3a 38 30 38 ://localhost:808 0710: 30 2f 3c 2f 62 3e 2e 0a 0a 54 68 65 20 3c 69 3e 0/</b>...The <i> 0720: 26 6c 74 3b 76 65 72 73 69 6f 6e 26 67 74 3b 3c <version>< 0730: 2f 69 3e 20 69 73 20 61 6e 79 20 75 6e 69 71 75 /i> is any uniqu 0740: 65 20 70 72 65 66 69 78 20 6f 66 20 74 68 65 20 e prefix of the 0750: 63 68 65 63 6b 2d 69 6e 20 49 44 20 66 6f 72 20 check-in ID for 0760: 0a 74 68 65 20 63 68 65 63 6b 2d 69 6e 20 63 6f .the check-in co 0770: 6e 74 61 69 6e 69 6e 67 20 74 68 65 20 64 6f 63 ntaining the doc 0780: 75 6d 65 6e 74 61 74 69 6f 6e 20 79 6f 75 20 77 umentation you w 0790: 61 6e 74 20 74 6f 20 61 63 63 65 73 73 2e 0a 4f ant to access..O 07a0: 72 20 3c 69 3e 26 6c 74 3b 76 65 72 73 69 6f 6e r <i><version 07b0: 26 67 74 3b 3c 2f 69 3e 20 63 61 6e 20 62 65 20 ></i> can be 07c0: 6f 6e 65 20 6f 66 20 74 68 65 20 6b 65 79 77 6f one of the keywo 07d0: 72 64 73 20 22 3c 62 3e 74 69 70 3c 2f 62 3e 22 rds "<b>tip</b>" 07e0: 20 6f 72 0a 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 or."<b>ckout</b 07f0: 3e 22 2e 20 20 54 68 65 20 22 3c 62 3e 74 69 70 >". The "<b>tip 0800: 3c 2f 62 3e 22 20 6b 65 79 77 6f 72 64 20 6d 65 </b>" keyword me 0810: 61 6e 73 20 74 6f 20 75 73 65 20 74 68 65 20 6d ans to use the m 0820: 6f 73 74 20 72 65 63 65 6e 74 6c 79 0a 63 68 65 ost recently.che 0830: 63 6b 65 64 2d 69 6e 2e 20 20 54 68 69 73 20 69 cked-in. This i 0840: 73 20 75 73 65 66 75 6c 20 69 66 20 79 6f 75 20 s useful if you 0850: 77 61 6e 74 20 74 6f 20 73 65 65 20 74 68 65 20 want to see the 0860: 76 65 72 79 20 6c 61 74 65 73 74 0a 76 65 72 73 very latest.vers 0870: 69 6f 6e 20 6f 66 20 74 68 65 20 64 6f 63 75 6d ion of the docum 0880: 65 6e 74 61 74 69 6f 6e 2e 20 20 54 68 65 20 22 entation. The " 0890: 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 6b 65 <b>ckout</b>" ke 08a0: 79 77 6f 72 64 73 20 6d 65 61 6e 73 20 74 6f 0a ywords means to. 08b0: 70 75 6c 6c 20 74 68 65 20 64 6f 63 75 6d 65 6e pull the documen 08c0: 74 61 74 69 6f 6e 20 66 69 6c 65 20 66 72 6f 6d tation file from 08d0: 20 74 68 65 20 6c 6f 63 61 6c 20 73 6f 75 72 63 the local sourc 08e0: 65 20 74 72 65 65 20 6f 6e 20 64 69 73 6b 2c 20 e tree on disk, 08f0: 6e 6f 74 0a 66 72 6f 6d 20 74 68 65 20 61 6e 79 not.from the any 0900: 20 63 68 65 63 6b 2d 69 6e 2e 20 20 54 68 65 20 check-in. The 0910: 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62 3e 22 20 6b "<b>ckout</b>" k 0920: 65 79 77 6f 72 64 20 6e 6f 72 6d 61 6c 6c 79 0a eyword normally. 0930: 6f 6e 6c 79 20 77 6f 72 6b 73 20 77 68 65 6e 20 only works when 0940: 79 6f 75 20 73 74 61 72 74 20 79 6f 75 72 20 73 you start your s 0950: 65 72 76 65 72 20 75 73 69 6e 67 20 74 68 65 20 erver using the 0960: 22 3c 62 3e 66 6f 73 73 69 6c 20 73 65 72 76 65 "<b>fossil serve 0970: 72 3c 2f 62 3e 22 0a 6f 72 20 22 3c 62 3e 66 6f r</b>".or "<b>fo 0980: 73 73 69 6c 20 75 69 3c 2f 62 3e 22 0a 63 6f 6d ssil ui</b>".com 0990: 6d 61 6e 64 20 6c 69 6e 65 20 61 6e 64 20 69 73 mand line and is 09a0: 20 69 6e 64 65 6e 74 65 64 20 74 6f 20 73 68 6f indented to sho 09b0: 77 20 77 68 61 74 20 74 68 65 20 64 6f 63 75 6d w what the docum 09c0: 65 6e 74 61 74 69 6f 6e 20 79 6f 75 20 61 72 65 entation you are 09d0: 20 63 75 72 72 65 6e 74 6c 79 0a 65 64 69 74 69 currently.editi 09e0: 6e 67 20 6c 6f 6f 6b 73 20 6c 69 6b 65 20 62 65 ng looks like be 09f0: 66 6f 72 65 20 79 6f 75 20 63 68 65 63 6b 20 69 fore you check i 0a00: 74 20 69 6e 2e 0a 0a 46 69 6e 61 6c 6c 79 2c 20 t in...Finally, 0a10: 74 68 65 20 3c 69 3e 26 6c 74 3b 66 69 6c 65 6e the <i><filen 0a20: 61 6d 65 26 67 74 3b 3c 2f 69 3e 20 65 6c 65 6d ame></i> elem 0a30: 65 6e 74 20 6f 66 20 74 68 65 20 55 52 4c 20 69 ent of the URL i 0a40: 73 20 74 68 65 20 66 75 6c 6c 0a 70 61 74 68 6e s the full.pathn 0a50: 61 6d 65 20 6f 66 20 74 68 65 20 64 6f 63 75 6d ame of the docum 0a60: 65 6e 74 61 74 69 6f 6e 20 66 69 6c 65 20 73 74 entation file st 0a70: 61 72 74 69 6e 67 20 66 72 6f 6d 20 74 68 65 20 arting from the 0a80: 72 6f 6f 74 20 6f 66 20 74 68 65 20 73 6f 75 72 root of the sour 0a90: 63 65 0a 74 72 65 65 2e 0a 0a 54 68 65 20 6d 69 ce.tree...The mi 0aa0: 6d 65 74 79 70 65 20 28 61 6e 64 20 74 68 75 73 metype (and thus 0ab0: 20 74 68 65 20 72 65 6e 64 65 72 69 6e 67 29 20 the rendering) 0ac0: 6f 66 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e of documentation 0ad0: 20 66 69 6c 65 73 20 69 73 20 0a 64 65 74 65 72 files is .deter 0ae0: 6d 69 6e 65 64 20 62 79 20 74 68 65 20 66 69 6c mined by the fil 0af0: 65 20 73 75 66 66 69 78 2e 20 20 46 6f 73 73 69 e suffix. Fossi 0b00: 6c 20 63 75 72 72 65 6e 74 6c 79 20 75 6e 64 65 l currently unde 0b10: 72 73 74 61 6e 64 73 20 31 39 32 0a 64 69 66 66 rstands 192.diff 0b20: 65 72 65 6e 74 20 66 69 6c 65 20 73 75 66 66 69 erent file suffi 0b30: 78 65 73 2c 20 69 6e 63 6c 75 64 69 6e 67 20 61 xes, including a 0b40: 6c 6c 20 74 68 65 20 70 6f 70 75 6c 61 72 20 6f ll the popular o 0b50: 6e 65 73 20 73 75 63 68 20 61 73 0a 22 2e 63 73 nes such as.".cs 0b60: 73 22 2c 20 22 2e 67 69 66 22 2c 20 22 2e 68 74 s", ".gif", ".ht 0b70: 6d 22 2c 20 22 2e 68 74 6d 6c 22 2c 20 22 2e 6a m", ".html", ".j 0b80: 70 67 22 2c 20 22 2e 6a 70 65 67 22 2c 20 22 2e pg", ".jpeg", ". 0b90: 70 6e 67 22 2c 20 61 6e 64 20 22 2e 74 78 74 22 png", and ".txt" 0ba0: 2e 0a 0a 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e ...Documentation 0bb0: 20 66 69 6c 65 73 20 77 68 6f 73 65 20 6e 61 6d files whose nam 0bc0: 65 73 20 65 6e 64 20 69 6e 20 22 2e 77 69 6b 69 es end in ".wiki 0bd0: 22 20 75 73 65 20 74 68 65 20 0a 5b 2f 77 69 6b " use the .[/wik 0be0: 69 5f 72 75 6c 65 73 20 7c 20 73 61 6d 65 20 6d i_rules | same m 0bf0: 61 72 6b 75 70 20 61 73 20 77 69 6b 69 20 70 61 arkup as wiki pa 0c00: 67 65 73 5d 20 2d 0a 61 20 73 61 66 65 20 73 75 ges] -.a safe su 0c10: 62 73 65 74 20 6f 66 20 48 54 4d 4c 20 74 6f 67 bset of HTML tog 0c20: 65 74 68 65 72 20 77 69 74 68 20 73 6f 6d 65 20 ether with some 0c30: 72 75 6c 65 73 20 66 6f 72 20 70 61 72 61 67 72 rules for paragr 0c40: 61 70 68 0a 62 72 65 61 6b 73 2c 20 6c 69 73 74 aph.breaks, list 0c50: 73 2c 20 61 6e 64 20 68 79 70 65 72 6c 69 6e 6b s, and hyperlink 0c60: 73 2e 20 20 54 68 65 20 22 2e 77 69 6b 69 22 20 s. The ".wiki" 0c70: 61 6e 64 20 22 2e 74 78 74 22 20 70 61 67 65 73 and ".txt" pages 0c80: 0a 61 72 65 20 72 65 6e 64 65 72 65 64 20 77 69 .are rendered wi 0c90: 74 68 20 74 68 65 20 73 74 61 6e 64 61 72 64 20 th the standard 0ca0: 66 6f 73 73 69 6c 20 68 65 61 64 65 72 20 61 6e fossil header an 0cb0: 64 20 66 6f 6f 74 65 72 20 61 64 64 65 64 2e 0a d footer added.. 0cc0: 41 6c 6c 20 6f 74 68 65 72 20 6d 69 6d 65 74 79 All other mimety 0cd0: 70 65 73 20 61 72 65 20 64 65 6c 69 76 65 72 65 pes are delivere 0ce0: 64 20 64 69 72 65 63 74 6c 79 20 74 6f 20 74 68 d directly to th 0cf0: 65 20 72 65 71 75 65 73 74 69 6e 67 0a 77 65 62 e requesting.web 0d00: 20 62 72 6f 77 73 65 72 20 77 69 74 68 6f 75 74 browser without 0d10: 20 69 6e 74 65 72 70 72 65 74 61 74 69 6f 6e 2c interpretation, 0d20: 20 61 64 64 69 74 69 6f 6e 73 2c 20 6f 72 20 63 additions, or c 0d30: 68 61 6e 67 65 73 2e 0a 0a 3c 68 32 3e 45 78 61 hanges...<h2>Exa 0d40: 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a 54 68 69 73 mples</h2>..This 0d50: 20 66 69 6c 65 20 74 68 61 74 20 79 6f 75 20 61 file that you a 0d60: 72 65 20 63 75 72 72 65 6e 74 6c 79 20 72 65 61 re currently rea 0d70: 64 69 6e 67 20 69 73 20 61 6e 20 65 78 61 6d 70 ding is an examp 0d80: 6c 65 20 6f 66 0a 65 6d 62 65 64 64 65 64 20 64 le of.embedded d 0d90: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 20 20 54 ocumentation. T 0da0: 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 69 73 20 he name of this 0db0: 66 69 6c 65 20 69 6e 20 74 68 65 20 66 6f 73 73 file in the foss 0dc0: 69 6c 0a 73 6f 75 72 63 65 20 74 72 65 65 20 69 il.source tree i 0dd0: 73 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 s "<b>www/embedd 0de0: 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 2e eddoc.wiki</b>". 0df0: 0a 59 6f 75 20 61 72 65 20 70 65 72 68 61 70 73 .You are perhaps 0e00: 20 6c 6f 6f 6b 69 6e 67 20 61 74 20 74 68 69 73 looking at this 0e10: 0a 66 69 6c 65 20 75 73 69 6e 67 20 74 68 65 20 .file using the 0e20: 55 52 4c 3a 0a 0a 20 20 20 5b 68 74 74 70 3a 2f URL:.. [http:/ 0e30: 2f 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e /www.fossil-scm. 0e40: 6f 72 67 2f 69 6e 64 65 78 2e 68 74 6d 6c 2f 64 org/index.html/d 0e50: 6f 63 2f 74 69 70 2f 77 77 77 2f 65 6d 62 65 64 oc/tip/www/embed 0e60: 64 65 64 64 6f 63 2e 77 69 6b 69 5d 2e 0a 0a 54 deddoc.wiki]...T 0e70: 68 65 20 66 69 72 73 74 20 70 61 72 74 20 6f 66 he first part of 0e80: 20 74 68 69 73 20 70 61 74 68 2c 20 74 68 65 20 this path, the 0e90: 22 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 "[http://www.fos 0ea0: 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 69 6e 64 65 sil-scm.org/inde 0eb0: 78 2e 68 74 6d 6c 5d 22 2c 0a 69 73 20 74 68 65 x.html]",.is the 0ec0: 20 62 61 73 65 20 55 52 4c 2e 20 20 59 6f 75 20 base URL. You 0ed0: 6d 69 67 68 74 20 68 61 76 65 20 6f 72 69 67 69 might have origi 0ee0: 6e 61 6c 6c 79 20 74 79 70 65 64 3a 0a 5b 68 74 nally typed:.[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 5d 2e 20 20 54 68 65 20 scm.org/]. The 0f10: 77 65 62 20 73 65 72 76 65 72 20 61 74 20 74 68 web server at th 0f20: 65 20 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d e www.fossil-scm 0f30: 2e 6f 72 67 0a 73 69 74 65 20 61 75 74 6f 6d 61 .org.site automa 0f40: 74 69 63 61 6c 6c 79 20 72 65 64 69 72 65 63 74 tically redirect 0f50: 73 20 73 75 63 68 20 6c 69 6e 6b 73 20 62 79 20 s such links by 0f60: 61 70 70 65 6e 64 69 6e 67 20 22 69 6e 64 65 78 appending "index 0f70: 2e 68 74 6d 6c 22 2e 20 20 54 68 65 0a 22 69 6e .html". The."in 0f80: 64 65 78 2e 68 74 6d 6c 22 20 66 69 6c 65 20 6f dex.html" file o 0f90: 6e 20 77 77 77 2e 66 6f 73 73 69 6c 2d 73 63 6d n www.fossil-scm 0fa0: 2e 6f 72 67 20 69 73 20 72 65 61 6c 6c 79 20 61 .org is really a 0fb0: 20 43 47 49 20 73 63 72 69 70 74 0a 28 64 6f 20 CGI script.(do 0fc0: 6e 6f 74 20 62 65 20 6d 69 73 6c 65 61 64 20 62 not be mislead b 0fd0: 79 20 74 68 65 20 6e 61 6d 65 29 20 77 68 69 63 y the name) whic 0fe0: 68 20 72 75 6e 73 20 74 68 65 20 66 6f 73 73 69 h runs the fossi 0ff0: 6c 20 77 65 62 20 73 65 72 76 69 63 65 20 69 6e l web service in 1000: 0a 43 47 49 20 6d 6f 64 65 2e 20 20 54 68 65 20 .CGI mode. The 1010: 22 69 6e 64 65 78 2e 68 74 6d 6c 22 20 43 47 49 "index.html" CGI 1020: 20 73 63 72 69 70 74 20 6c 6f 6f 6b 73 20 6c 69 script looks li 1030: 6b 65 20 74 68 69 73 3a 0a 0a 3c 62 6c 6f 63 6b ke this:..<block 1040: 71 75 6f 74 65 3e 3c 70 72 65 3e 0a 23 21 2f 75 quote><pre>.#!/u 1050: 73 72 2f 62 69 6e 2f 66 6f 73 73 69 6c 0a 72 65 sr/bin/fossil.re 1060: 70 6f 73 69 74 6f 72 79 3a 20 2f 66 6f 73 73 69 pository: /fossi 1070: 6c 2f 66 6f 73 73 69 6c 2e 66 6f 73 73 69 6c 0a l/fossil.fossil. 1080: 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63 6b 71 75 6f </pre></blockquo 1090: 74 65 3e 0a 0a 54 68 69 73 20 69 73 20 6f 6e 65 te>..This is one 10a0: 20 6f 66 20 74 68 72 65 65 20 77 61 79 73 20 74 of three ways t 10b0: 6f 20 73 65 74 20 75 70 20 61 20 0a 3c 61 20 68 o set up a .<a h 10c0: 72 65 66 3d 22 71 75 69 63 6b 73 74 61 72 74 2e ref="quickstart. 10d0: 77 69 6b 69 23 73 65 72 76 65 72 73 65 74 75 70 wiki#serversetup 10e0: 22 3e 66 6f 73 73 69 6c 20 77 65 62 20 73 65 72 ">fossil web ser 10f0: 76 65 72 3c 2f 61 3e 2e 0a 0a 54 68 65 20 22 3c ver</a>...The "< 1100: 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22 20 70 61 72 b>/tip/</b>" par 1110: 74 20 6f 66 20 74 68 65 20 55 52 4c 20 74 65 6c t of the URL tel 1120: 6c 73 20 66 6f 73 73 69 6c 20 74 6f 20 75 73 65 ls fossil to use 1130: 0a 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 .the documentati 1140: 6f 6e 20 66 69 6c 65 73 20 66 72 6f 6d 20 74 68 on files from th 1150: 65 20 63 68 65 63 6b 2d 69 6e 20 74 68 61 74 20 e check-in that 1160: 77 61 73 20 63 68 65 63 6b 65 64 20 69 6e 20 6d was checked in m 1170: 6f 73 74 0a 72 65 63 65 6e 74 6c 79 2e 20 20 49 ost.recently. I 1180: 66 20 79 6f 75 20 77 61 6e 74 65 64 20 74 6f 20 f you wanted to 1190: 73 65 65 20 61 6e 20 68 69 73 74 6f 72 69 63 61 see an historica 11a0: 6c 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 68 69 l version of thi 11b0: 73 20 64 6f 63 75 6d 65 6e 74 2c 0a 79 6f 75 20 s document,.you 11c0: 63 6f 75 6c 64 20 73 75 62 73 74 69 74 75 74 65 could substitute 11d0: 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 61 20 63 the name of a c 11e0: 68 65 63 6b 2d 69 6e 20 66 6f 72 20 22 3c 62 3e heck-in for "<b> 11f0: 2f 74 69 70 2f 3c 2f 62 3e 22 2e 0a 46 6f 72 20 /tip/</b>"..For 1200: 65 78 61 6d 70 6c 65 2c 20 74 6f 20 73 65 65 20 example, to see 1210: 74 68 65 20 76 65 72 73 69 6f 6e 20 6f 66 20 74 the version of t 1220: 68 69 73 20 64 6f 63 75 6d 65 6e 74 20 61 73 73 his document ass 1230: 6f 63 69 61 74 65 64 20 77 69 74 68 0a 63 68 65 ociated with.che 1240: 63 6b 2d 69 6e 20 5b 39 62 65 31 62 30 30 33 39 ck-in [9be1b0039 1250: 32 5d 2c 20 73 69 6d 70 6c 79 20 72 65 70 6c 61 2], simply repla 1260: 63 65 20 74 68 65 20 22 3c 62 3e 2f 74 69 70 2f ce the "<b>/tip/ 1270: 3c 2f 62 3e 22 20 77 69 74 68 0a 22 3c 62 3e 2f </b>" with."<b>/ 1280: 39 62 65 31 62 30 30 33 39 32 2f 3c 2f 62 3e 22 9be1b00392/</b>" 1290: 2e 20 20 59 6f 75 20 63 61 6e 20 61 6c 73 6f 20 . You can also 12a0: 73 75 62 73 74 69 74 75 74 65 20 74 68 65 20 73 substitute the s 12b0: 79 6d 62 6f 6c 69 63 20 6e 61 6d 65 0a 66 6f 72 ymbolic name.for 12c0: 20 61 20 70 61 72 74 69 63 75 6c 61 72 20 76 65 a particular ve 12d0: 72 73 69 6f 6e 20 6f 72 20 62 72 61 6e 63 68 2e rsion or branch. 12e0: 20 20 46 6f 72 20 65 78 61 6d 70 6c 65 2c 20 79 For example, y 12f0: 6f 75 20 6d 69 67 68 74 0a 72 65 70 6c 61 63 65 ou might.replace 1300: 20 22 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22 20 "<b>/tip/</b>" 1310: 77 69 74 68 20 22 3c 62 3e 2f 74 72 75 6e 6b 2f with "<b>/trunk/ 1320: 3c 2f 62 3e 22 20 74 6f 20 67 65 74 20 74 68 65 </b>" to get the 1330: 20 6c 61 74 65 73 74 0a 76 65 72 73 69 6f 6e 20 latest.version 1340: 6f 66 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 of this document 1350: 20 69 6e 20 74 68 65 20 22 74 72 75 6e 6b 22 20 in the "trunk" 1360: 62 72 61 6e 63 68 2e 20 20 28 41 73 20 6f 66 20 branch. (As of 1370: 74 68 69 73 20 77 72 69 74 69 6e 67 2c 0a 74 68 this writing,.th 1380: 65 20 73 65 6c 66 2d 68 6f 73 74 69 6e 67 20 66 e self-hosting f 1390: 6f 73 73 69 6c 20 72 65 70 6f 73 69 74 6f 72 79 ossil repository 13a0: 20 6f 6e 6c 79 20 68 61 73 20 61 20 73 69 6e 67 only has a sing 13b0: 6c 65 20 62 72 61 6e 63 68 20 22 74 72 75 6e 6b le branch "trunk 13c0: 22 20 61 6e 64 0a 73 6f 20 22 74 72 75 6e 6b 22 " and.so "trunk" 13d0: 20 61 6e 64 20 22 74 69 70 22 20 61 6d 6f 75 6e and "tip" amoun 13e0: 74 20 74 6f 20 74 68 65 20 73 61 6d 65 20 74 68 t to the same th 13f0: 69 6e 67 2c 20 62 75 74 20 74 68 65 79 20 77 6f ing, but they wo 1400: 75 6c 64 20 62 65 20 64 69 66 66 65 72 65 6e 74 uld be different 1410: 0a 69 6e 20 61 20 70 72 6f 6a 65 63 74 20 77 69 .in a project wi 1420: 74 68 20 6d 75 6c 74 69 70 6c 65 20 62 72 61 6e th multiple bran 1430: 63 68 65 73 2e 29 0a 0a 54 68 65 20 66 69 6c 65 ches.)..The file 1440: 20 74 68 61 74 20 65 6e 63 6f 64 65 73 20 74 68 that encodes th 1450: 69 73 20 64 6f 63 75 6d 65 6e 74 20 69 73 20 73 is document is s 1460: 74 6f 72 65 64 20 69 6e 20 74 68 65 20 66 6f 73 tored in the fos 1470: 73 69 6c 20 73 6f 75 72 63 65 20 74 72 65 65 20 sil source tree 1480: 75 6e 64 65 72 0a 74 68 65 20 6e 61 6d 65 20 22 under.the name " 1490: 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 65 64 64 <b>www/embeddedd 14a0: 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 61 6e 64 oc.wiki</b>" and 14b0: 20 73 6f 20 74 68 61 74 20 6e 61 6d 65 20 66 6f so that name fo 14c0: 72 6d 73 20 74 68 65 0a 6c 61 73 74 20 70 61 72 rms the.last par 14d0: 74 20 6f 66 20 74 68 65 20 55 52 4c 20 66 6f 72 t of the URL for 14e0: 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 2e 0a this document.. 14f0: 0a 41 73 20 49 20 73 69 74 20 77 72 69 74 69 6e .As I sit writin 1500: 67 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 61 g this documenta 1510: 74 69 6f 6e 20 66 69 6c 65 2c 20 49 20 61 6d 20 tion file, I am 1520: 74 65 73 74 69 6e 67 20 6d 79 20 77 6f 72 6b 20 testing my work 1530: 62 79 0a 72 75 6e 6e 69 6e 67 20 74 68 65 20 22 by.running the " 1540: 3c 62 3e 66 6f 73 73 69 6c 20 73 65 72 76 65 72 <b>fossil server 1550: 3c 2f 62 3e 22 20 63 6f 6d 6d 61 6e 64 20 6c 69 </b>" command li 1560: 6e 65 20 61 6e 64 20 76 69 65 77 69 6e 67 0a 3c ne and viewing.< 1570: 62 3e 68 74 74 70 3a 2f 2f 6c 6f 63 61 6c 68 6f b>http://localho 1580: 73 74 3a 38 30 38 30 2f 64 6f 63 2f 63 6b 6f 75 st:8080/doc/ckou 1590: 74 2f 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f t/www/embeddeddo 15a0: 63 2e 77 69 6b 69 3c 2f 62 3e 20 69 6e 0a 46 69 c.wiki</b> in.Fi 15b0: 72 65 66 6f 78 2e 20 20 49 20 61 6d 20 64 6f 69 refox. I am doi 15c0: 6e 67 20 74 68 69 73 20 65 76 65 6e 20 74 68 6f ng this even tho 15d0: 75 67 68 20 49 20 68 61 76 65 20 6e 6f 74 20 79 ugh I have not y 15e0: 65 74 20 63 68 65 63 6b 65 64 20 69 6e 0a 74 68 et checked in.th 15f0: 65 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 e "<b>www/embedd 1600: 65 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 eddoc.wiki</b>" 1610: 66 69 6c 65 20 66 6f 72 20 74 68 65 20 66 69 72 file for the fir 1620: 73 74 20 74 69 6d 65 2e 20 20 55 73 69 6e 67 0a st time. Using. 1630: 74 68 65 20 73 70 65 63 69 61 6c 20 22 3c 62 3e the special "<b> 1640: 63 6b 6f 75 74 3c 2f 62 3e 22 20 76 65 72 73 69 ckout</b>" versi 1650: 6f 6e 20 69 64 65 6e 74 69 66 69 65 72 20 6f 6e on identifier on 1660: 20 74 68 65 20 22 3c 62 3e 2f 64 6f 63 3c 2f 62 the "<b>/doc</b 1670: 3e 22 20 70 61 67 65 0a 69 74 20 69 73 20 65 61 >" page.it is ea 1680: 73 79 20 74 6f 20 6d 61 6b 65 20 6d 75 6c 74 69 sy to make multi 1690: 70 6c 65 20 63 68 61 6e 67 65 73 20 74 6f 20 6d ple changes to m 16a0: 75 6c 74 69 70 6c 65 20 66 69 6c 65 73 20 61 6e ultiple files an 16b0: 64 20 73 65 65 20 68 6f 77 20 74 68 65 79 20 61 d see how they a 16c0: 6c 6c 0a 6c 6f 6f 6b 20 74 6f 67 65 74 68 65 72 ll.look together 16d0: 20 62 65 66 6f 72 65 20 63 6f 6d 6d 69 74 74 69 before committi 16e0: 6e 67 20 61 6e 79 74 68 69 6e 67 20 74 6f 20 74 ng anything to t 16f0: 68 65 20 72 65 70 6f 73 69 74 6f 72 79 2e 0a he repository..