Skip to content
Newer
Older
100644 169 lines (136 sloc) 6.76 KB
bf62651 @docelic * Described link program in glossary
docelic authored
1 on xmldocs, link to icdevgroup.org base site
2
c52871f @docelic Some new items, good stuff.
docelic authored
3 Outstanding:
4 =======
4946375 @docelic - An easy commit to break the summer silence.
docelic authored
5 - Can *_page pragmas take ITL and not just subroutine names?
d458e36 @docelic - Documented few filters
docelic authored
6 - See that if 'crypt' is put in see also, all symbols of that name appear
7 in see also line and their type is distinguished visually.
fb2f4cb @docelic - one more glossary entry
docelic authored
8 - TAXAREA is not discovered in source by bin/stattree
9 - toc in glossary
f176a7c @docelic The usual accompanying improvements
docelic authored
10 - Make MapRoutined source contexts have Line: x-y instead of Lines: z header.
fb2f4cb @docelic - one more glossary entry
docelic authored
11 - make glossary,howto items also appear as symbols, so that you can put
12 their names in See Also and get generated links
13 - recognize situations where contexts overlap, but in a special way that
14 first example does not see the other, but the other sees the first becase
15 of 10 lines of pre-context. (example is IMAGE_MOGRIFY refentry). In those
16 cases, resize area of the context report so that it appears as one
f176a7c @docelic The usual accompanying improvements
docelic authored
17 - With confs, also include source context where it is being used
18 - Enhance stuff with acronyms
19 - Under AUTHORS, include cvs line where appropriate (guides, howtos, gloss... )
20 - In vars.html, include line if it appears in variable.txt
8a8fb40 @docelic As usual, I am wonderful ;-) Here's the reason this time:
docelic authored
21 - why email, email-raw, SendMailProgram produce errors about usertags olink ID
656e8f1 @docelic Phew, a large commit; glossary/ITL took me 4 hours.
docelic authored
22 - Add docbook element to reference mailing list posts. Something like
23 <ml list='users'>2004-December/041539</ml>, it expands to:
24 <ulink url="http://www.icdevgroup.org/pipermail/interchange-users/2004-December/041539.html">2004-December/041539</ulink>.
9cc5ea7 @docelic - Cleaned some TODO items and reorganized TODO a bit
docelic authored
25 - match style (no starting verb or all starting verbs) in all Example titles
26 - check if all Default fields are properly formated (<literal> or none)
d2c6eee @docelic - Makefile: remove dependence on bin/stattree
docelic authored
27 - make regexp matching better, to properly scan parse_subroutine(); (gets
28 confused by { { in a substitution)
29 - in refs, replace "database" with "database_name", that kind of things
30 - import my hand-made test from /var/lib/.../pages/* to appropriate
31 ref pages as online examples
32 - At least in filters, <<EOR messes up the thing, only < is printed and stops
d458e36 @docelic - Documented few filters
docelic authored
33
34 Coding:
e680b7a @docelic - bin/stattree:
docelic authored
35 - script to [un]comment debug lines!!
238f9d5 @docelic - Added Interchange FAQ document ( guides/faq.xml ).
docelic authored
36 - use Interchange.pm to make an Interchange shell (External.pm!)
37 - finish ML stats <-- MAILPOND on ocelic2!
9cc5ea7 @docelic - Cleaned some TODO items and reorganized TODO a bit
docelic authored
38
81e9a5e @docelic refs/area:
docelic authored
39 DOCUMENTATION SYSTEM:
970185e @docelic - bin/refs-autogen:
docelic authored
40 - Add support to document tags which are NOT found in separate files
81e9a5e @docelic refs/area:
docelic authored
41 (like [restrict] or [subject]).
fbf7c6b @docelic - guides/iccattut.xml: corrections found by aspell
docelic authored
42
cb13dd7 @docelic - TODO: Updated TODO entry
docelic authored
43 TODO: Create a pre-processor for the "docbook/docbookxi.dtd" and
44 "docbook/olinkdb*xml" files that would automatically discover the path to
45 the "docbookx.dtd" and "targetdatabase.dtd" files. Running a find(1) in
46 "/usr/share" should do the trick on most GNU/Linux OSs, and will remove
47 the need for distro-specific patches that will quickly grow stale due
48 to package version number changes.
49
dc2ec38 @docelic - Makefile:
docelic authored
50 Mid-term:
c52871f @docelic Some new items, good stuff.
docelic authored
51 - Ask ndw about including [NEW!] and [TODO!] in titles in TOC. --> This is a
52 bug and it will work when they fix it.
f176a7c @docelic The usual accompanying improvements
docelic authored
53 - &glos-hello-world needs to give "hello world", not "hello-world" as text
2767140 @docelic - Makefile: remove ordercheckout document which I'll decompose to dif…
docelic authored
54 - List of mv_s, descriptions and shortcuts
dc2ec38 @docelic - Makefile:
docelic authored
55 - for "online" docs, also provide a form where users can add comments or
56 ask for clarification. (this could be done with either pure IC (forum?), or
7b35729 @docelic - Makefile: added support for howtos
docelic authored
57 XML forms capability, or wiki?)..
09c6b9a @docelic - bin/stattree and bin/refs-autogen:
docelic authored
58 - in html, make source contexts "rollable" by either using some css
59 properties or javascript. this is not really needed when you only have
7b35729 @docelic - Makefile: added support for howtos
docelic authored
60 say, 15 lines of context, but it'll come great when you have a copy
61 of a 300-lines usertag. Example for this could be taken directly out of
62 mwforum demo on mwforum.org
16b446f @docelic - Makefile:
docelic authored
63 - Generate leaf nodes (put bin/mkreport back in action)
d458e36 @docelic - Documented few filters
docelic authored
64 - If filter returns Vend::xxx::something(), include that function in context
65 reports, and try to determine the "Uses" field (which also needs to be
66 added to filter refentry template or something)
e8f63ad @docelic - bin/stattree:
docelic authored
67
68 Tags:
81e9a5e @docelic refs/area:
docelic authored
69 aliases
70 tag call / perl call / mvasp
71 container
72 has subtags
73 nests
e8f63ad @docelic - bin/stattree:
docelic authored
74
e680b7a @docelic - bin/stattree:
docelic authored
75
76
e976408 @docelic Evening commit
docelic authored
77 Ideas:
e680b7a @docelic - bin/stattree:
docelic authored
78 - In db_columns: add exlude_columns= parameter?
e976408 @docelic Evening commit
docelic authored
79 - New docs:
80 - promotional
81 - new developer howto
82 - filenames in Source contexts should also be clickable. this is longterm
83 because it'll involve perltidy and other stuff I have in mind ...
c52871f @docelic Some new items, good stuff.
docelic authored
84 - CVS page: http://www.icdevgroup.org/i/dev/cvs.html?id=auxbUMnz
85 Make a tutorial : IC from CVS, Catalog in SVN, replicated setup online
86 and locally
87 - How to deal with Safe
88 Programming guidelines doc - integrate with programming style. Advise
89 programmers of choices to make in order to make their code play well with
90 IC - for example, if they want to have a field in the DB for images,
91 advise them to name the column 'image' because other tags (they might or
92 might not later use) take that as default value. etc...
93 guide on setting complete IC environment
94 explain version naming.. stable/unstable and how 5.3.0 implies next stable
95 Documentation on how to create replicated catalog online and at your
96 desktop machine for ultimate convenience.
5f3f31f @docelic - Some new stuff, some placeholders, some updates/fixes to existing f…
docelic authored
97 - Whereever we count things, (like, valid Locale keys are decimal_point,
98 mon_grouping, price_picture,n_cs_precedes etc.) make that information
99 derived by scripting in stattree, not manually counting
e976408 @docelic Evening commit
docelic authored
100
e680b7a @docelic - bin/stattree:
docelic authored
101
e976408 @docelic Evening commit
docelic authored
102 Notes:
103 - say that code is colorful collection of time and people, so docs try to fill
e680b7a @docelic - bin/stattree:
docelic authored
104 the gap.
e976408 @docelic Evening commit
docelic authored
105 - say that even though sometimes the code looks ugly/unreadable, check 3 times before thinking it's a bug
106 - ** Dan Browning: clustering howto, tuning tips (by Mike),
107 - jedit + IC colorization, commit-to-live script,
108 - Racke: performance docs NEEDED, clustering my mike needs funding or he
109 won't do it. CVS howto is browning.
f176a7c @docelic The usual accompanying improvements
docelic authored
110
111
e976408 @docelic Evening commit
docelic authored
112 - "In times of universal deceit, telling the truth becomes
113 a revolutionary act." -- George Orwell.
114 - For a successful technology, reality must take precedence over public
115 relations, for Nature cannot be fooled. -- Dick Feynman
116
117
118 Misc:
119 - Mike We are short on chiefs and heavy on Indians here
120
5d5c2a2 @docelic - bin/stattree:
docelic authored
121
122
8a8fb40 @docelic As usual, I am wonderful ;-) Here's the reason this time:
docelic authored
123 - In iccattut:
5d5c2a2 @docelic - bin/stattree:
docelic authored
124 - Check if redhat/tarball paths are correct
125 - explain syntax accepted in profile files
126 - Fix ImageDir and include one picture for example
127 - <Racke>I name three things that IC users often didn't acknowledge:
128 namespaces (CGI, Values, Scratch)
129 parsing order ([L], variables, lists) - interpolation
130 inventing syntax doesn't buy you anything
131 IC is _not_ a programming language
132 - how to delete item from cart in all possible ways
133 - give examples for the tasks in 'do yourself' section (in progress)
134 - give good practices about filtering, security
135 - see problems from old docs/TODO notes on iccattut
136 - files/tutorial*: s/tutorial-*.log/tutorial.*.log/
137
8a8fb40 @docelic As usual, I am wonderful ;-) Here's the reason this time:
docelic authored
138 GLOSSARY:
139 Say about accesskeys in html source, for key-based navigation
140 tag, interpolation, reparse, symbol types
141 catalog/global variable, tag,ui,
142 action, form, unix inet socket, values,
143 regex, flypage, sku
144
145
146
147
148 NON DOCS RELATED
149 - Image tag, sort out mgkpath thing
f56b1e1 @docelic Just small "managemental" commit.
docelic authored
150
151
152
153 Nice but not fitting the idea
154 - CVS 'ident' command
155 - Suppress inline docs (in source) for items that have xmldocs docs
156 - In source contexts, for tags, highlight tagCanon and provide <acronym> with
157 short explanation and example
5f3f31f @docelic - Some new stuff, some placeholders, some updates/fixes to existing f…
docelic authored
158
159
160
161 In IC source:
162
163 - No $Vend::XTrailer on <input>, etc..
164 - missing </p>s
165 - lowercase SELECTED/CHECKED ?
166
34d199b @docelic - Makefile: turn orderchecks back on (the error that prevented them from
docelic authored
167
168 Check CartTrigger[Quantity]
Something went wrong with that request. Please try again.