-
Notifications
You must be signed in to change notification settings - Fork 3
/
TODO
210 lines (167 loc) · 8.77 KB
/
TODO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
- adjust title of <question> olinks (see if just id/title= works)
- adjust iccattut to use tarball install paths
-see how AcrossLocks works... does it open tables directly, or opens all tables so you dont have to put perl tables=
- see why 'attribute' glossentry isn't found
-make all-lowercase options for other auto* entitites too
- manpages, first line of <screen> loses linebreaks
- work on bin/mkreport
- provide static files for download, describe keys like alt+n
- documentation for bounce and restrict is ignored
- some small error in glossary/pragma at the bottom, [tag pragma]0[/tag]
- see if the files we parse in bin/stattree in block (like parseVendConfig, parseVendInterpolate) allow some stuff to go unaccounted for mkreport
- with tags from Interpolate.pm, context for systemtag is not always 'whole file', but can be x-y as well
- dal autogen preskoci kontekst koji je prazan? i zasto uopce unkondicionalno
- rijesit html_std/_ext i opcije
ekspandira @$ctx ako moze da nema konteksta?
- fix link to howtos after changing format
- link to howtos from ref pages
- order counter, Session->{mv_order_number}, cronjob -0001, or file da-te.counter, or session_id.time
- Change -latest to version number in tarball download
- fix/update AdminUser docs
- aliases like DataDir/DefaultTables are not documented
- unit testing
- remove NEW from <meta>
- In tags, make XSLT code print position number besides "Yes" word in
positional parameters for tags
- note in configuration glossentry to use '' to skip values
- Check ConfigDatabase and DirectiveDatabase. Is description correct? One seems to be wrong
- preprocessor directives in configuration ?
- FAQ should be desintegrated to other places
- what doesn't racke like with WHATSNEW
- replace itemlists with sections or tables
- component tag has wrong source context
Entities to create:
- \0 null char
- table/column/key should be defined in docbook/literals.ent as ROW_TABLE...
- DEFAULT_JOINER_N for \n
- SAFE_DATA
Outstanding:
=======
- Can *_page pragmas take ITL and not just subroutine names?
- See that if 'crypt' is put in see also, all symbols of that name appear
in see also line and their type is distinguished visually.
- TAXAREA is not discovered in source by bin/stattree
- Make MapRoutined source contexts have Line: x-y instead of Lines: z header.
- recognize situations where contexts overlap, but in a special way that
first example does not see the other, but the other sees the first becase
of 10 lines of pre-context. (example is IMAGE_MOGRIFY refentry). In those
cases, resize area of the context report so that it appears as one
- With confs, also include source context where it is being used
- In vars.html, include line if it appears in variable.txt
- match style (no starting verb or all starting verbs) in all Example titles
- check if all Default fields are properly formated (<literal> or none)
- make regexp matching better, to properly scan parse_subroutine(); (gets
confused by { { in a substitution)
- in refs, replace "database" with "database_name", that kind of things
- import my hand-made test from /var/lib/.../pages/* to appropriate
ref pages as online examples
- At least in filters, <<EOR messes up the thing, only < is printed and stops
- &conf-RobotLimit; doesn't link to RobotLimit configuration page
Coding:
- script to [un]comment debug lines!!
- use Interchange.pm to make an Interchange shell (External.pm!)
- finish ML stats <-- MAILPOND on ocelic2!
- script to manipulate file headers
Mid-term:
- List of mv_s, descriptions and shortcuts
- for "online" docs, also provide a form where users can add comments or
ask for clarification. (this could be done with either pure IC (forum?), or
XML forms capability, or wiki?)..
- Generate leaf nodes (put bin/mkreport back in action)
- If filter returns Vend::xxx::something(), include that function in context
reports, and try to determine the "Uses" field (which also needs to be
added to filter refentry template or something)
Tags:
aliases
tag call / perl call / mvasp
container
has subtags
nests
Ideas:
- In db_columns: add exlude_columns= parameter?
- New docs:
- promotional
- new developer howto
- filenames in Source contexts should also be clickable. this is longterm
because it'll involve perltidy and other stuff I have in mind ...
- Make a tutorial : IC from Git, Catalog in SVN, replicated setup online
and locally
- How to deal with Safe
Programming guidelines doc - integrate with programming style. Advise
programmers of choices to make in order to make their code play well with
IC - for example, if they want to have a field in the DB for images,
advise them to name the column 'image' because other tags (they might or
might not later use) take that as default value. etc...
guide on setting complete IC environment
explain version naming.. stable/unstable and how 5.3.0 implies next stable
Documentation on how to create replicated catalog online and at your
desktop machine for ultimate convenience.
- Whereever we count things, (like, valid Locale keys are decimal_point,
mon_grouping, price_picture,n_cs_precedes etc.) make that information
derived by scripting in stattree, not manually counting
Notes:
- say that code is colorful collection of time and people, so docs try to fill
the gap.
- say that even though sometimes the code looks ugly/unreadable, check 3 times before thinking it's a bug
- ** Dan Browning: clustering howto, tuning tips (by Mike),
- jedit + IC colorization, commit-to-live script,
- Racke: performance docs NEEDED, clustering my mike needs funding or he
won't do it. CVS howto is browning.
- "In times of universal deceit, telling the truth becomes
a revolutionary act." -- George Orwell.
- For a successful technology, reality must take precedence over public
relations, for Nature cannot be fooled. -- Dick Feynman
Misc:
- Mike We are short on chiefs and heavy on Indians here
- In iccattut:
- Check if redhat/tarball paths are correct
- explain syntax accepted in profile files
- Fix ImageDir and include one picture for example
- <Racke>I name three things that IC users often didn't acknowledge:
namespaces (CGI, Values, Scratch)
parsing order ([L], variables, lists) - interpolation
inventing syntax doesn't buy you anything
IC is _not_ a programming language
- how to delete item from cart in all possible ways
- give examples for the tasks in 'do yourself' section (in progress)
- give good practices about filtering, security
- see problems from old docs/TODO notes on iccattut
- files/tutorial*: s/tutorial-*.log/tutorial.*.log/
GLOSSARY:
Say about accesskeys in html source, for key-based navigation
tag, interpolation, reparse, symbol types
catalog/global variable, tag,ui,
action, form, unix inet socket, values,
regex, flypage, sku
NON DOCS RELATED
- Image tag, sort out mgkpath thing
Nice but not fitting the idea
- CVS 'ident' command
- Suppress inline docs (in source) for items that have xmldocs docs
- In source contexts, for tags, highlight tagCanon and provide <acronym> with
short explanation and example
In IC source:
- No $Vend::XTrailer on <input>, etc..
- missing </p>s
- lowercase SELECTED/CHECKED ?
Check CartTrigger[Quantity]
Community-contributed usertags (was usertag.pod before 4.7.0; too messy)
icstart - Getting Started Guide
* FAQ for each demo catalog (foundation, construct, barry, artstore)
* FAQ for each database (DBM, MySQL, PostgreSQL, Oracle)
* FAQ for each payment processor (Payflow Pro, Authorize.net, etc.)
http://host/cgi-bin/cat?mv_pc=RESET (clears it, for debugging)
Otherwise mv_pc does double duty as a cache foiler, and is a meaningless,
incrementing integer.
-----------------------------------------------------------------------------
iccattut:
Switch to new payment settings instead of mv_cyber_mode etc.
To add
Discuss profile.order verification options like 'zip=zip' and then explain why we don't actually use that one much unless it's for a U.S.-only store
Problems?
[on-match] gets used if search returned no results on an empty search string. Why?
Doubled-up CC verification errors:
No error message is given in [error] if required form variables weren't passed at all (vs. being simply empty)
No error message if profiles.order can't be found
Discuss using images (from old mvdocs):
A public Web directory for inline image graphic files is needed. Interchange does not serve the images, only the HTML tags calling them. A useful convention is to place all buttonbars, backgrounds, and icons in the /images directory, with the catalog items located in the /images/catalog directory. Regardless of the directory structure, an I<absolute path> must be used. Relative paths are unacceptable. Use the I<ImageDir> directive, which places that as the absolute path in front of all relative IMG and INPUT SRC, and BODY, TABLE, TR, TH, and TD BACKGROUND specifications.