Skip to content

HTTPS clone URL

Subversion checkout URL

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