Hex Artifact Content
Not logged in

Artifact e767b80ae018454cc493d24c84537edab26fda0a:

File www/embeddeddoc.wiki part of check-in [9eb6ea75c1] - doc changes -- spelling corrections and embedded ref pages. by kejoki on 2008-11-11 03:50:39.

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  >&lt;baseurl&gt;
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&gt;</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>&lt;filen
0560: 61 6d 65 26 67 74 3b 3c 2f 69 3e 0a 3c 2f 62 6c  ame&gt;</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>&lt;baseurl&gt
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  &lt;baseurl&gt;<
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>&lt;b
06d0: 61 73 65 75 72 6c 26 67 74 3b 3c 2f 69 3e 20 69  aseurl&gt;</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  >&lt;version&gt;
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 62 61 73 65 6c 69 6e 65 20 49 44 20 66 6f 72   baseline ID for
0750: 20 0a 74 68 65 20 62 61 73 65 6c 69 6e 65 20 63   .the baseline 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>&lt;versio
07a0: 6e 26 67 74 3b 3c 2f 69 3e 20 63 61 6e 20 62 65  n&gt;</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 20 62 61 73 65 6c 69 6e  ecked-in baselin
0830: 65 2e 20 20 54 68 69 73 20 69 73 20 75 73 65 66  e.  This is usef
0840: 75 6c 20 69 66 20 79 6f 75 20 77 61 6e 74 20 74  ul if you want t
0850: 6f 20 73 65 65 20 74 68 65 20 76 65 72 79 20 6c  o see the very l
0860: 61 74 65 73 74 0a 76 65 72 73 69 6f 6e 20 6f 66  atest.version of
0870: 20 74 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69   the documentati
0880: 6f 6e 2e 20 20 54 68 65 20 22 3c 62 3e 63 6b 6f  on.  The "<b>cko
0890: 75 74 3c 2f 62 3e 22 20 6b 65 79 77 6f 72 64 73  ut</b>" keywords
08a0: 20 6d 65 61 6e 73 20 74 6f 0a 70 75 6c 6c 20 74   means to.pull t
08b0: 68 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e  he documentation
08c0: 20 66 69 6c 65 20 66 72 6f 6d 20 74 68 65 20 6c   file from the l
08d0: 6f 63 61 6c 20 73 6f 75 72 63 65 20 74 72 65 65  ocal source tree
08e0: 20 6f 6e 20 64 69 73 6b 2c 20 6e 6f 74 0a 66 72   on disk, not.fr
08f0: 6f 6d 20 74 68 65 20 61 6e 79 20 76 65 72 73 69  om the any versi
0900: 6f 6e 65 64 20 62 61 73 65 6c 69 6e 65 2e 20 20  oned baseline.  
0910: 54 68 65 20 22 3c 62 3e 63 6b 6f 75 74 3c 2f 62  The "<b>ckout</b
0920: 3e 22 20 6b 65 79 77 6f 72 64 20 6e 6f 72 6d 61  >" keyword norma
0930: 6c 6c 79 0a 6f 6e 6c 79 20 77 6f 72 6b 73 20 77  lly.only works w
0940: 68 65 6e 20 79 6f 75 20 73 74 61 72 74 20 79 6f  hen you start yo
0950: 75 72 20 73 65 72 76 65 72 20 75 73 69 6e 67 20  ur server using 
0960: 74 68 65 20 22 3c 62 3e 66 6f 73 73 69 6c 20 73  the "<b>fossil s
0970: 65 72 76 65 72 3c 2f 62 3e 22 0a 6f 72 20 22 3c  erver</b>".or "<
0980: 62 3e 66 6f 73 73 69 6c 20 75 69 3c 2f 62 3e 22  b>fossil ui</b>"
0990: 0a 63 6f 6d 6d 61 6e 64 20 6c 69 6e 65 20 61 6e  .command line an
09a0: 64 20 69 73 20 69 6e 64 65 6e 74 65 64 20 74 6f  d is indented to
09b0: 20 73 68 6f 77 20 77 68 61 74 20 74 68 65 20 64   show what the d
09c0: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 79 6f 75  ocumentation you
09d0: 20 61 72 65 20 63 75 72 72 65 6e 74 6c 79 0a 65   are currently.e
09e0: 64 69 74 69 6e 67 20 6c 6f 6f 6b 73 20 6c 69 6b  diting looks lik
09f0: 65 20 62 65 66 6f 72 65 20 79 6f 75 20 63 68 65  e before you che
0a00: 63 6b 20 69 74 20 69 6e 2e 0a 0a 46 69 6e 61 6c  ck it in...Final
0a10: 6c 79 2c 20 74 68 65 20 3c 69 3e 26 6c 74 3b 66  ly, the <i>&lt;f
0a20: 69 6c 65 6e 61 6d 65 26 67 74 3b 3c 2f 69 3e 20  ilename&gt;</i> 
0a30: 65 6c 65 6d 65 6e 74 20 6f 66 20 74 68 65 20 55  element of the U
0a40: 52 4c 20 69 73 20 74 68 65 20 66 75 6c 6c 0a 70  RL is the full.p
0a50: 61 74 68 6e 61 6d 65 20 6f 66 20 74 68 65 20 64  athname of the d
0a60: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 66 69 6c  ocumentation fil
0a70: 65 20 73 74 61 72 74 69 6e 67 20 66 72 6f 6d 20  e starting from 
0a80: 74 68 65 20 72 6f 6f 74 20 6f 66 20 74 68 65 20  the root of the 
0a90: 73 6f 75 72 63 65 0a 74 72 65 65 2e 0a 0a 54 68  source.tree...Th
0aa0: 65 20 6d 69 6d 65 74 79 70 65 20 28 61 6e 64 20  e mimetype (and 
0ab0: 74 68 75 73 20 74 68 65 20 72 65 6e 64 65 72 69  thus the renderi
0ac0: 6e 67 29 20 6f 66 20 64 6f 63 75 6d 65 6e 74 61  ng) of documenta
0ad0: 74 69 6f 6e 20 66 69 6c 65 73 20 69 73 20 0a 64  tion files is .d
0ae0: 65 74 65 72 6d 69 6e 65 64 20 62 79 20 74 68 65  etermined by the
0af0: 20 66 69 6c 65 20 73 75 66 66 69 78 2e 20 20 46   file suffix.  F
0b00: 6f 73 73 69 6c 20 63 75 72 72 65 6e 74 6c 79 20  ossil currently 
0b10: 75 6e 64 65 72 73 74 61 6e 64 73 20 31 39 32 0a  understands 192.
0b20: 64 69 66 66 65 72 65 6e 74 20 66 69 6c 65 20 73  different file s
0b30: 75 66 66 69 78 65 73 2c 20 69 6e 63 6c 75 64 69  uffixes, includi
0b40: 6e 67 20 61 6c 6c 20 74 68 65 20 70 6f 70 75 6c  ng all the popul
0b50: 61 72 20 6f 6e 65 73 20 73 75 63 68 20 61 73 0a  ar ones such as.
0b60: 22 2e 63 73 73 22 2c 20 22 2e 67 69 66 22 2c 20  ".css", ".gif", 
0b70: 22 2e 68 74 6d 22 2c 20 22 2e 68 74 6d 6c 22 2c  ".htm", ".html",
0b80: 20 22 2e 6a 70 67 22 2c 20 22 2e 6a 70 65 67 22   ".jpg", ".jpeg"
0b90: 2c 20 22 2e 70 6e 67 22 2c 20 61 6e 64 20 22 2e  , ".png", and ".
0ba0: 74 78 74 22 2e 0a 0a 44 6f 63 75 6d 65 6e 74 61  txt"...Documenta
0bb0: 74 69 6f 6e 20 66 69 6c 65 73 20 77 68 6f 73 65  tion files whose
0bc0: 20 6e 61 6d 65 73 20 65 6e 64 20 69 6e 20 22 2e   names end in ".
0bd0: 77 69 6b 69 22 20 75 73 65 20 74 68 65 20 0a 5b  wiki" use the .[
0be0: 2f 77 69 6b 69 5f 72 75 6c 65 73 20 7c 20 73 61  /wiki_rules | sa
0bf0: 6d 65 20 6d 61 72 6b 75 70 20 61 73 20 77 69 6b  me markup as wik
0c00: 69 20 70 61 67 65 73 5d 20 2d 0a 61 20 73 61 66  i pages] -.a saf
0c10: 65 20 73 75 62 73 65 74 20 6f 66 20 48 54 4d 4c  e subset of HTML
0c20: 20 74 6f 67 65 74 68 65 72 20 77 69 74 68 20 73   together with s
0c30: 6f 6d 65 20 72 75 6c 65 73 20 66 6f 72 20 70 61  ome rules for pa
0c40: 72 61 67 72 61 70 68 0a 62 72 65 61 6b 73 2c 20  ragraph.breaks, 
0c50: 6c 69 73 74 73 2c 20 61 6e 64 20 68 79 70 65 72  lists, and hyper
0c60: 6c 69 6e 6b 73 2e 20 20 54 68 65 20 22 2e 77 69  links.  The ".wi
0c70: 6b 69 22 20 61 6e 64 20 22 2e 74 78 74 22 20 70  ki" and ".txt" p
0c80: 61 67 65 73 0a 61 72 65 20 72 65 6e 64 65 72 65  ages.are rendere
0c90: 64 20 77 69 74 68 20 74 68 65 20 73 74 61 6e 64  d with the stand
0ca0: 61 72 64 20 66 6f 73 73 69 6c 20 68 65 61 64 65  ard fossil heade
0cb0: 72 20 61 6e 64 20 66 6f 6f 74 65 72 20 61 64 64  r and footer add
0cc0: 65 64 2e 0a 41 6c 6c 20 6f 74 68 65 72 20 6d 69  ed..All other mi
0cd0: 6d 65 74 79 70 65 73 20 61 72 65 20 64 65 6c 69  metypes are deli
0ce0: 76 65 72 65 64 20 64 69 72 65 63 74 6c 79 20 74  vered directly t
0cf0: 6f 20 74 68 65 20 72 65 71 75 65 73 74 69 6e 67  o the requesting
0d00: 0a 77 65 62 20 62 72 6f 77 73 65 72 20 77 69 74  .web browser wit
0d10: 68 6f 75 74 20 69 6e 74 65 72 70 72 65 74 61 74  hout interpretat
0d20: 69 6f 6e 2c 20 61 64 64 69 74 69 6f 6e 73 2c 20  ion, additions, 
0d30: 6f 72 20 63 68 61 6e 67 65 73 2e 0a 0a 3c 68 32  or changes...<h2
0d40: 3e 45 78 61 6d 70 6c 65 73 3c 2f 68 32 3e 0a 0a  >Examples</h2>..
0d50: 54 68 69 73 20 66 69 6c 65 20 74 68 61 74 20 79  This file that y
0d60: 6f 75 20 61 72 65 20 63 75 72 72 65 6e 74 6c 79  ou are currently
0d70: 20 72 65 61 64 69 6e 67 20 69 73 20 61 6e 20 65   reading is an e
0d80: 78 61 6d 70 6c 65 20 6f 66 0a 65 6d 62 65 64 64  xample of.embedd
0d90: 65 64 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e  ed documentation
0da0: 2e 20 20 54 68 65 20 6e 61 6d 65 20 6f 66 20 74  .  The name of t
0db0: 68 69 73 20 66 69 6c 65 20 69 6e 20 74 68 65 20  his file in the 
0dc0: 66 6f 73 73 69 6c 0a 73 6f 75 72 63 65 20 74 72  fossil.source tr
0dd0: 65 65 20 69 73 20 22 3c 62 3e 77 77 77 2f 65 6d  ee is "<b>www/em
0de0: 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 3c 2f  beddeddoc.wiki</
0df0: 62 3e 22 2e 0a 59 6f 75 20 61 72 65 20 70 65 72  b>"..You are per
0e00: 68 61 70 73 20 6c 6f 6f 6b 69 6e 67 20 61 74 20  haps looking at 
0e10: 74 68 69 73 0a 66 69 6c 65 20 75 73 69 6e 67 20  this.file using 
0e20: 74 68 65 20 55 52 4c 3a 0a 0a 20 20 20 5b 68 74  the URL:..   [ht
0e30: 74 70 3a 2f 2f 77 77 77 2e 66 6f 73 73 69 6c 2d  tp://www.fossil-
0e40: 73 63 6d 2e 6f 72 67 2f 69 6e 64 65 78 2e 68 74  scm.org/index.ht
0e50: 6d 6c 2f 64 6f 63 2f 74 69 70 2f 77 77 77 2f 65  ml/doc/tip/www/e
0e60: 6d 62 65 64 64 65 64 64 6f 63 2e 77 69 6b 69 5d  mbeddeddoc.wiki]
0e70: 2e 0a 0a 54 68 65 20 66 69 72 73 74 20 70 61 72  ...The first par
0e80: 74 20 6f 66 20 74 68 69 73 20 70 61 74 68 2c 20  t of this path, 
0e90: 74 68 65 20 22 5b 68 74 74 70 3a 2f 2f 77 77 77  the "[http://www
0ea0: 2e 66 6f 73 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f  .fossil-scm.org/
0eb0: 69 6e 64 65 78 2e 68 74 6d 6c 5d 22 2c 0a 69 73  index.html]",.is
0ec0: 20 74 68 65 20 62 61 73 65 20 55 52 4c 2e 20 20   the base URL.  
0ed0: 59 6f 75 20 6d 69 67 68 74 20 68 61 76 65 20 6f  You might have o
0ee0: 72 69 67 69 6e 61 6c 6c 79 20 74 79 70 65 64 3a  riginally typed:
0ef0: 0a 5b 68 74 74 70 3a 2f 2f 77 77 77 2e 66 6f 73  .[http://www.fos
0f00: 73 69 6c 2d 73 63 6d 2e 6f 72 67 2f 5d 2e 20 20  sil-scm.org/].  
0f10: 54 68 65 20 77 65 62 20 73 65 72 76 65 72 20 61  The web server a
0f20: 74 20 74 68 65 20 77 77 77 2e 66 6f 73 73 69 6c  t the www.fossil
0f30: 2d 73 63 6d 2e 6f 72 67 0a 73 69 74 65 20 61 75  -scm.org.site au
0f40: 74 6f 6d 61 74 69 63 61 6c 6c 79 20 72 65 64 69  tomatically redi
0f50: 72 65 63 74 73 20 73 75 63 68 20 6c 69 6e 6b 73  rects such links
0f60: 20 62 79 20 61 70 70 65 6e 64 69 6e 67 20 22 69   by appending "i
0f70: 6e 64 65 78 2e 68 74 6d 6c 22 2e 20 20 54 68 65  ndex.html".  The
0f80: 0a 22 69 6e 64 65 78 2e 68 74 6d 6c 22 20 66 69  ."index.html" fi
0f90: 6c 65 20 6f 6e 20 77 77 77 2e 66 6f 73 73 69 6c  le on www.fossil
0fa0: 2d 73 63 6d 2e 6f 72 67 20 69 73 20 72 65 61 6c  -scm.org is real
0fb0: 6c 79 20 61 20 43 47 49 20 73 63 72 69 70 74 0a  ly a CGI script.
0fc0: 28 64 6f 20 6e 6f 74 20 62 65 20 6d 69 73 6c 65  (do not be misle
0fd0: 61 64 20 62 79 20 74 68 65 20 6e 61 6d 65 29 20  ad by the name) 
0fe0: 77 68 69 63 68 20 72 75 6e 73 20 74 68 65 20 66  which runs the f
0ff0: 6f 73 73 69 6c 20 77 65 62 20 73 65 72 76 69 63  ossil web servic
1000: 65 20 69 6e 0a 43 47 49 20 6d 6f 64 65 2e 20 20  e in.CGI mode.  
1010: 54 68 65 20 22 69 6e 64 65 78 2e 68 74 6d 6c 22  The "index.html"
1020: 20 43 47 49 20 73 63 72 69 70 74 20 6c 6f 6f 6b   CGI script look
1030: 73 20 6c 69 6b 65 20 74 68 69 73 3a 0a 0a 3c 62  s like this:..<b
1040: 6c 6f 63 6b 71 75 6f 74 65 3e 3c 70 72 65 3e 0a  lockquote><pre>.
1050: 23 21 2f 75 73 72 2f 62 69 6e 2f 66 6f 73 73 69  #!/usr/bin/fossi
1060: 6c 0a 72 65 70 6f 73 69 74 6f 72 79 3a 20 2f 66  l.repository: /f
1070: 6f 73 73 69 6c 2f 66 6f 73 73 69 6c 2e 66 6f 73  ossil/fossil.fos
1080: 73 69 6c 0a 3c 2f 70 72 65 3e 3c 2f 62 6c 6f 63  sil.</pre></bloc
1090: 6b 71 75 6f 74 65 3e 0a 0a 54 68 69 73 20 69 73  kquote>..This is
10a0: 20 6f 6e 65 20 6f 66 20 74 68 72 65 65 20 77 61   one of three wa
10b0: 79 73 20 74 6f 20 73 65 74 20 75 70 20 61 20 0a  ys to set up a .
10c0: 3c 61 20 68 72 65 66 3d 22 71 75 69 63 6b 73 74  <a href="quickst
10d0: 61 72 74 2e 77 69 6b 69 23 73 65 72 76 65 72 73  art.wiki#servers
10e0: 65 74 75 70 22 3e 66 6f 73 73 69 6c 20 77 65 62  etup">fossil web
10f0: 20 73 65 72 76 65 72 3c 2f 61 3e 2e 0a 0a 54 68   server</a>...Th
1100: 65 20 22 3c 62 3e 2f 74 69 70 2f 3c 2f 62 3e 22  e "<b>/tip/</b>"
1110: 20 70 61 72 74 20 6f 66 20 74 68 65 20 55 52 4c   part of the URL
1120: 20 74 65 6c 6c 73 20 66 6f 73 73 69 6c 20 74 6f   tells fossil to
1130: 20 75 73 65 0a 74 68 65 20 64 6f 63 75 6d 65 6e   use.the documen
1140: 74 61 74 69 6f 6e 20 66 69 6c 65 73 20 66 72 6f  tation files fro
1150: 6d 20 74 68 65 20 62 61 73 65 6c 69 6e 65 20 74  m the baseline t
1160: 68 61 74 20 77 61 73 20 63 68 65 63 6b 65 64 20  hat was checked 
1170: 69 6e 20 6d 6f 73 74 0a 72 65 63 65 6e 74 6c 79  in most.recently
1180: 2e 20 20 54 68 69 73 20 66 69 6c 65 20 69 73 20  .  This file is 
1190: 73 74 6f 72 65 64 20 69 6e 20 74 68 65 20 66 6f  stored in the fo
11a0: 73 73 69 6c 20 73 6f 75 72 63 65 20 74 72 65 65  ssil source tree
11b0: 20 75 6e 64 65 72 0a 74 68 65 20 6e 61 6d 65 20   under.the name 
11c0: 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 65 64  "<b>www/embedded
11d0: 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 61 6e  doc.wiki</b>" an
11e0: 64 20 73 6f 20 74 68 61 74 20 6e 61 6d 65 20 66  d so that name f
11f0: 6f 72 6d 73 20 74 68 65 0a 6c 61 73 74 20 70 61  orms the.last pa
1200: 72 74 20 6f 66 20 74 68 65 20 55 52 4c 2e 0a 0a  rt of the URL...
1210: 41 73 20 49 20 73 69 74 20 77 72 69 74 69 6e 67  As I sit writing
1220: 20 74 68 69 73 20 64 6f 63 75 6d 65 6e 74 61 74   this documentat
1230: 69 6f 6e 20 66 69 6c 65 2c 20 49 20 61 6d 20 74  ion file, I am t
1240: 65 73 74 69 6e 67 20 6d 79 20 77 6f 72 6b 20 62  esting my work b
1250: 79 0a 72 75 6e 6e 69 6e 67 20 74 68 65 20 22 3c  y.running the "<
1260: 62 3e 66 6f 73 73 69 6c 20 73 65 72 76 65 72 3c  b>fossil server<
1270: 2f 62 3e 22 20 63 6f 6d 6d 61 6e 64 20 6c 69 6e  /b>" command lin
1280: 65 20 61 6e 64 20 76 69 65 77 69 6e 67 0a 3c 62  e and viewing.<b
1290: 3e 68 74 74 70 3a 2f 2f 6c 6f 63 61 6c 68 6f 73  >http://localhos
12a0: 74 3a 38 30 38 30 2f 64 6f 63 2f 63 6b 6f 75 74  t:8080/doc/ckout
12b0: 2f 77 77 77 2f 65 6d 62 65 64 64 65 64 64 6f 63  /www/embeddeddoc
12c0: 2e 77 69 6b 69 3c 2f 62 3e 20 69 6e 0a 46 69 72  .wiki</b> in.Fir
12d0: 65 66 6f 78 2e 20 20 49 20 61 6d 20 64 6f 69 6e  efox.  I am doin
12e0: 67 20 74 68 69 73 20 65 76 65 6e 20 74 68 6f 75  g this even thou
12f0: 67 68 20 49 20 68 61 76 65 20 6e 6f 74 20 79 65  gh I have not ye
1300: 74 20 63 68 65 63 6b 65 64 20 69 6e 0a 74 68 65  t checked in.the
1310: 20 22 3c 62 3e 77 77 77 2f 65 6d 62 65 64 64 65   "<b>www/embedde
1320: 64 64 6f 63 2e 77 69 6b 69 3c 2f 62 3e 22 20 66  ddoc.wiki</b>" f
1330: 69 6c 65 20 66 6f 72 20 74 68 65 20 66 69 72 73  ile for the firs
1340: 74 20 74 69 6d 65 2e 20 20 55 73 69 6e 67 0a 74  t time.  Using.t
1350: 68 65 20 73 70 65 63 69 61 6c 20 22 3c 62 3e 63  he special "<b>c
1360: 6b 6f 75 74 3c 2f 62 3e 22 20 76 65 72 73 69 6f  kout</b>" versio
1370: 6e 20 69 64 65 6e 74 69 66 69 65 72 20 6f 6e 20  n identifier on 
1380: 74 68 65 20 22 3c 62 3e 2f 64 6f 63 3c 2f 62 3e  the "<b>/doc</b>
1390: 22 20 70 61 67 65 0a 69 74 20 69 73 20 65 61 73  " page.it is eas
13a0: 79 20 74 6f 20 6d 61 6b 65 20 6d 75 6c 74 69 70  y to make multip
13b0: 6c 65 20 63 68 61 6e 67 65 73 20 74 6f 20 6d 75  le changes to mu
13c0: 6c 74 69 70 6c 65 20 66 69 6c 65 73 20 61 6e 64  ltiple files and
13d0: 20 73 65 65 20 68 6f 77 20 74 68 65 79 20 61 6c   see how they al
13e0: 6c 0a 6c 6f 6f 6b 20 74 6f 67 65 74 68 65 72 20  l.look together 
13f0: 62 65 66 6f 72 65 20 63 6f 6d 6d 69 74 74 69 6e  before committin
1400: 67 20 61 6e 79 74 68 69 6e 67 20 74 6f 20 74 68  g anything to th
1410: 65 20 72 65 70 6f 73 69 74 6f 72 79 2e 0a        e repository..