/usr/share/doc/rest2web/html/reference/todo.html is in rest2web-doc 0.5.2~alpha+svn-r248-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>TODO/ISSUES</title>
<link rel="stylesheet" href="../stylesheets/rest2web.css" type="text/css" />
<link rel="stylesheet" href="../stylesheets/voidspace_docutils2.css" type="text/css" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="rest2web - build websites with Python and docutils." />
<meta name="author" content="Michael Foord" />
<meta name="copyright" content="© 2003-2006 Michael Foord, subject to BSD License" />
<meta name="keywords" content="rest2web - build websites with Python and docutils,
rest, restructured text, text, website, internet, web, net, web builder, site,
site builder, docutils, i18n, internationalization, templates, templating,
python, " />
</head>
<body style="background: url(../images/logos/img_background.gif) top center repeat-y;">
<div id="wrap">
<div id="header-section">
<a href="http://www.voidspace.org.uk/python/index.shtml" title="Voidspace"><img src="../images/logos/header760.gif" alt="Voidspace"/></a>
<p align="center" class="headertitle"><span style="font-size:130%">rest2web:</span> Building Websites Across the Known Universe</p>
</div>
<div id="header">
<ul>
<li><a href="../index.html">rest2web</a></li>
<li>></li>
<li><a href="index.html">Reference</a></li>
<li>></li>
<li>TODO/ISSUES</li>
</ul>
</div>
<table>
<tr>
<td><img src="../images/logos/1.gif" width="1" height="1" alt="" /></td>
<!-- main content cell first, with rowspan=2 -->
<td valign="top" align="left" rowspan="2">
<div id="middle-column">
<a name="startcontent" id="startcontent"></a>
<div id="gallery">
<div class="document" id="todo-issues">
<h1 class="title">TODO/ISSUES</h1>
<div class="section" id="todo">
<h1>TODO</h1>
<p>This is the <strong>TODO</strong> and <strong>Wish List</strong> for <a class="reference external" href="http://www.voidspace.org.uk/python/rest2web">rest2web</a>. It includes things that
need to be done as well as things that are only included because they could be
done.</p>
<p>They are not listed in any order of priority or even desirability.
Obviously bug-fixes are the highest priority. If you have any suggestions for
this list, or opinions as to the priority of items on this list, or wish to
implement any of the ideas yourself, then please get in touch.</p>
<p>Some of the items have (?) at the end of them. This means we are not sure if it
desirable to implement the suggestion at all. There is a constant tension
between adding more flexibility (extra options) and keeping things simple. Your
input is wanted - if it matters to you whether we do this or not then let us
know.</p>
<p>For bug reports or feature requests you can use the <a class="reference external" href="http://lists.sourceforge.net/lists/listinfo/rest2web-develop">rest2web Mailing List</a>.</p>
<ul class="simple">
<li>Add an extra level of verbosity, errors only.</li>
<li>Remove the 'unicode' encoding option - this defaults to an output encoding
of template encoding; which is arbitrary.</li>
<li>Allow overriding of default index and template used with 'force mode'. (And
provide a simpler default template.)</li>
<li><tt class="docutils literal"><span class="pre"><%</span> <span class="pre">path_to_root</span> <span class="pre">%></span></tt> doesn't work in gallery files, need a workaround in
plugin if possible. Could sllow path_to_root in the uservalue 'body', or
some other mechanism.</li>
<li>Better error messages from rendering templates - proper line numbers.</li>
<li>CSS error in new template for long page titles (squashed in minibar).</li>
<li>Implement next and previous. (By giving pages access to the section order lists.)</li>
<li>Add rest2web version to the namespace.</li>
<li>Provide a better default title for the index pages (using
<tt class="docutils literal"><span class="pre">self._top_level_name</span></tt>).</li>
<li>Handle encodings for dicts (subsections) and list values, when supplied as
uservalues in config file.</li>
<li>Add a 'guess' option (the default) for encodings supplied in a config file ?</li>
<li>Ability to set the lineendings of the output. ('<tt class="docutils literal"><span class="pre">\\n</span></tt>' or '<tt class="docutils literal"><span class="pre">\\r\\n</span></tt>')</li>
<li>Build a more up to date executable.</li>
<li>Add test examples of the new <tt class="docutils literal"><span class="pre">include</span></tt> functions.</li>
<li>Allow source and target directories to be provided as command line options.</li>
<li>A standard function to automatically copy (and link to) the text source for
a page.</li>
<li>Add a 'Generated by rest2web' comment into the HTML of each page.</li>
<li>Duplicate entries in <tt class="docutils literal"><span class="pre">section_pages</span></tt> gives an unhelpful error message.</li>
<li>Get plugins and macro support complete in the executable version.</li>
<li>The example translation file, links to the same pages in the other languages.
Standard function to do this, or restindex keyword ?</li>
<li>Allow setting of docutils options in the config file.</li>
<li>Render macros in section descriptions.</li>
<li>Allow easy adding of user functions ? (like macros, currently doable through
normal imports in templates)</li>
<li>markup format - could allow additional markups, like sextile and textile.</li>
<li>template engines - support for other templating engines like Cheetah</li>
<li>Better support for multiline and nested macros.</li>
<li>description format - we might want to allow different markups for the
description. (Currently reST <em>only</em> - could allow html easily)</li>
<li>can we extract the page description from the reST format ? (as meta
information)</li>
<li>Use filename as default page title/link title/crumb ? (where none is supplied)</li>
<li>Build a plugin to use the tags for navigation - so a site needn't just be
represented as a tree. Also build a data structure (probably XML) that can be
used by a CGI script for dynamically searching for pages with tag
combinations.</li>
<li>Should we allow comments inline with values in the restindex ? (or even
multiline comments ?) - this would require a better parser.</li>
<li>Should be a standard function to generate a table of links to the sections in
a page, for use in the index page - which could have several pages in each
section. See the example table in the test site.</li>
<li>Should 'format' or 'encoding' be a default value, when specified in the index
file ? (any others ?)</li>
<li>At the moment you can only have sections you have declared in your restindex
'sectionlist'. Should you be able to assign pages to sections without having
to declare them ? FIXME: check this is true</li>
<li>Develop the index generation stuff so that it can generate 'blue arrows'
style Python documentation, including up. (Difficult without support in docutils)</li>
<li>Contents for a section, or for the whole site.</li>
<li>Single index page for the whole site (sitemap plus indexes from within pages).</li>
<li>Unittests or doctests. (Probably requires a lot of refactoring to make
rest2web testable.)</li>
<li>A way of adding a set of standard links to all reST pages.</li>
<li>Implement more of the config file values as command line options.</li>
<li>Automatic FTP facility.</li>
<li>Integrate with Tidy for checking of HTML.</li>
<li>[madduck] More flexible parsing for restindex. Ideally, it should be
possible to have the restindex anywhere within the document, including
comments. Also, it should be completely removed from the document after
processing.</li>
</ul>
</div>
<div class="section" id="issues">
<h1>ISSUES</h1>
<p>Following is a list of 'unresolved issues' with <strong>rest2web</strong>. They aren't
necessarily all bugs, so they may not be fixed. It's probably worth being aware
of them.</p>
<ul class="simple">
<li>Unfortunately, the <tt class="docutils literal"><span class="pre">guess_encoding</span></tt> function can recognise <tt class="docutils literal"><span class="pre">cp1252</span></tt> <a class="footnote-reference" href="#id3" id="id1">[1]</a>
as <tt class="docutils literal"><span class="pre">ISO-8859</span></tt>. In this case docutils can choke on some of the characters.
We probably have to special case the <tt class="docutils literal"><span class="pre">cp1252</span></tt> and <tt class="docutils literal"><span class="pre">ISO-8859</span></tt> encodings -
but I wonder if this problem applies to other encodings ?</li>
<li>If you set <tt class="docutils literal"><span class="pre">include:</span> <span class="pre">No</span></tt> for an index page, it works fine <em>except</em> when you
are viewing that index page or subpages. In these cases it <em>is</em> included.</li>
<li>If no crumb is provided, the page-title is supposed to be used instead. Each
page needs it's index page in it's list of crumbs (as the 'crumb before' it).
In order to work out the title for the index page, we would need to render the
body of the page. But to render the body of an index page, you need to render
all the other pages <em>first</em>. This means <strong>index pages need crumbs</strong>. Either
that or you can supply an explicit <tt class="docutils literal"><span class="pre">page-title</span></tt> value !</li>
<li>You probably can't set a target that is outside the current directory tree.
(test !) Allow for a way of specifying that the target is an absolute URL (if
build is 'No')</li>
<li>It would be nice for every page to have access to the whole structure of the
site <a class="footnote-reference" href="#id4" id="id2">[2]</a>. This would allow a sidebar to have links to every page in every
section. The only way of doing this is to generate the site in two passes.
First pass create the structure. Second pass, render the pages with the pages
having access to the index structure. This means parsing the restindex - which
also extracts page contents. Unless we are going to parse the restindex twice
we would end up with the entire contents in memory. Is this feasible ?
(or worthwhile - would anyone use it ?) XXXX Note that because of the data
structures we create - it's likely that <em>currently</em> the whole site is being
kept in memory <em>anyway</em>.</li>
<li>Currently a '.txt' file without a restindex won't be built. It's <em>possible</em>
that <em>all</em> the defaults are what you want. Should we let a file without a
restindex be processed ? (That means if you don't want a text file to be
processed you must give it a restindex and set build and include to <tt class="docutils literal"><span class="pre">No</span></tt> -
maybe make it an option ?).</li>
<li>It would be nice to make <a class="reference external" href="http://www.voidspace.org.uk/python/firedrop2/">Firedrop</a>
a graphical frontend to <strong>rest2web</strong>. It would need to be able to handle
trees of pages, instead of a list, and effectively have a 'build.ini' file
per page (the restindex) rather than for the whole site.</li>
<li>For a page that has 'include' set to 'No', the indexpage value is <tt class="docutils literal"><span class="pre">None</span></tt>.
This is because the current page doesn't have an entry in the indextree
structure. This could require some care if you use 'thispage' in your
template. Is their some other sensible value it can have ? You can still use
indextree without problem.</li>
<li>I'm not sure if filename encodings are an issue or not. I don't always decode
filenames - so where we are comparing them from the filesystem etc. it's <em>possible</em>
we'll have problems.</li>
<li>Sidebars contain links to pages in sections above. This means that changing one
page can affect other pages - so when you change something we have to rebuild
the whole site, not just the changed part.</li>
</ul>
</div>
<hr class="docutils" />
<div class="section" id="footnotes">
<h1>Footnotes</h1>
<table class="docutils footnote" frame="void" id="id3" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>The default windows encoding.</td></tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="id4" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[2]</a></td><td>Currently through indextree, a site has access to the whole structure
<em>above</em> the current page - but not the <em>whole</em> structure.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="end">
<p><a href="#startcontent">Return to Top</a><br />
<small>Part of the <a href="http://www.voidspace.org.uk/python/rest2web/">rest2web Docs</a></small><br />
<small>Page last modified <strong>Fri Oct 13 23:25:49 2006</strong>.</small>
</p>
</div>
</div></td>
</tr>
<tr>
<td valign="top" align="left" width="25%">
<div id="left-column">
<div id="sidie">
<ul>
<li class="left-navheader-first">
<a href="index.html" class="left-navheader">Index Page</a>
</li>
<li class="left-navheader">Pages</li>
<li><a href="todo.html">TODO/ISSUES</a></li>
<li><a href="uservalues.html">uservalues</a></li>
<li><a href="encodings.html">Encodings</a></li>
<li><a href="indextree.html">indextree</a></li>
<li><a href="changelog.html">changelog</a></li>
<li><a href="smilies.html">Smilies</a></li>
<li><a href="plugins.html">Plugins</a></li>
<li><a href="gallery.html">Gallery</a></li>
</ul>
</div>
<p class="sidieimg">
<a href="http://www.python.org">
<img src="../images/logos/new_python.gif" width="88"
height="103" border="0" alt="Powered by Python" />
</a>
</p>
<p class="sidieimg">
<a href="http://sourceforge.net/donate/index.php?group_id=138579">
<img src="http://images.sourceforge.net/images/project-support.jpg" width="100"
height="32" border="0" alt="Support This Project" />
</a>
</p>
<p class="sidieimg">
<a href="http://www.voidspace.org.uk/python/rest2web/"><img
src="../images/logos/rest2web140x62.gif" width="142" height="62"
alt="Site Built with rest2web" /></a><br />
</p>
</div>
</td>
</tr>
</table>
<hr />
<p class="sidieimg">
<a href="http://www.voidspace.org.uk/python/rest2web/"><img src="../images/logos/rest2web200x80.gif" width="200" height="80" alt="Site Built with rest2web" /></a>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=138579&type=5" width="210" height="62" alt="SourceForge.net Logo" /></a>
<a href="http://www.opensource.org"><img src="../images/logos/osi-certified-120x100.gif" width="120" height="100" alt="Certified Open Source" border="1" /></a>
</p>
<p class="sidieimg">
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
</script>
<script type="text/javascript">
_uacct = "UA-203625-1";
urchinTracker();
</script>
</p>
<p class="sidieimg">
<a href="http://www.voidspace.org.uk/python/index.shtml"><img
src="../images/logos/pythonbanner.gif" width="468" height="60"
alt="Python on Voidspace" /></a>
</p>
<div id="footer">
Copyright © Voidspace<br />Design by <a href="http://www.fuchsiashockz.co.uk">Fuchsiashockz</a> | <a href="http://validator.w3.org/check?uri=referer" title="Validate code as W3C XHTML 1.1 Strict Compliant">W3C XHTML 1.1</a> | <a href="http://jigsaw.w3.org/css-validator/check?uri=referer" title="Validate Style Sheet as W3C CSS 2.0 Compliant">W3C CSS 2.0</a>
</div>
</div>
</body>
</html>
|