Commits

dan mackinlay committed c8523e6

better TODO

Comments (0)

Files changed (2)

+To-Do Items
+===========
+  
+  * handle citations as well as possible
+  
+    * easiest option: have a role and a dirctive that render differently in ReST and LaTeX.
+      In ReST there could be some JSON lookup business, but let's do that later.
+      But in LaTeX, the directives render to nothing at all, and the roles render as curly braces.
+   
+  * have nice scripts to crunch photos and diagrams down to web size
+  * `look pretty <http://www.smashingmagazine.com/2009/03/18/10-principles-for-readable-web-typography/>`_
+    
+    * post-process html to clean up the awful, awful, docutils citation
+      formatting.
+    * view .OBJ 3d files in situ via `three.js
+      <https://github.com/mrdoob/three.js/blob/master/utils/exporters/convert_obj_threejs_slim.py>`__
+      or `jcs3d <http://code.google.com/p/jsc3d/>`__
+    
+    * friendly homepage setup a la `Proven Corporation <http://www.proven-corporation.com/2008/03/27/sphinx-templates/>`_
+    * publish the custom algo theme to other sphinx users.
+  
+  * social media strategy:
+  
+    * switch to `ucomment <http://ucomment.org/contents/>`_ for more
+      integrated comments
+    * facebook `liking <http://developers.facebook.com/docs/reference/plugins/like>`_ (see also  `opengraph <http://developers.facebook.com/docs/opengraph>`_)
+
+      * this is easy in template overrides but could be made configurable, and
+        use the FB `Javascript SDK
+        <http://developers.facebook.com/docs/reference/javascript/>`_
+        
+    * amazon affiliate link stuff to pay my book bills.
+    * `asynchronous <http://code.google.com/apis/analytics/docs/tracking/asyncUsageGuide.html>`_ analytics tracker
+  
+  * showing off
+    
+    * `smarter javascript includes <http://sphinx.pocoo.org/templating.html#script_files>`_
+    * get some more template variables in there for colouring.
+    * support searches for related tags on CUL/delicious possibly using yahoo
+      pipes.
+    * create directive to denote a move page, which serves back a 301
+      redirect.
+    * switch custom extensions to use config variables as per the extlinks 
+      extension
+    * maybe turn off source text display if I am going to have secret stuff
+    * submit the existence of this package to the sphinx sourcecode example
+      sites list
+    * go to html5-style markup throughout as per html5 boilerplate
+    * handle `semantic tag markup <http://www.commontag.org/Specification>`_
+    * `microformat citations <http://microformats.org/wiki/citation-examples-markup>`_
+
+      * would be lovely, but the citation stuff in docutils is heinous. I
+        ain't touchin' it.
+      
+  * enhance blogginess:
+  
+    * render blog-like index with excerpts and such
+    * decorate index links with article dates automatically
+    * annotate pages with a "last updated" stamp
+    * support default timezone in RSS thingy
+    * Go to `Tinkerer <http://tinkerer.bitbucket.org/>`__
+    
+  * institute a local/offline flag
+  
+    * `DISQUS embed <http://wiki.disqus.net/JSEmbed/>`_'s local developer mode
+    * dynamically include local or remote jquery and mathjax as per html5
+      boilerplate (or via monkey patching at compile time)
+    
+  * import old text using `pandoc <http://johnmacfarlane.net/pandoc/>`_ or
+    xhtml2rest
+
+
+Helpful tips
+------------
+
+  * `docutils directives <http://docutils.sourceforge.net/docs/howto/rst-directives.html>`_
+  * docutils doc metadata is `in the doctree <http://docutils.sourceforge.net/docs/ref/doctree.html>`_
+  * `docutils testing <http://docutils.sourceforge.net/docs/dev/testing.html>`_
+  * sphinx has `a handy walk through <http://sphinx.pocoo.org/ext/tutorial.html>`_ that could generalise to tags: 
+  * another howto `here <http://www.hvergi.net/2008/06/restructuredtext-extensions/>`_
+  

