Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 82 lines (66 sloc) 2.93 kb
8dbde0b @docelic - Makefile:
docelic authored
1
81e9a5e @docelic refs/area:
docelic authored
2 PRIMARY:
3 - agree on rules for writing Synopsis lines (should be flexible enough to
4 support all symbol types in an uniform way)
5 - rewrite bin/refs-autogen
a6a00ca @docelic LARGE COMMIT:
docelic authored
6 - Make docbook/symbol-type-skel/* contents of a glossary, and display a
7 glossary entry instead of those files.
81e9a5e @docelic refs/area:
docelic authored
8 - Under availability, if applicable, display cvs line (modification time,
9 username and version (cvs line)).
10 - Support using refs/<filename> with all the documentation for a symbol
11 instead of refs/<directory>/<files>.
12
13
14 DOCUMENTATION SYSTEM:
7b35729 @docelic - Makefile: added support for howtos
docelic authored
15 - bin/stattree, in format_ctx(), see how many spacings all the lines have
970185e @docelic - bin/refs-autogen:
docelic authored
16 in common, and trim that from the beginning.
7ad2299 @docelic - bin/refs-autogen:
docelic authored
17 - why in manpage format, comments at the top of the file are messed up (no
18 linebreaks)
970185e @docelic - bin/refs-autogen:
docelic authored
19 - Seems like there's no CSS selector to make a difference between an Example
20 element title, and Screen element title. (This causes source contexts
21 to be prefixed with "Example: ", although they're technically not).
22 - Add support to document tags which are NOT found in separate files
81e9a5e @docelic refs/area:
docelic authored
23 (like [restrict] or [subject]).
e8f63ad @docelic - bin/stattree:
docelic authored
24 - Read all possible options for tag files from vend/config.pm
25 (%tag.* structures) and warn if invalid option is found in any tag file.
a6a00ca @docelic LARGE COMMIT:
docelic authored
26
81e9a5e @docelic refs/area:
docelic authored
27 iccattut:
28 - give examples for the tasks in 'do yourself' section
29 - give good practices about filtering, security
fbf7c6b @docelic - guides/iccattut.xml: corrections found by aspell
docelic authored
30
31 GLOSSARY:
81e9a5e @docelic refs/area:
docelic authored
32 tag, interpolation, reparse, symbol types
fbf7c6b @docelic - guides/iccattut.xml: corrections found by aspell
docelic authored
33
dc2ec38 @docelic - Makefile:
docelic authored
34 Mid-term:
35 - Think about adding "online example" (role=html in combination with
36 a flag that says if html is to be static or for hosting on IC-enabled site)
37 - for "online" docs, also provide a form where users can add comments or
38 ask for clarification. (this could be done with either pure IC (forum?), or
7b35729 @docelic - Makefile: added support for howtos
docelic authored
39 XML forms capability, or wiki?)..
09c6b9a @docelic - bin/stattree and bin/refs-autogen:
docelic authored
40 - in html, make source contexts "rollable" by either using some css
41 properties or javascript. this is not really needed when you only have
7b35729 @docelic - Makefile: added support for howtos
docelic authored
42 say, 15 lines of context, but it'll come great when you have a copy
43 of a 300-lines usertag. Example for this could be taken directly out of
44 mwforum demo on mwforum.org
dc2ec38 @docelic - Makefile:
docelic authored
45
8dbde0b @docelic - Makefile:
docelic authored
46 Long-term:
7b35729 @docelic - Makefile: added support for howtos
docelic authored
47 - filenames in Source contexts should also be clickable. this is longterm
48 because it'll involve perltidy and other stuff I have in mind ...
8dbde0b @docelic - Makefile:
docelic authored
49
50 DOCUMENTATION ITSELF:
51 - Resolve items from tmp/missing file. (You need to run 'make' in your tree
dc2ec38 @docelic - Makefile:
docelic authored
52 first, to get that file generated). I did what I could, now the list only
7b35729 @docelic - Makefile: added support for howtos
docelic authored
53 contains items which don't even exist in the old docs, so I can't copy/paste;
54 someone who is able to write the description/examples from scratch should
55 do that.
dc2ec38 @docelic - Makefile:
docelic authored
56
57
7b35729 @docelic - Makefile: added support for howtos
docelic authored
58 <epigraph>
59 <attribution>William Safire</attribution>
60 <para>
61 Knowing how things work is the basis for appreciation, and is
62 thus a source of civilized delight.
63 </para>
64 </epigraph>
7ad2299 @docelic - bin/refs-autogen:
docelic authored
65
e8f63ad @docelic - bin/stattree:
docelic authored
66
67 ######################################################################
68
69 Pragmas, globvars:
70 default
71
72 Tags:
73 parameters
81e9a5e @docelic refs/area:
docelic authored
74 positional list
75 invalidates cache
76 aliases
77 tag call / perl call / mvasp
78 container
79 has subtags
80 nests
e8f63ad @docelic - bin/stattree:
docelic authored
81
Something went wrong with that request. Please try again.