[docs] xmldocs - docelic modified TODO
docs at icdevgroup.org
docs at icdevgroup.org
Tue Sep 21 11:59:12 EDT 2004
User: docelic
Date: 2004-09-21 15:59:11 GMT
Modified: . TODO
Log:
- Turn 2. starts: TODO items
Revision Changes Path
1.18 +31 -19 xmldocs/TODO
rev 1.18, prev_rev 1.17
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- TODO 21 Sep 2004 09:28:28 -0000 1.17
+++ TODO 21 Sep 2004 15:59:11 -0000 1.18
@@ -1,16 +1,18 @@
PRIMARY:
-- if the place of item definition (a file) changes its path, in the Source
- context the old version is shown instead of the newest one.
-- agree on rules for writing Synopsis lines (should be flexible enough to
- support all symbol types in an uniform way)
-- rewrite bin/refs-autogen AND bin/stattree
-- Make docbook/symbol-type-skel/* contents of a glossary, and display a
- glossary entry instead of those files.
-- Under availability, if applicable, display cvs line (modification time,
- username and version (cvs line)).
- Support using refs/<filename> with all the documentation for a symbol
instead of refs/<directory>/<files>.
+- Stinky manpage stylesheets are a disaster. This time it's that
+ <cmdsynopsis> is verbatim and <screen> still renders comments without
+ newlines! I mean, what the... (And © is translated to crap instead
+ of plain "C").
+- See why the autogenerated navigation links are so retarded (just home/up,
+ no next/prev)
+- In refs-autogen at a few places we keep both the hash/array representation
+ of values, and their string representation. (We always generate string
+ when modifying array/hash). It should be made so that we only modify
+ array/hash during the whole program, then in the last step before
+ generating the template they get stringified.
- Visually identify obsolete items (those not present in cvs-head)
- Add a note that we're focusing on really basic stuff that won't change
over time (the criteria we used to determine what's for iccattut and what
@@ -31,15 +33,13 @@
- replace <tag> with <code> where putting tag alone in the source would work.
- explain syntax accepted in profile files
-
DOCUMENTATION SYSTEM:
- bin/stattree, in format_ctx(), see how many spacings all the lines have
- in common, and trim that from the beginning.
-- why in manpage format, comments at the top of the file are messed up (no
- linebreaks)
-- Seems like there's no CSS selector to make a difference between an Example
- element title, and Screen element title. (This causes source contexts
- to be prefixed with "Example: ", although they're technically not).
+ in common, and trim that from the beginning. [Did that, and the thing
+ still doesn't work somehow].
+- copy the definition for <example> to a
+ new name so we'll be able to differentiate between source chunks and
+ examples.
- Add support to document tags which are NOT found in separate files
(like [restrict] or [subject]).
- Read all possible options for tag files from vend/config.pm
@@ -48,6 +48,7 @@
iccattut:
- give examples for the tasks in 'do yourself' section
- give good practices about filtering, security
+- see problems from old docs/TODO notes on iccattut
GLOSSARY:
tag, interpolation, reparse, symbol types
@@ -63,6 +64,8 @@
say, 15 lines of context, but it'll come great when you have a copy
of a 300-lines usertag. Example for this could be taken directly out of
mwforum demo on mwforum.org
+- Make that thing Jon suggested, to write like "4.8.0-5.3.0" instead of
+ "4.8.0, 5.0.0, 5.2.0, 5.3.0" (will probably look better in the future).
Long-term:
- filenames in Source contexts should also be clickable. this is longterm
@@ -88,10 +91,15 @@
"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
+
######################################################################
-Pragmas, globvars:
- default
+add a note that copypasting iccattut will first not teach you anything,
+and second, you'll end up with a problem that you won't know where to
+look for, because you'll be unfamiliar with the copypasted thing...
Tags:
parameters
@@ -103,7 +111,11 @@
has subtags
nests
-----
+----
+New docs:
+ - promotional
+ - new developer howto
+
guibutton
mv
More information about the docs
mailing list