TODO.txt

-To-Do Items
-===========
-  
-  * handle citations as well as possible
-  
-  * easiest option: have a role and a dirctive that render differently in ReST and LaTeX. In ReST there could be some JSON lookup business, but let's do that later. But in LaTeX, the directives render to nothing at all, and the roles render as curly braces.
-   
-  * have nice scripts to crunch photos and diagrams down to web size
-  * `look pretty <http://www.smashingmagazine.com/2009/03/18/10-principles-for-readable-web-typography/>`_
-    
-    * post-process html to clean up the awful, awful, docutils citation
-      formatting.
-    * view .OBJ 3d files in situ via `three.js
-      <https://github.com/mrdoob/three.js/blob/master/utils/exporters/convert_obj_threejs_slim.py>`__
-      or `jcs3d <http://code.google.com/p/jsc3d/>`__
-    
-    * friendly homepage setup a la `Proven Corporation <http://www.proven-corporation.com/2008/03/27/sphinx-templates/>`_
-    * publish the custom algo theme to other sphinx users.
-  
-  * social media strategy:
-  
-    * switch to `ucomment <http://ucomment.org/contents/>`_ for more
-      integrated comments
-    * facebook `liking <http://developers.facebook.com/docs/reference/plugins/like>`_ (see also  `opengraph <http://developers.facebook.com/docs/opengraph>`_)
-
-      * this is easy in template overrides but could be made configurable, and
-        use the FB `Javascript SDK
-        <http://developers.facebook.com/docs/reference/javascript/>`_
-        
-    * amazon affiliate link stuff to pay my book bills.
-    * `asynchronous <http://code.google.com/apis/analytics/docs/tracking/asyncUsageGuide.html>`_ analytics tracker
-  
-  * showing off
-    
-    * `smarter javascript includes <http://sphinx.pocoo.org/templating.html#script_files>`_
-    * get some more template variables in there for colouring.
-    * support searches for related tags on CUL/delicious possibly using yahoo
-      pipes.
-    * create directive to denote a move page, which serves back a 301
-      redirect.
-    * switch custom extensions to use config variables as per the extlinks 
-      extension
-    * maybe turn off source text display if I am going to have secret stuff
-    * submit the existence of this package to the sphinx sourcecode example
-      sites list
-    * go to html5-style markup throughout as per html5 boilerplate
-    * handle `semantic tag markup <http://www.commontag.org/Specification>`_
-    * `microformat citations <http://microformats.org/wiki/citation-examples-markup>`_
-
-      * would be lovely, but the citation stuff in docutils is heinous. I
-        ain't touchin' it.
-      
-  * enhance blogginess:
-  
-    * render blog-like index with excerpts and such
-    * decorate index links with article dates automatically
-    * annotate pages with a "last updated" stamp
-    * support default timezone in RSS thingy
-    * Go to `Tinkerer <http://tinkerer.bitbucket.org/>`__
-    
-  * institute a local/offline flag
-  
-    * `DISQUS embed <http://wiki.disqus.net/JSEmbed/>`_'s local developer mode
-    * dynamically include local or remote jquery and mathjax as per html5
-      boilerplate (or via monkey patching at compile time)
-    
-  * import old text using `pandoc <http://johnmacfarlane.net/pandoc/>`_ or
-    xhtml2rest
-
-
-Helpful tips
-------------
-
-  * `docutils directives <http://docutils.sourceforge.net/docs/howto/rst-directives.html>`_
-  * docutils doc metadata is `in the doctree <http://docutils.sourceforge.net/docs/ref/doctree.html>`_
-  * `docutils testing <http://docutils.sourceforge.net/docs/dev/testing.html>`_
-  * sphinx has `a handy walk through <http://sphinx.pocoo.org/ext/tutorial.html>`_ that could generalise to tags: 
-  * another howto `here <http://www.hvergi.net/2008/06/restructuredtext-extensions/>`_
-