Artifact afbfa8cdc989f5239d2749ad621b9299a5379b21:
Wiki page [Documentation outline] by michael on 2008-05-24 15:24:25.
0000: 44 20 32 30 30 38 2d 30 35 2d 32 34 54 31 35 3a D 2008-05-24T15: 0010: 32 34 3a 32 35 0a 4c 20 44 6f 63 75 6d 65 6e 74 24:25.L Document 0020: 61 74 69 6f 6e 5c 73 6f 75 74 6c 69 6e 65 0a 55 ation\soutline.U 0030: 20 6d 69 63 68 61 65 6c 0a 57 20 32 39 38 36 0a michael.W 2986. 0040: ef bb bf 20 20 20 31 2e 20 20 42 6c 61 6e 6b 20 ... 1. Blank 0050: 6c 69 6e 65 73 20 61 72 65 20 70 61 72 61 67 72 lines are paragr 0060: 61 70 68 20 62 72 65 61 6b 73 0a 20 20 20 32 2e aph breaks. 2. 0070: 20 42 75 6c 6c 65 74 20 6c 69 73 74 20 69 74 65 Bullet list ite 0080: 6d 73 20 61 72 65 20 61 20 22 2a 22 20 61 74 20 ms are a "*" at 0090: 74 68 65 20 62 65 67 69 6e 6e 69 6e 67 20 6f 66 the beginning of 00a0: 20 74 68 65 20 6c 69 6e 65 2e 0a 20 20 20 33 2e the line.. 3. 00b0: 20 45 6e 75 6d 65 72 61 74 69 6f 6e 20 6c 69 73 Enumeration lis 00c0: 74 20 69 74 65 6d 73 20 61 72 65 20 61 20 6e 75 t items are a nu 00d0: 6d 62 65 72 20 61 74 20 74 68 65 20 62 65 67 69 mber at the begi 00e0: 6e 6e 69 6e 67 20 6f 66 20 61 20 6c 69 6e 65 2e nning of a line. 00f0: 0a 20 20 20 34 2e 20 49 6e 64 65 6e 74 65 64 20 . 4. Indented 0100: 70 61 72 67 72 61 70 68 73 20 62 65 67 69 6e 20 pargraphs begin 0110: 77 69 74 68 20 61 20 74 61 62 20 6f 72 20 74 77 with a tab or tw 0120: 6f 20 73 70 61 63 65 73 2e 0a 20 20 20 35 2e 20 o spaces.. 5. 0130: 48 79 70 65 72 6c 69 6e 6b 73 20 61 72 65 20 63 Hyperlinks are c 0140: 6f 6e 74 61 69 6e 65 64 20 77 69 74 68 20 73 71 ontained with sq 0150: 75 61 72 65 20 62 72 61 63 6b 65 74 73 3a 20 22 uare brackets: " 0160: 5b 74 61 72 67 65 74 5d 22 0a 20 20 20 36 2e 20 [target]". 6. 0170: 4d 6f 73 74 20 6f 72 64 69 6e 61 72 79 20 48 54 Most ordinary HT 0180: 4d 4c 20 77 6f 72 6b 73 2e 3c 61 3e 20 3c 61 64 ML works.<a> <ad 0190: 64 72 65 73 73 3e 20 3c 62 3e 20 3c 62 69 67 3e dress> <b> <big> 01a0: 20 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 20 3c 62 <blockquote> <b 01b0: 72 3e 20 3c 63 65 6e 74 65 72 3e 20 3c 63 69 74 r> <center> <cit 01c0: 65 3e 20 3c 63 6f 64 65 3e 20 3c 64 64 3e 20 3c e> <code> <dd> < 01d0: 64 66 6e 3e 20 3c 64 6c 3e 20 3c 64 74 3e 20 3c dfn> <dl> <dt> < 01e0: 65 6d 3e 20 3c 66 6f 6e 74 3e 20 3c 68 31 3e 20 em> <font> <h1> 01f0: 3c 68 32 3e 20 3c 68 33 3e 20 3c 68 34 3e 20 3c <h2> <h3> <h4> < 0200: 68 35 3e 20 3c 68 36 3e 20 3c 68 72 3e 20 3c 69 h5> <h6> <hr> <i 0210: 6d 67 3e 20 3c 69 3e 20 3c 6b 62 64 3e 20 3c 6c mg> <i> <kbd> <l 0220: 69 3e 20 3c 6e 6f 62 72 3e 20 3c 6f 6c 3e 20 3c i> <nobr> <ol> < 0230: 70 3e 20 3c 70 72 65 3e 20 3c 73 3e 20 3c 73 61 p> <pre> <s> <sa 0240: 6d 70 3e 20 3c 73 6d 61 6c 6c 3e 20 3c 73 74 72 mp> <small> <str 0250: 69 6b 65 3e 20 3c 73 74 72 6f 6e 67 3e 20 3c 73 ike> <strong> <s 0260: 75 62 3e 20 3c 73 75 70 3e 20 3c 74 61 62 6c 65 ub> <sup> <table 0270: 3e 20 3c 74 64 3e 20 3c 74 68 3e 20 3c 74 72 3e > <td> <th> <tr> 0280: 20 3c 74 74 3e 20 3c 75 3e 20 3c 75 6c 3e 20 3c <tt> <u> <ul> < 0290: 76 61 72 3e 0a 20 20 20 37 2e 20 3c 76 65 72 62 var>. 7. <verb 02a0: 61 74 69 6d 3e 20 61 6e 64 20 3c 6e 6f 77 69 6b atim> and <nowik 02b0: 69 3e 2e 20 0a 20 20 20 0a 0a 3c 68 31 3e 44 6f i>. . ..<h1>Do 02c0: 63 75 6d 65 6e 74 61 74 69 6f 6e 20 6f 75 74 6c cumentation outl 02d0: 69 6e 65 3c 2f 68 31 3e 0a 54 68 65 20 64 6f 63 ine</h1>.The doc 02e0: 75 6d 65 6e 74 61 74 69 6f 6e 20 66 6f 72 20 66 umentation for f 02f0: 6f 73 73 69 6c 20 6e 65 65 64 73 20 74 6f 20 62 ossil needs to b 0300: 65 20 64 69 76 69 64 65 64 20 69 6e 74 6f 20 74 e divided into t 0310: 68 65 73 65 20 6d 61 69 6e 20 73 65 63 74 69 6f hese main sectio 0320: 6e 73 3a 0a 2a 20 3c 63 69 74 65 3e 5b 54 75 74 ns:.* <cite>[Tut 0330: 6f 72 69 61 6c 5d 3c 2f 63 69 74 65 3e 0a 2a 20 orial]</cite>.* 0340: 3c 63 69 74 65 3e 5b 43 6f 6f 6b 62 6f 6f 6b 5d <cite>[Cookbook] 0350: 3c 2f 63 69 74 65 3e 0a 2a 20 3c 63 69 74 65 3e </cite>.* <cite> 0360: 5b 52 65 66 65 72 65 6e 63 65 5d 3c 2f 63 69 74 [Reference]</cit 0370: 65 3e 0a 2a 20 3c 63 69 74 65 3e 5b 44 65 76 65 e>.* <cite>[Deve 0380: 6c 6f 70 65 72 20 47 75 69 64 65 5d 3c 2f 63 69 loper Guide]</ci 0390: 74 65 3e 0a 0a 3c 68 32 3e 54 75 74 6f 72 69 61 te>..<h2>Tutoria 03a0: 6c 3c 2f 68 32 3e 0a 54 68 65 20 74 75 74 6f 72 l</h2>.The tutor 03b0: 69 61 6c 20 70 6f 72 74 69 6f 6e 20 69 73 20 74 ial portion is t 03c0: 68 65 20 68 61 6e 64 2d 68 6f 6c 64 69 6e 67 20 he hand-holding 03d0: 70 6f 72 74 69 6f 6e 20 74 68 61 74 20 74 61 6b portion that tak 03e0: 65 73 20 61 20 6e 65 77 20 75 73 65 72 20 74 68 es a new user th 03f0: 72 6f 75 67 68 0a 74 68 65 20 73 74 65 70 73 20 rough.the steps 0400: 6f 66 20 67 65 74 74 69 6e 67 2c 20 62 75 69 6c of getting, buil 0410: 64 69 6e 67 20 61 6e 64 20 75 73 69 6e 67 20 66 ding and using f 0420: 6f 73 73 69 6c 2e 20 20 46 6f 73 73 69 6c 27 73 ossil. Fossil's 0430: 20 74 65 72 6d 73 20 73 68 6f 75 6c 64 20 62 65 terms should be 0440: 0a 64 65 66 69 6e 65 64 20 68 65 72 65 20 61 6e .defined here an 0450: 64 20 62 61 73 69 63 20 77 6f 72 6b 66 6c 6f 77 d basic workflow 0460: 20 65 73 74 61 62 6c 69 73 68 65 64 2e 20 20 49 established. I 0470: 64 65 61 6c 6c 79 20 61 20 73 61 6d 70 6c 65 20 deally a sample 0480: 70 72 6f 6a 65 63 74 20 73 68 6f 75 6c 64 0a 62 project should.b 0490: 65 20 75 73 65 64 20 74 6f 20 73 68 6f 77 20 66 e used to show f 04a0: 6f 73 73 69 6c 20 69 6e 20 75 73 65 20 61 6e 64 ossil in use and 04b0: 20 67 69 76 65 20 74 68 65 20 75 73 65 72 20 73 give the user s 04c0: 6f 6d 65 74 68 69 6e 67 20 74 6f 20 74 79 70 65 omething to type 04d0: 20 74 6f 20 6d 61 67 69 63 61 6c 6c 79 0a 68 61 to magically.ha 04e0: 76 65 20 66 6f 73 73 69 6c 20 64 6f 20 63 6f 6f ve fossil do coo 04f0: 6c 20 73 74 75 66 66 2e 0a 0a 3c 68 32 3e 43 6f l stuff...<h2>Co 0500: 6f 6b 62 6f 6f 6b 3c 2f 68 32 3e 0a 54 68 65 20 okbook</h2>.The 0510: 63 6f 6f 6b 62 6f 6f 6b 20 69 73 20 61 20 74 61 cookbook is a ta 0520: 73 6b 2d 6f 72 69 65 6e 74 65 64 20 70 6f 72 74 sk-oriented port 0530: 69 6f 6e 20 28 6c 69 6b 65 6c 79 20 6f 6e 65 20 ion (likely one 0540: 74 68 61 74 27 73 20 65 76 65 72 2d 65 78 70 61 that's ever-expa 0550: 6e 64 69 6e 67 20 61 73 0a 66 6f 73 73 69 6c 20 nding as.fossil 0560: 69 73 20 69 6e 63 72 65 61 73 69 6e 67 6c 79 20 is increasingly 0570: 64 65 76 65 6c 6f 70 65 64 20 61 6e 64 20 68 6f developed and ho 0580: 6e 65 64 29 20 64 65 73 69 67 6e 65 64 20 66 6f ned) designed fo 0590: 72 20 61 20 75 73 65 72 20 77 68 6f 20 68 61 73 r a user who has 05a0: 20 62 61 73 69 63 0a 73 6b 69 6c 6c 73 20 69 6e basic.skills in 05b0: 20 75 73 69 6e 67 20 66 6f 73 73 69 6c 20 28 6c using fossil (l 05c0: 69 6b 65 2c 20 73 61 79 2c 20 6d 65 29 20 62 75 ike, say, me) bu 05d0: 74 20 69 73 6e 27 74 20 66 61 6d 69 6c 69 61 72 t isn't familiar 05e0: 20 77 69 74 68 20 61 6c 6c 20 74 68 65 20 66 61 with all the fa 05f0: 6e 63 69 65 72 0a 61 73 70 65 63 74 73 20 6f 66 ncier.aspects of 0600: 20 69 74 20 61 6e 64 20 74 68 65 20 69 6e 6f 62 it and the inob 0610: 76 69 6f 75 73 20 77 6f 72 6b 66 6c 6f 77 73 20 vious workflows 0620: 74 68 61 74 20 69 74 20 73 75 70 70 6f 72 74 73 that it supports 0630: 2e 20 20 45 61 63 68 20 22 72 65 63 69 70 65 22 . Each "recipe" 0640: 20 28 75 73 65 0a 63 61 73 65 29 20 69 6e 20 74 (use.case) in t 0650: 68 65 20 63 6f 6f 6b 62 6f 6f 6b 20 73 68 6f 75 he cookbook shou 0660: 6c 64 20 66 6f 6c 6c 6f 77 20 61 20 66 6f 72 6d ld follow a form 0670: 61 74 20 77 69 74 68 20 74 68 65 73 65 20 66 6f at with these fo 0680: 6c 6c 6f 77 69 6e 67 20 70 6f 69 6e 74 73 3a 0a llowing points:. 0690: 2a 20 53 75 63 63 69 6e 63 74 20 70 72 6f 62 6c * Succinct probl 06a0: 65 6d 20 73 74 61 74 65 6d 65 6e 74 2e 0a 2a 20 em statement..* 06b0: 44 65 74 61 69 6c 65 64 20 73 74 61 74 65 6d 65 Detailed stateme 06c0: 6e 74 20 6f 66 20 70 72 6f 62 6c 65 6d 20 61 6e nt of problem an 06d0: 64 20 6d 6f 74 69 76 61 74 69 6f 6e 20 66 6f 72 d motivation for 06e0: 20 73 6f 6c 75 74 69 6f 6e 2e 0a 2a 20 44 65 74 solution..* Det 06f0: 61 69 6c 65 64 20 69 6e 73 74 72 75 63 74 69 6f ailed instructio 0700: 6e 73 20 28 3c 65 6d 3e 6e 6f 20 64 69 73 63 75 ns (<em>no discu 0710: 73 73 69 6f 6e 21 3c 2f 65 6d 3e 29 20 66 6f 72 ssion!</em>) for 0720: 20 69 6d 70 6c 65 6d 65 6e 74 69 6e 67 20 74 68 implementing th 0730: 65 20 73 6f 6c 75 74 69 6f 6e 2e 0a 2a 20 44 69 e solution..* Di 0740: 73 63 75 73 73 69 6f 6e 20 6f 66 20 74 68 65 20 scussion of the 0750: 73 6f 6c 75 74 69 6f 6e 20 69 6e 63 6c 75 64 69 solution includi 0760: 6e 67 2c 20 69 66 20 61 70 70 6c 69 63 61 62 6c ng, if applicabl 0770: 65 2c 20 70 69 74 66 61 6c 6c 73 20 61 6e 64 20 e, pitfalls and 0780: 0a 61 6c 74 65 72 6e 61 74 69 76 65 73 2e 0a 0a .alternatives... 0790: 3c 68 32 3e 52 65 66 65 72 65 6e 63 65 3c 2f 68 <h2>Reference</h 07a0: 32 3e 0a 54 68 65 20 72 65 66 65 72 65 6e 63 65 2>.The reference 07b0: 20 69 73 20 73 65 6c 66 2d 65 78 70 6c 61 6e 61 is self-explana 07c0: 74 6f 72 79 2e 20 20 42 61 73 69 63 61 6c 6c 79 tory. Basically 07d0: 20 74 61 6b 65 20 65 76 65 72 79 74 68 69 6e 67 take everything 07e0: 20 66 72 6f 6d 20 3c 63 6f 64 65 3e 66 6f 73 73 from <code>foss 07f0: 69 6c 0a 68 65 6c 70 20 2a 3c 2f 63 6f 64 65 3e il.help *</code> 0800: 20 61 6e 64 20 70 75 74 20 69 74 20 68 65 72 65 and put it here 0810: 2e 20 20 48 6f 77 65 76 65 72 2c 20 74 68 65 20 . However, the 0820: 74 65 72 73 65 6e 65 73 73 20 6f 66 20 3c 63 6f terseness of <co 0830: 64 65 3e 66 6f 73 73 69 6c 0a 68 65 6c 70 3c 2f de>fossil.help</ 0840: 63 6f 64 65 3e 2c 20 77 68 69 6c 65 20 67 6f 6f code>, while goo 0850: 64 20 66 6f 72 20 61 20 71 75 69 63 6b 20 72 65 d for a quick re 0860: 6d 69 6e 64 65 72 20 61 74 20 74 68 65 20 63 6f minder at the co 0870: 6d 6d 61 6e 64 20 6c 69 6e 65 2c 20 69 73 20 6e mmand line, is n 0880: 6f 74 0a 73 75 69 74 61 62 6c 65 20 66 6f 72 20 ot.suitable for 0890: 22 72 65 61 6c 22 20 64 6f 63 75 6d 65 6e 74 61 "real" documenta 08a0: 74 69 6f 6e 2e 20 20 49 64 65 61 6c 6c 79 20 65 tion. Ideally e 08b0: 61 63 68 20 64 6f 63 75 6d 65 6e 74 65 64 20 65 ach documented e 08c0: 6c 65 6d 65 6e 74 20 69 6e 20 74 68 65 0a 72 65 lement in the.re 08d0: 66 65 72 65 6e 63 65 20 73 68 6f 75 6c 64 20 68 ference should h 08e0: 61 76 65 20 61 20 66 75 6c 6c 20 65 78 70 6c 61 ave a full expla 08f0: 6e 61 74 69 6f 6e 2c 20 69 6e 63 6c 75 64 69 6e nation, includin 0900: 67 20 6c 69 6e 6b 73 20 74 6f 20 72 65 6c 61 74 g links to relat 0910: 65 64 20 69 74 65 6d 73 2c 20 61 73 0a 77 65 6c ed items, as.wel 0920: 6c 20 61 73 20 3c 65 6d 3e 65 78 61 6d 70 6c 65 l as <em>example 0930: 73 3c 2f 65 6d 3e 2e 20 20 28 54 68 69 73 20 68 s</em>. (This h 0940: 61 73 20 62 65 65 6e 20 77 68 61 74 27 73 20 6b as been what's k 0950: 69 6c 6c 69 6e 67 20 6d 65 20 77 69 74 68 20 67 illing me with g 0960: 72 6f 6b 6b 69 6e 67 20 73 6f 6d 65 0a 61 73 70 rokking some.asp 0970: 65 63 74 73 20 6f 66 20 66 6f 73 73 69 6c 3a 20 ects of fossil: 0980: 49 20 6a 75 73 74 20 63 61 6e 27 74 20 66 69 67 I just can't fig 0990: 75 72 65 20 6f 75 74 20 77 68 61 74 20 74 68 65 ure out what the 09a0: 79 20 64 6f 21 29 0a 0a 3c 68 32 3e 44 65 76 65 y do!)..<h2>Deve 09b0: 6c 6f 70 65 72 20 47 75 69 64 65 3c 2f 68 32 3e loper Guide</h2> 09c0: 0a 49 74 20 69 73 20 69 6e 65 76 69 74 61 62 6c .It is inevitabl 09d0: 65 20 74 68 61 74 20 70 65 6f 70 6c 65 20 77 69 e that people wi 09e0: 6c 6c 20 77 61 6e 74 20 74 6f 20 73 74 61 72 74 ll want to start 09f0: 20 62 75 69 6c 64 69 6e 67 20 74 68 69 72 64 2d building third- 0a00: 70 61 72 74 79 20 74 6f 6f 6c 73 20 74 68 61 74 party tools that 0a10: 0a 69 6e 74 65 72 66 61 63 65 20 77 69 74 68 20 .interface with 0a20: 66 6f 73 73 69 6c 20 61 73 20 66 6f 73 73 69 6c fossil as fossil 0a30: 20 67 65 74 73 20 6d 6f 72 65 20 77 69 64 65 6c gets more widel 0a40: 79 20 61 64 6f 70 74 65 64 20 61 6e 64 20 6d 6f y adopted and mo 0a50: 72 65 20 6d 61 74 75 72 65 2e 20 20 57 65 0a 6d re mature. We.m 0a60: 69 67 68 74 20 61 73 20 77 65 6c 6c 20 68 65 61 ight as well hea 0a70: 64 20 6f 66 66 20 74 68 65 20 69 6e 65 76 69 74 d off the inevit 0a80: 61 62 6c 65 20 61 6e 64 20 6c 65 74 20 64 65 76 able and let dev 0a90: 65 6c 6f 70 65 72 73 20 68 61 76 65 20 74 68 65 elopers have the 0aa0: 20 69 6e 66 6f 72 6d 61 74 69 6f 6e 0a 74 68 65 information.the 0ab0: 79 20 6e 65 65 64 20 77 69 74 68 6f 75 74 20 74 y need without t 0ac0: 65 61 72 69 6e 67 20 61 70 61 72 74 20 74 68 65 earing apart the 0ad0: 20 73 6f 75 72 63 65 20 74 6f 20 67 65 74 20 74 source to get t 0ae0: 6f 20 69 74 2e 20 20 54 68 69 73 20 77 6f 75 6c o it. This woul 0af0: 64 20 69 6e 63 6c 75 64 65 0a 74 68 69 6e 67 73 d include.things 0b00: 20 6c 69 6b 65 3a 0a 2a 20 61 6e 79 20 41 50 49 like:.* any API 0b10: 73 20 69 74 20 77 6f 75 6c 64 20 62 65 20 72 65 s it would be re 0b20: 61 73 6f 6e 61 62 6c 65 20 74 6f 20 65 78 70 6f asonable to expo 0b30: 73 65 0a 2a 20 61 20 63 75 72 72 65 6e 74 2c 20 se.* a current, 0b40: 75 70 2d 74 6f 2d 64 61 74 65 20 64 61 74 61 62 up-to-date datab 0b50: 61 73 65 20 73 63 68 65 6d 61 0a 2a 20 6e 6f 74 ase schema.* not 0b60: 65 73 20 6f 6e 20 69 6e 6e 65 72 20 77 6f 72 6b es on inner work 0b70: 69 6e 67 73 20 28 61 6c 72 65 61 64 79 20 73 75 ings (already su 0b80: 70 70 6c 69 65 64 2c 20 62 75 74 20 6d 69 67 68 pplied, but migh 0b90: 74 20 6e 65 65 64 20 64 75 73 74 69 6e 67 20 6f t need dusting o 0ba0: 66 66 20 61 6e 64 20 0a 54 4c 43 29 0a 2a 20 61 ff and .TLC).* a 0bb0: 6e 79 74 68 69 6e 67 20 65 6c 73 65 20 77 65 20 nything else we 0bc0: 63 61 6e 20 74 68 69 6e 6b 20 6f 66 20 28 4c 75 can think of (Lu 0bd0: 61 2f 54 63 6c 2f 77 68 61 74 65 76 65 72 20 62 a/Tcl/whatever b 0be0: 69 6e 64 69 6e 67 73 3f 29 0a 0a 5a 20 36 38 30 indings?)..Z 680 0bf0: 36 65 37 61 33 65 36 35 32 66 63 36 35 37 33 64 6e7a3e652fc6573d 0c00: 31 39 64 34 62 64 63 36 31 64 39 30 30 0a 19d4bdc61d900.