Artifact 9432e8aba2747f051e62a6ca5c3fb30fe8427296:
Wiki page [Documentation outline] by ttmrichter on 2008-05-24 15:30:30.
0000: 44 20 32 30 30 38 2d 30 35 2d 32 34 54 31 35 3a D 2008-05-24T15: 0010: 33 30 3a 33 30 0a 4c 20 44 6f 63 75 6d 65 6e 74 30:30.L Document 0020: 61 74 69 6f 6e 5c 73 6f 75 74 6c 69 6e 65 0a 50 ation\soutline.P 0030: 20 61 66 62 66 61 38 63 64 63 39 38 39 66 35 32 afbfa8cdc989f52 0040: 33 39 64 32 37 34 39 61 64 36 32 31 62 39 32 39 39d2749ad621b929 0050: 39 61 35 33 37 39 62 32 31 0a 55 20 74 74 6d 72 9a5379b21.U ttmr 0060: 69 63 68 74 65 72 0a 57 20 32 33 39 38 0a 3c 68 ichter.W 2398.<h 0070: 31 3e 44 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 1>Documentation 0080: 6f 75 74 6c 69 6e 65 3c 2f 68 31 3e 0d 0a 54 68 outline</h1>..Th 0090: 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 e documentation 00a0: 66 6f 72 20 66 6f 73 73 69 6c 20 6e 65 65 64 73 for fossil needs 00b0: 20 74 6f 20 62 65 20 64 69 76 69 64 65 64 20 69 to be divided i 00c0: 6e 74 6f 20 74 68 65 73 65 20 6d 61 69 6e 20 73 nto these main s 00d0: 65 63 74 69 6f 6e 73 3a 0d 0a 2a 20 3c 63 69 74 ections:..* <cit 00e0: 65 3e 5b 54 75 74 6f 72 69 61 6c 5d 3c 2f 63 69 e>[Tutorial]</ci 00f0: 74 65 3e 0d 0a 2a 20 3c 63 69 74 65 3e 5b 43 6f te>..* <cite>[Co 0100: 6f 6b 62 6f 6f 6b 5d 3c 2f 63 69 74 65 3e 0d 0a okbook]</cite>.. 0110: 2a 20 3c 63 69 74 65 3e 5b 52 65 66 65 72 65 6e * <cite>[Referen 0120: 63 65 5d 3c 2f 63 69 74 65 3e 0d 0a 2a 20 3c 63 ce]</cite>..* <c 0130: 69 74 65 3e 5b 44 65 76 65 6c 6f 70 65 72 20 47 ite>[Developer G 0140: 75 69 64 65 5d 3c 2f 63 69 74 65 3e 0d 0a 0d 0a uide]</cite>.... 0150: 3c 68 32 3e 54 75 74 6f 72 69 61 6c 3c 2f 68 32 <h2>Tutorial</h2 0160: 3e 0d 0a 54 68 65 20 74 75 74 6f 72 69 61 6c 20 >..The tutorial 0170: 70 6f 72 74 69 6f 6e 20 69 73 20 74 68 65 20 68 portion is the h 0180: 61 6e 64 2d 68 6f 6c 64 69 6e 67 20 70 6f 72 74 and-holding port 0190: 69 6f 6e 20 74 68 61 74 20 74 61 6b 65 73 20 61 ion that takes a 01a0: 20 6e 65 77 20 75 73 65 72 20 74 68 72 6f 75 67 new user throug 01b0: 68 0d 0a 74 68 65 20 73 74 65 70 73 20 6f 66 20 h..the steps of 01c0: 67 65 74 74 69 6e 67 2c 20 62 75 69 6c 64 69 6e getting, buildin 01d0: 67 20 61 6e 64 20 75 73 69 6e 67 20 66 6f 73 73 g and using foss 01e0: 69 6c 2e 20 20 46 6f 73 73 69 6c 27 73 20 74 65 il. Fossil's te 01f0: 72 6d 73 20 73 68 6f 75 6c 64 20 62 65 0d 0a 64 rms should be..d 0200: 65 66 69 6e 65 64 20 68 65 72 65 20 61 6e 64 20 efined here and 0210: 62 61 73 69 63 20 77 6f 72 6b 66 6c 6f 77 20 65 basic workflow e 0220: 73 74 61 62 6c 69 73 68 65 64 2e 20 20 49 64 65 stablished. Ide 0230: 61 6c 6c 79 20 61 20 73 61 6d 70 6c 65 20 70 72 ally a sample pr 0240: 6f 6a 65 63 74 20 73 68 6f 75 6c 64 0d 0a 62 65 oject should..be 0250: 20 75 73 65 64 20 74 6f 20 73 68 6f 77 20 66 6f used to show fo 0260: 73 73 69 6c 20 69 6e 20 75 73 65 20 61 6e 64 20 ssil in use and 0270: 67 69 76 65 20 74 68 65 20 75 73 65 72 20 73 6f give the user so 0280: 6d 65 74 68 69 6e 67 20 74 6f 20 74 79 70 65 20 mething to type 0290: 74 6f 20 6d 61 67 69 63 61 6c 6c 79 0d 0a 68 61 to magically..ha 02a0: 76 65 20 66 6f 73 73 69 6c 20 64 6f 20 63 6f 6f ve fossil do coo 02b0: 6c 20 73 74 75 66 66 2e 0d 0a 0d 0a 3c 68 32 3e l stuff.....<h2> 02c0: 43 6f 6f 6b 62 6f 6f 6b 3c 2f 68 32 3e 0d 0a 54 Cookbook</h2>..T 02d0: 68 65 20 63 6f 6f 6b 62 6f 6f 6b 20 69 73 20 61 he cookbook is a 02e0: 20 74 61 73 6b 2d 6f 72 69 65 6e 74 65 64 20 70 task-oriented p 02f0: 6f 72 74 69 6f 6e 20 28 6c 69 6b 65 6c 79 20 6f ortion (likely o 0300: 6e 65 20 74 68 61 74 27 73 20 65 76 65 72 2d 65 ne that's ever-e 0310: 78 70 61 6e 64 69 6e 67 20 61 73 0d 0a 66 6f 73 xpanding as..fos 0320: 73 69 6c 20 69 73 20 69 6e 63 72 65 61 73 69 6e sil is increasin 0330: 67 6c 79 20 64 65 76 65 6c 6f 70 65 64 20 61 6e gly developed an 0340: 64 20 68 6f 6e 65 64 29 20 64 65 73 69 67 6e 65 d honed) designe 0350: 64 20 66 6f 72 20 61 20 75 73 65 72 20 77 68 6f d for a user who 0360: 20 68 61 73 20 62 61 73 69 63 0d 0a 73 6b 69 6c has basic..skil 0370: 6c 73 20 69 6e 20 75 73 69 6e 67 20 66 6f 73 73 ls in using foss 0380: 69 6c 20 28 6c 69 6b 65 2c 20 73 61 79 2c 20 6d il (like, say, m 0390: 65 29 20 62 75 74 20 69 73 6e 27 74 20 66 61 6d e) but isn't fam 03a0: 69 6c 69 61 72 20 77 69 74 68 20 61 6c 6c 20 74 iliar with all t 03b0: 68 65 20 66 61 6e 63 69 65 72 0d 0a 61 73 70 65 he fancier..aspe 03c0: 63 74 73 20 6f 66 20 69 74 20 61 6e 64 20 74 68 cts of it and th 03d0: 65 20 69 6e 6f 62 76 69 6f 75 73 20 77 6f 72 6b e inobvious work 03e0: 66 6c 6f 77 73 20 74 68 61 74 20 69 74 20 73 75 flows that it su 03f0: 70 70 6f 72 74 73 2e 20 20 45 61 63 68 20 22 72 pports. Each "r 0400: 65 63 69 70 65 22 20 28 75 73 65 0d 0a 63 61 73 ecipe" (use..cas 0410: 65 29 20 69 6e 20 74 68 65 20 63 6f 6f 6b 62 6f e) in the cookbo 0420: 6f 6b 20 73 68 6f 75 6c 64 20 66 6f 6c 6c 6f 77 ok should follow 0430: 20 61 20 66 6f 72 6d 61 74 20 77 69 74 68 20 74 a format with t 0440: 68 65 73 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 70 hese following p 0450: 6f 69 6e 74 73 3a 0d 0a 2a 20 53 75 63 63 69 6e oints:..* Succin 0460: 63 74 20 70 72 6f 62 6c 65 6d 20 73 74 61 74 65 ct problem state 0470: 6d 65 6e 74 2e 0d 0a 2a 20 44 65 74 61 69 6c 65 ment...* Detaile 0480: 64 20 73 74 61 74 65 6d 65 6e 74 20 6f 66 20 70 d statement of p 0490: 72 6f 62 6c 65 6d 20 61 6e 64 20 6d 6f 74 69 76 roblem and motiv 04a0: 61 74 69 6f 6e 20 66 6f 72 20 73 6f 6c 75 74 69 ation for soluti 04b0: 6f 6e 2e 0d 0a 2a 20 44 65 74 61 69 6c 65 64 20 on...* Detailed 04c0: 69 6e 73 74 72 75 63 74 69 6f 6e 73 20 28 3c 65 instructions (<e 04d0: 6d 3e 6e 6f 20 64 69 73 63 75 73 73 69 6f 6e 21 m>no discussion! 04e0: 3c 2f 65 6d 3e 29 20 66 6f 72 20 69 6d 70 6c 65 </em>) for imple 04f0: 6d 65 6e 74 69 6e 67 20 74 68 65 20 73 6f 6c 75 menting the solu 0500: 74 69 6f 6e 2e 0d 0a 2a 20 44 69 73 63 75 73 73 tion...* Discuss 0510: 69 6f 6e 20 6f 66 20 74 68 65 20 73 6f 6c 75 74 ion of the solut 0520: 69 6f 6e 20 69 6e 63 6c 75 64 69 6e 67 2c 20 69 ion including, i 0530: 66 20 61 70 70 6c 69 63 61 62 6c 65 2c 20 70 69 f applicable, pi 0540: 74 66 61 6c 6c 73 20 61 6e 64 20 0d 0a 61 6c 74 tfalls and ..alt 0550: 65 72 6e 61 74 69 76 65 73 2e 0d 0a 0d 0a 3c 68 ernatives.....<h 0560: 32 3e 52 65 66 65 72 65 6e 63 65 3c 2f 68 32 3e 2>Reference</h2> 0570: 0d 0a 54 68 65 20 72 65 66 65 72 65 6e 63 65 20 ..The reference 0580: 69 73 20 73 65 6c 66 2d 65 78 70 6c 61 6e 61 74 is self-explanat 0590: 6f 72 79 2e 20 20 42 61 73 69 63 61 6c 6c 79 20 ory. Basically 05a0: 74 61 6b 65 20 65 76 65 72 79 74 68 69 6e 67 20 take everything 05b0: 66 72 6f 6d 20 3c 63 6f 64 65 3e 66 6f 73 73 69 from <code>fossi 05c0: 6c 0d 0a 68 65 6c 70 20 2a 3c 2f 63 6f 64 65 3e l..help *</code> 05d0: 20 61 6e 64 20 70 75 74 20 69 74 20 68 65 72 65 and put it here 05e0: 2e 20 20 48 6f 77 65 76 65 72 2c 20 74 68 65 20 . However, the 05f0: 74 65 72 73 65 6e 65 73 73 20 6f 66 20 3c 63 6f terseness of <co 0600: 64 65 3e 66 6f 73 73 69 6c 0d 0a 68 65 6c 70 3c de>fossil..help< 0610: 2f 63 6f 64 65 3e 2c 20 77 68 69 6c 65 20 67 6f /code>, while go 0620: 6f 64 20 66 6f 72 20 61 20 71 75 69 63 6b 20 72 od for a quick r 0630: 65 6d 69 6e 64 65 72 20 61 74 20 74 68 65 20 63 eminder at the c 0640: 6f 6d 6d 61 6e 64 20 6c 69 6e 65 2c 20 69 73 20 ommand line, is 0650: 6e 6f 74 0d 0a 73 75 69 74 61 62 6c 65 20 66 6f not..suitable fo 0660: 72 20 22 72 65 61 6c 22 20 64 6f 63 75 6d 65 6e r "real" documen 0670: 74 61 74 69 6f 6e 2e 20 20 49 64 65 61 6c 6c 79 tation. Ideally 0680: 20 65 61 63 68 20 64 6f 63 75 6d 65 6e 74 65 64 each documented 0690: 20 65 6c 65 6d 65 6e 74 20 69 6e 20 74 68 65 0d element in the. 06a0: 0a 72 65 66 65 72 65 6e 63 65 20 73 68 6f 75 6c .reference shoul 06b0: 64 20 68 61 76 65 20 61 20 66 75 6c 6c 20 65 78 d have a full ex 06c0: 70 6c 61 6e 61 74 69 6f 6e 2c 20 69 6e 63 6c 75 planation, inclu 06d0: 64 69 6e 67 20 6c 69 6e 6b 73 20 74 6f 20 72 65 ding links to re 06e0: 6c 61 74 65 64 20 69 74 65 6d 73 2c 20 61 73 0d lated items, as. 06f0: 0a 77 65 6c 6c 20 61 73 20 3c 65 6d 3e 65 78 61 .well as <em>exa 0700: 6d 70 6c 65 73 3c 2f 65 6d 3e 2e 20 20 28 54 68 mples</em>. (Th 0710: 69 73 20 68 61 73 20 62 65 65 6e 20 77 68 61 74 is has been what 0720: 27 73 20 6b 69 6c 6c 69 6e 67 20 6d 65 20 77 69 's killing me wi 0730: 74 68 20 67 72 6f 6b 6b 69 6e 67 20 73 6f 6d 65 th grokking some 0740: 0d 0a 61 73 70 65 63 74 73 20 6f 66 20 66 6f 73 ..aspects of fos 0750: 73 69 6c 3a 20 49 20 6a 75 73 74 20 63 61 6e 27 sil: I just can' 0760: 74 20 66 69 67 75 72 65 20 6f 75 74 20 77 68 61 t figure out wha 0770: 74 20 74 68 65 79 20 64 6f 21 29 0d 0a 0d 0a 3c t they do!)....< 0780: 68 32 3e 44 65 76 65 6c 6f 70 65 72 20 47 75 69 h2>Developer Gui 0790: 64 65 3c 2f 68 32 3e 0d 0a 49 74 20 69 73 20 69 de</h2>..It is i 07a0: 6e 65 76 69 74 61 62 6c 65 20 74 68 61 74 20 70 nevitable that p 07b0: 65 6f 70 6c 65 20 77 69 6c 6c 20 77 61 6e 74 20 eople will want 07c0: 74 6f 20 73 74 61 72 74 20 62 75 69 6c 64 69 6e to start buildin 07d0: 67 20 74 68 69 72 64 2d 70 61 72 74 79 20 74 6f g third-party to 07e0: 6f 6c 73 20 74 68 61 74 0d 0a 69 6e 74 65 72 66 ols that..interf 07f0: 61 63 65 20 77 69 74 68 20 66 6f 73 73 69 6c 20 ace with fossil 0800: 61 73 20 66 6f 73 73 69 6c 20 67 65 74 73 20 6d as fossil gets m 0810: 6f 72 65 20 77 69 64 65 6c 79 20 61 64 6f 70 74 ore widely adopt 0820: 65 64 20 61 6e 64 20 6d 6f 72 65 20 6d 61 74 75 ed and more matu 0830: 72 65 2e 20 20 57 65 0d 0a 6d 69 67 68 74 20 61 re. We..might a 0840: 73 20 77 65 6c 6c 20 68 65 61 64 20 6f 66 66 20 s well head off 0850: 74 68 65 20 69 6e 65 76 69 74 61 62 6c 65 20 61 the inevitable a 0860: 6e 64 20 6c 65 74 20 64 65 76 65 6c 6f 70 65 72 nd let developer 0870: 73 20 68 61 76 65 20 74 68 65 20 69 6e 66 6f 72 s have the infor 0880: 6d 61 74 69 6f 6e 0d 0a 74 68 65 79 20 6e 65 65 mation..they nee 0890: 64 20 77 69 74 68 6f 75 74 20 74 65 61 72 69 6e d without tearin 08a0: 67 20 61 70 61 72 74 20 74 68 65 20 73 6f 75 72 g apart the sour 08b0: 63 65 20 74 6f 20 67 65 74 20 74 6f 20 69 74 2e ce to get to it. 08c0: 20 20 54 68 69 73 20 77 6f 75 6c 64 20 69 6e 63 This would inc 08d0: 6c 75 64 65 0d 0a 74 68 69 6e 67 73 20 6c 69 6b lude..things lik 08e0: 65 3a 0d 0a 2a 20 61 6e 79 20 41 50 49 73 20 69 e:..* any APIs i 08f0: 74 20 77 6f 75 6c 64 20 62 65 20 72 65 61 73 6f t would be reaso 0900: 6e 61 62 6c 65 20 74 6f 20 65 78 70 6f 73 65 0d nable to expose. 0910: 0a 2a 20 61 20 63 75 72 72 65 6e 74 2c 20 75 70 .* a current, up 0920: 2d 74 6f 2d 64 61 74 65 20 64 61 74 61 62 61 73 -to-date databas 0930: 65 20 73 63 68 65 6d 61 0d 0a 2a 20 6e 6f 74 65 e schema..* note 0940: 73 20 6f 6e 20 69 6e 6e 65 72 20 77 6f 72 6b 69 s on inner worki 0950: 6e 67 73 20 28 61 6c 72 65 61 64 79 20 73 75 70 ngs (already sup 0960: 70 6c 69 65 64 2c 20 62 75 74 20 6d 69 67 68 74 plied, but might 0970: 20 6e 65 65 64 20 64 75 73 74 69 6e 67 20 6f 66 need dusting of 0980: 66 20 61 6e 64 20 0d 0a 54 4c 43 29 0d 0a 2a 20 f and ..TLC)..* 0990: 61 6e 79 74 68 69 6e 67 20 65 6c 73 65 20 77 65 anything else we 09a0: 20 63 61 6e 20 74 68 69 6e 6b 20 6f 66 20 28 4c can think of (L 09b0: 75 61 2f 54 63 6c 2f 77 68 61 74 65 76 65 72 20 ua/Tcl/whatever 09c0: 62 69 6e 64 69 6e 67 73 3f 29 0d 0a 0a 5a 20 32 bindings?)...Z 2 09d0: 61 66 34 63 63 33 63 36 32 63 38 65 35 37 37 66 af4cc3c62c8e577f 09e0: 32 38 38 30 66 64 63 32 31 37 34 33 34 36 61 0a 2880fdc2174346a.