changeset 169:0ce973659f45

merge TODOs into single file
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Wed, 06 Apr 2011 01:50:42 +0200
parents 7926fa38e797
children 1481cbc12553
files docs/todo/2.0-TODO docs/todo/TODO.dom docs/todo/TODO.wiki-like-formats-support docs/todo/todo.rst
diffstat 4 files changed, 125 insertions(+), 107 deletions(-) [+]
line wrap: on
line diff
--- a/docs/todo/2.0-TODO	Wed Apr 06 01:11:15 2011 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,28 +0,0 @@
-TODO: moin export dump (create a static html dump that can be opened directly
-from the filesystem using a browser). Problem: URL generation (relative URLs).
-For specific, absolute URLs (like serving html files with a web server),
-Frozen-Flask could be used.
-
-index pages: could filter by name (thus not displaying Trash/*, except if wanted)
-
-
-MercurialBackend
-----------------
-
-Wiki instance pull which leads to merge invalidates Item index files (current revisions 
-index and destroyed revisions index). This files should be recreated from changelog after merge.
-
-Merge does not yet care about merged revisions metadata.
-
-Last API changes (destroy_revision) made storing revision parents in revision metadata invalid.
-Links to parents should be stored now in mutable collection. Index (revisions index) is suitable
-for this task and its record format can be extended to store this values.
-
-GraphInfo action showing revisions history as DAG has to be fixed.
-
-UI lacks actions for serving backend directly (hg serve), pulling data from other instances (hg pull)
-and merging (hg merge). This stuff is rather low-priority, as it can be done in command line very well.
-
-Handy mercurial extensions to ease commit and rename operations from command line  are still missing.
-
-
--- a/docs/todo/TODO.dom	Wed Apr 06 01:11:15 2011 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,51 +0,0 @@
-* Include converter:
-  - Handle URIs using the Uri class.
-
-* Allow creation of unicode URIs for wiki links. This should also provide
-  access to the query parameters.
-
-* Macro converter:
-  - Move macro definitions into different namespace.
-  - Footnote placing.
-
-* HTML output converter:
-  - Footnote placing.
-
-* Item: Support different output types again.
-
-* Item: Converter-aware quickhelp.
-  Possibilities:
-  - Use help from converter $type -> application/x-moin-document.
-  - Use a different converter $type -> application/x-moin-document;quickhelp
-    which always returns the help.
-  - Use another registry for the quickhelps within the converter framework.
-
-* Support for per-instance converters.
-
-* Fix GUI editor.
-  - Don't expand macros and links(?) in HTML.
-  - Replace html -> moin wiki converter.
-
-* Include macro:
-  * Argument parsing.
-    The argument parsing through wikiutil.invoke_extension_method is currently
-    incompatible with several examples of the macro usage.
-  * Normalization of heading levels - e.g. if the tree has h1->h2->h4 (h3 is
-    missing). For simple pages, we could just ignore this problem and require
-    correct heading levels in input markup. But if you use Include much, this
-    can get either a pain (esp. if you change levels) or even impossible (if
-    same content is included on different pages into different levels).
-    Would also fix broken looking TOC if levels are missing.
-    Currently, the code has only 1 normalization: that the biggest heading
-    on a rendered page starts at h1.
-  * For generation of a single output document (that can be either used as a
-    single html file or transformed to a PDF), page links need to be changed:
-    Usually page links just link to another page url. But if one assembles one
-    large document using Include, one wants the links to the pages that got
-    included point to some anchor where the page inclusion starts. For normal
-    anchor links to / within included pages, it should be #Pagename-anchorid.
-
-* Macro handling: Handle errors.
-
-* Converters, Macros: Merge.
-
--- a/docs/todo/TODO.wiki-like-formats-support	Wed Apr 06 01:11:15 2011 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,28 +0,0 @@
-General
--------
-
-If someone adds a new type of node in the Moinmoin DOM tree:
-  
-  TODO: add support of new types of node
-
-ReStructuredText
-________________
-
-Some syntax of ReStructuredText is ignored because it can't be converted to
-the current DOM tree (like inline style/class/template replacement via directives).
-Moin needs some page about unsupported things or changes in DOM tree.
-
-Mediawiki
-_________
-
-Mediawiki->DOM converter based on moinwiki->DOM parsing model. Moinwiki parser
-has blocks (multiline markup) and inline markup, but Mediawiki has tags that are
-inline and can be extended to next lines (until closing tag or end of the file).
-This creates a problem, for some tags it can be solved by implemented
-preprocessor, but it doesn't work with tags that have multiline output
-(like <blockquote>).
-
-There are to ways to fix it:
-
- * preprocessor must input '\n' before <blockquote> and after </blockquote>
- * parser must be able to start new block(multiline) element after inline lexem.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/todo/todo.rst	Wed Apr 06 01:50:42 2011 +0200
@@ -0,0 +1,125 @@
+General
+=======
+- verify if these TODO items are still valid
+- move valid TODO items either to the respective code file or to the issue
+  tracker (on bitbucket.org) and remove them from here
+
+
+Storage Backends
+================
+
+Mercurial Backend
+-----------------
+
+Wiki instance pull which leads to merge invalidates Item index files (current revisions 
+index and destroyed revisions index). This files should be recreated from changelog after merge.
+
+Merge does not yet care about merged revisions metadata.
+
+Last API changes (destroy_revision) made storing revision parents in revision metadata invalid.
+Links to parents should be stored now in mutable collection. Index (revisions index) is suitable
+for this task and its record format can be extended to store this values.
+
+GraphInfo action showing revisions history as DAG has to be fixed.
+
+UI lacks actions for serving backend directly (hg serve), pulling data from other instances (hg pull)
+and merging (hg merge). This stuff is rather low-priority, as it can be done in command line very well.
+
+Handy mercurial extensions to ease commit and rename operations from command line  are still missing.
+
+
+DOM Converters
+==============
+
+General
+-------
+
+If someone adds a new type of node in the Moinmoin DOM tree:
+  
+  TODO: add support of new types of node
+
+Allow creation of unicode URIs for wiki links. This should also provide
+access to the query parameters.
+
+Support for per-instance converters.
+
+Include converter
+-----------------
+- Handle URIs using the Uri class.
+
+Macro converter
+---------------
+- Move macro definitions into different namespace.
+- Footnote placing.
+
+HTML output converter
+---------------------
+- Footnote placing.
+
+ReStructuredText
+----------------
+
+Some syntax of ReStructuredText is ignored because it can't be converted to
+the current DOM tree (like inline style/class/template replacement via directives).
+Moin needs some page about unsupported things or changes in DOM tree.
+
+Mediawiki
+---------
+
+Mediawiki->DOM converter based on moinwiki->DOM parsing model. Moinwiki parser
+has blocks (multiline markup) and inline markup, but Mediawiki has tags that are
+inline and can be extended to next lines (until closing tag or end of the file).
+This creates a problem, for some tags it can be solved by implemented
+preprocessor, but it doesn't work with tags that have multiline output
+(like <blockquote>).
+
+There are two ways to fix it:
+
+- preprocessor must input '\n' before <blockquote> and after </blockquote>
+- parser must be able to start new block(multiline) element after inline lexem.
+
+
+Item
+====
+- Support different output types again.
+
+- Converter-aware quickhelp.
+  Possibilities:
+  - Use help from converter $type -> application/x-moin-document.
+  - Use a different converter $type -> application/x-moin-document;quickhelp
+    which always returns the help.
+  - Use another registry for the quickhelps within the converter framework.
+
+- Fix GUI editor.
+  - Don't expand macros and links(?) in HTML.
+  - Replace html -> moin wiki converter.
+
+
+Macros
+======
+
+Macro handling
+--------------
+- Handle errors.
+- Merge Macros and Converters
+
+Include macro
+-------------
+- Argument parsing.
+  The argument parsing through wikiutil.invoke_extension_method is currently
+  incompatible with several examples of the macro usage.
+- Normalization of heading levels - e.g. if the tree has h1->h2->h4 (h3 is
+  missing). For simple pages, we could just ignore this problem and require
+  correct heading levels in input markup. But if you use Include much, this
+  can get either a pain (esp. if you change levels) or even impossible (if
+  same content is included on different pages into different levels).
+  Would also fix broken looking TOC if levels are missing.
+  Currently, the code has only 1 normalization: that the biggest heading
+  on a rendered page starts at h1.
+- For generation of a single output document (that can be either used as a
+  single html file or transformed to a PDF), page links need to be changed:
+  Usually page links just link to another page url. But if one assembles one
+  large document using Include, one wants the links to the pages that got
+  included point to some anchor where the page inclusion starts. For normal
+  anchor links to / within included pages, it should be #Pagename-anchorid.
+