Hex Artifact Content
Not logged in
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to tclconference@googlegroups.com
or submit via the online form by Sep 9.

Artifact baa25578450cef7a068d9e9ce79926850ba85e4f:


0000: 5b 68 74 6d 6c 3a 3a 64 65 73 63 72 69 70 74 69  [html::descripti
0010: 6f 6e 20 22 74 63 6c 68 74 74 70 64 20 46 41 51  on "tclhttpd FAQ
0020: 20 67 65 6e 65 72 61 74 6f 72 20 46 41 51 22 5d   generator FAQ"]
0030: 0a 5b 68 74 6d 6c 3a 3a 6b 65 79 77 6f 72 64 73  .[html::keywords
0040: 20 5d 0a 5b 68 74 6d 6c 3a 3a 61 75 74 68 6f 72   ].[html::author
0050: 20 22 43 6f 6c 69 6e 20 4d 63 43 6f 72 6d 61 63   "Colin McCormac
0060: 6b 22 5d 0a 5b 6d 79 70 61 67 65 3a 3a 68 65 61  k"].[mypage::hea
0070: 64 65 72 20 22 74 63 6c 68 74 74 70 64 20 46 41  der "tclhttpd FA
0080: 51 20 67 65 6e 65 72 61 74 6f 72 20 46 41 51 22  Q generator FAQ"
0090: 5d 0a 0a 5b 46 41 51 69 6e 69 74 20 22 74 63 6c  ]..[FAQinit "tcl
00a0: 68 74 74 70 64 20 46 41 51 20 46 41 51 22 5d 0a  httpd FAQ FAQ"].
00b0: 0a 3c 21 2d 2d 20 74 68 65 20 46 41 51 20 63 61  .<!-- the FAQ ca
00c0: 6c 6c 73 20 72 65 74 75 72 6e 20 61 20 76 61 6c  lls return a val
00d0: 75 65 20 74 68 61 74 20 69 73 20 74 68 65 20 73  ue that is the s
00e0: 65 63 74 69 6f 6e 0a 20 20 20 20 20 6f 72 20 71  ection.     or q
00f0: 75 65 73 74 69 6f 6e 20 49 44 2e 20 20 54 68 69  uestion ID.  Thi
0100: 73 20 63 6f 6d 6d 65 6e 74 20 68 69 64 65 73 20  s comment hides 
0110: 74 68 65 6d 3a 0a 0a 5b 46 41 51 73 65 63 74 69  them:..[FAQsecti
0120: 6f 6e 20 22 47 65 6e 65 72 61 6c 20 51 75 65 73  on "General Ques
0130: 74 69 6f 6e 73 22 5d 0a 5b 46 41 51 20 22 57 68  tions"].[FAQ "Wh
0140: 61 74 20 69 73 20 69 74 3f 22 20 22 54 68 65 20  at is it?" "The 
0150: 46 41 51 20 70 61 63 6b 61 67 65 20 61 6c 6c 6f  FAQ package allo
0160: 77 73 20 79 6f 75 20 74 6f 20 70 72 65 73 65 6e  ws you to presen
0170: 74 20 46 41 51 73 20 77 69 74 68 20 6d 69 6e 69  t FAQs with mini
0180: 6d 61 6c 20 0a 66 75 73 73 2e 20 20 49 74 20 72  mal .fuss.  It r
0190: 75 6e 73 20 75 6e 64 65 72 20 74 63 6c 68 74 74  uns under tclhtt
01a0: 70 64 2e 22 5d 0a 0a 5b 46 41 51 20 22 48 6f 77  pd."]..[FAQ "How
01b0: 20 64 6f 20 49 20 75 73 65 20 69 74 20 66 72 6f   do I use it fro
01c0: 6d 20 2e 74 6d 6c 3f 22 20 7b 0a 20 20 20 20 20  m .tml?" {.     
01d0: 20 20 20 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67     The following
01e0: 20 73 74 72 75 63 74 75 72 65 20 75 6e 64 65 72   structure under
01f0: 20 2e 74 6d 6c 20 77 69 6c 6c 20 70 72 6f 64 75   .tml will produ
0200: 63 65 20 61 20 62 65 61 75 74 69 66 75 6c 20 46  ce a beautiful F
0210: 41 51 20 70 61 67 65 0a 20 20 20 20 20 20 20 20  AQ page.        
0220: 3c 70 3e 5b 46 41 51 69 6e 69 74 20 22 6e 61 6d  <p>[FAQinit "nam
0230: 65 20 6f 66 20 46 41 51 22 5d 0a 20 20 20 20 20  e of FAQ"].     
0240: 20 20 20 3c 70 3e 5b 46 41 51 73 65 63 74 69 6f     <p>[FAQsectio
0250: 6e 20 22 6e 61 6d 65 20 6f 66 20 73 65 63 74 69  n "name of secti
0260: 6f 6e 22 5d 0a 20 20 20 20 20 20 20 20 3c 70 3e  on"].        <p>
0270: 5b 46 41 51 20 22 71 75 65 73 74 69 6f 6e 22 20  [FAQ "question" 
0280: 22 61 6e 73 77 65 72 22 5d 0a 20 20 20 20 20 20  "answer"].      
0290: 20 20 3c 70 3e 2e 2e 2e 0a 20 20 20 20 20 20 20    <p>....       
02a0: 20 3c 70 3e 5b 46 41 51 73 65 63 74 69 6f 6e 20   <p>[FAQsection 
02b0: 22 6e 61 6d 65 20 6f 66 20 6e 65 78 74 20 73 65  "name of next se
02c0: 63 74 69 6f 6e 22 5d 0a 20 20 20 20 20 20 20 20  ction"].        
02d0: 3c 70 3e 2e 2e 2e 0a 20 20 20 20 20 20 20 20 3c  <p>....        <
02e0: 70 3e 5b 46 41 51 67 65 6e 5d 0a 7d 5d 0a 0a 5b  p>[FAQgen].}]..[
02f0: 46 41 51 20 22 57 68 61 74 20 66 61 63 69 6c 69  FAQ "What facili
0300: 74 69 65 73 20 64 6f 65 73 20 69 74 20 70 72 6f  ties does it pro
0310: 76 69 64 65 3f 22 20 22 41 6d 6f 6e 67 20 6f 74  vide?" "Among ot
0320: 68 65 72 20 74 68 69 6e 67 73 2c 20 69 74 27 6c  her things, it'l
0330: 6c 20 70 72 6f 64 75 63 65 20 61 6e 20 0a 49 6e  l produce an .In
0340: 64 65 78 2c 20 69 74 27 6c 6c 20 67 65 6e 65 72  dex, it'll gener
0350: 61 74 65 20 69 6e 74 65 72 6e 61 6c 20 68 74 6d  ate internal htm
0360: 6c 20 72 65 66 65 72 65 6e 63 65 73 20 74 6f 20  l references to 
0370: 73 65 63 74 69 6f 6e 73 20 61 6e 64 20 71 75 65  sections and que
0380: 73 74 69 6f 6e 73 2c 20 0a 69 74 27 6c 6c 20 68  stions, .it'll h
0390: 61 6e 64 6c 65 20 74 68 65 20 6e 75 6d 62 65 72  andle the number
03a0: 69 6e 67 2c 20 61 6e 64 20 69 74 27 6c 6c 20 6c  ing, and it'll l
03b0: 65 74 20 79 6f 75 20 67 65 6e 65 72 61 74 65 20  et you generate 
03c0: 6c 69 6e 6b 73 20 74 6f 20 65 61 63 68 20 6f 66  links to each of
03d0: 20 74 68 65 73 65 20 0a 69 6e 64 65 78 61 62 6c   these .indexabl
03e0: 65 20 65 6c 65 6d 65 6e 74 73 2e 22 5d 0a 0a 5b  e elements."]..[
03f0: 46 41 51 20 22 57 6f 75 6c 64 6e 27 74 20 74 68  FAQ "Wouldn't th
0400: 69 73 20 66 6f 72 6d 61 74 20 62 65 20 74 65 72  is format be ter
0410: 72 69 62 6c 79 20 65 61 73 79 20 74 6f 20 67 65  ribly easy to ge
0420: 6e 65 72 61 74 65 20 66 72 6f 6d 20 61 20 74 65  nerate from a te
0430: 78 74 20 66 69 6c 65 3f 22 20 5c 0a 22 59 65 73  xt file?" \."Yes
0440: 2c 20 69 74 20 77 6f 75 6c 64 2e 20 20 41 6e 64  , it would.  And
0450: 20 74 68 65 20 74 65 78 74 20 66 69 6c 65 20 63   the text file c
0460: 6f 75 6c 64 20 62 65 20 67 65 6e 65 72 61 74 65  ould be generate
0470: 64 20 66 72 6f 6d 20 66 6f 72 6d 73 2e 20 20 49  d from forms.  I
0480: 74 27 64 20 62 65 20 61 20 0a 76 65 72 79 20 6e  t'd be a .very n
0490: 69 63 65 2c 20 73 69 6d 70 6c 65 20 46 41 51 6f  ice, simple FAQo
04a0: 6d 61 74 69 63 2e 22 5d 0a 0a 5b 46 41 51 73 65  matic."]..[FAQse
04b0: 63 74 69 6f 6e 20 22 44 65 74 61 69 6c 65 64 20  ction "Detailed 
04c0: 51 75 65 73 74 69 6f 6e 73 22 5d 0a 5b 46 41 51  Questions"].[FAQ
04d0: 20 22 53 68 6f 75 6c 64 6e 27 74 20 74 68 65 72   "Shouldn't ther
04e0: 65 20 62 65 20 73 6f 6d 65 20 64 65 74 61 69 6c  e be some detail
04f0: 65 64 20 65 78 70 6c 61 6e 61 74 69 6f 6e 20 68  ed explanation h
0500: 65 72 65 20 6f 66 20 65 61 63 68 20 65 78 70 6f  ere of each expo
0510: 72 74 65 64 20 0a 66 75 6e 63 74 69 6f 6e 20 66  rted .function f
0520: 72 6f 6d 20 46 41 51 3f 22 20 22 59 65 70 2c 20  rom FAQ?" "Yep, 
0530: 74 68 65 72 65 20 63 65 72 74 61 69 6e 6c 79 20  there certainly 
0540: 73 68 6f 75 6c 64 2e 22 5d 0a 0a 5b 46 41 51 73  should."]..[FAQs
0550: 65 63 74 69 6f 6e 20 22 55 6e 61 6e 73 77 65 72  ection "Unanswer
0560: 65 64 20 51 75 65 73 74 69 6f 6e 73 22 5d 0a 5b  ed Questions"].[
0570: 46 41 51 20 22 57 68 61 74 20 69 73 20 74 68 65  FAQ "What is the
0580: 20 5c 22 53 31 20 51 31 2e 31 20 51 31 2e 32 20   \"S1 Q1.1 Q1.2 
0590: 51 31 2e 33 20 53 32 20 51 32 2e 31 20 51 32 2e  Q1.3 S2 Q2.1 Q2.
05a0: 32 5c 22 20 61 63 72 6f 73 73 20 74 68 65 20 74  2\" across the t
05b0: 6f 70 2c 20 6a 75 73 74 20 0a 75 6e 64 65 72 20  op, just .under 
05c0: 74 68 65 20 68 65 61 64 69 6e 67 3f 22 20 22 54  the heading?" "T
05d0: 68 69 73 20 69 73 20 67 6f 6e 65 20 6e 6f 77 2c  his is gone now,
05e0: 20 68 69 64 69 6e 67 0a 69 6e 73 69 64 65 20 61   hiding.inside a
05f0: 6e 20 48 54 4d 4c 20 63 6f 6d 6d 65 6e 74 2e 20  n HTML comment. 
0600: 20 54 68 65 20 46 41 51 73 65 63 74 69 6f 6e 20   The FAQsection 
0610: 61 6e 64 20 46 41 51 20 70 72 6f 63 65 64 75 72  and FAQ procedur
0620: 65 73 0a 72 65 74 75 72 6e 20 73 65 63 74 69 6f  es.return sectio
0630: 6e 20 61 6e 64 20 71 75 65 73 74 69 6f 6e 20 6e  n and question n
0640: 75 6d 62 65 72 73 20 74 68 61 74 20 79 6f 75 27  umbers that you'
0650: 6c 6c 20 77 61 6e 74 20 74 6f 20 63 6f 6d 6d 65  ll want to comme
0660: 6e 74 20 6f 75 74 2e 22 5d 0a 0a 5b 46 41 51 73  nt out."]..[FAQs
0670: 65 63 74 69 6f 6e 20 22 53 69 6c 6c 79 20 51 75  ection "Silly Qu
0680: 65 73 74 69 6f 6e 73 22 5d 0a 5b 46 41 51 20 22  estions"].[FAQ "
0690: 57 68 79 20 69 73 20 74 68 69 73 20 73 65 63 74  Why is this sect
06a0: 69 6f 6e 20 68 65 72 65 3f 22 20 22 49 20 77 61  ion here?" "I wa
06b0: 6e 74 65 64 20 74 68 65 20 46 41 51 20 74 6f 20  nted the FAQ to 
06c0: 64 65 6d 6f 6e 73 74 72 61 74 65 20 73 65 63 74  demonstrate sect
06d0: 69 6f 6e 20 0a 73 74 72 75 63 74 75 72 65 22 5d  ion .structure"]
06e0: 0a 5b 46 41 51 20 22 48 6f 77 20 6c 6f 6e 67 20  .[FAQ "How long 
06f0: 64 69 64 20 74 68 69 73 20 74 61 6b 65 20 79 6f  did this take yo
0700: 75 20 74 6f 20 77 72 69 74 65 20 74 68 69 73 20  u to write this 
0710: 46 41 51 3f 22 20 22 53 6f 6d 65 74 68 69 6e 67  FAQ?" "Something
0720: 20 75 6e 64 65 72 20 35 20 0a 6d 69 6e 75 74 65   under 5 .minute
0730: 73 2e 22 5d 0a 0a 4a 75 73 74 20 62 65 66 6f 72  s."]..Just befor
0740: 65 20 46 41 51 67 65 6e 20 2d 2d 3e 0a 0a 5b 46  e FAQgen -->..[F
0750: 41 51 67 65 6e 5d 0a 0a 5b 6d 79 70 61 67 65 3a  AQgen]..[mypage:
0760: 3a 66 6f 6f 74 65 72 5d 0a                       :footer].