DocTree
Version 0.05, March 15, 2009.
Document a tree of files and folders, with output in HTML.
Produces an annotated list of the files and folders, by scanning each folder, listing the files it contains, and repeating for each folder it contains.
Complete user documentation should be available after installation in the doc folder.
Installation
Download and install Lua for Windows v5.1.4.20 or newer from LuaForge. If not using Windows, then in addition to the Lua interpreter itself, you will need working installations of the modules Lua File System, IUP, and likely also CD. Note that DocTree is not tested on platforms other than Windows, so please let us know what platform you are using and how it works for you.
After Lua is installed, you can run the latest
DocTree-*-Setup.exeto install DocTree. When setup is complete, it will offer to launch the DocTree GUI for you.Changes
v0.05
This version is another public alpha release with UI and reporting improvements.
Rearranged the GUI so that most options are in a modeless dialog box that is only displayed at need.
Support a choice of the directory sort order.
Support an internal HTML style sheet for the report.
New controls over the sizes used for the body text and heading fonts, if the style sheet is selected.
New control to shade the annotation text's background if the style sheet is used.
Folder section headings are now output with hyperlinks to the named folder, using the
file:protocol. This allows the user to click on the section heading to see the folder. If the user's default web browser is Internet Explorer, then the link opens Windows Explorer on the folder; Firefox browses the folder in an internal file system browser.Fixed bug that prevented specifying
.as the folder to document.v0.04
This version is the first public alpha release with working report preview, full report generation, handling of several names for per-folder annotation files, and listings sorted by name, with the object's name in the first column of the table.
TODO
This utility is obviously not complete...
BUG: Large trees take a long time to preview, use a lot of memory, and lock the UI while the attempt to build the preview. Don't point the GUI at
C:\, for example.BUG: The markdown preview text and a markdown output file may not process to the same result as the HTML output. This is because the HTML report is actually generated in sections, so the scope of those markdown elements such as the
[ref]links used to form the target URl of an<a>tag will differ depending on how the markdown is handled.Make a project or settings file type, register it to run DocTreeGUI with those settings loaded.
Also support selection of an external style sheet in place of the internal sheet.
Support HTML preview (optionally?) instead of the markdown preview.
Should there should be a way to configure what files are ignored?
Should there be a way to supply annotations for individual files? Although tempting to use NTFS alternative streams for the annotation, that would make them hard to see. Perhaps a .DocTree folder could contain per-file annotations named after the files they annotate?
Links to folders and files from report? Version v0.05 makes the folder section headings contain links to the folders, but perhaps the table entries themselves should also have links.
Make GUI more "live", with folder tree and file panes, and some kind of a way to directly edit the content of "doctree-annotaiton.txt" for a folder.
Consider support for file types other than markdown text for the annotation content.
Implement a "Document This Folder" explorer context menu, which would run DocTreeGUI with "this folder" filled in as the folder to scan, and either the default settings or settings read from a settings file found in that folder.
Support some form of per-folder option control, possibly outof the annotation file.
Support project file templates.
from \readme.txt
license.txt 2009-02-24 00:12 1.07 KB
ReadMe.html 2009-03-15 00:47 5.15 KB
ReadMe.txt 2009-03-15 00:16 4.37 KB
unins000.dat 2009-03-17 18:09 10.59 KB
unins000.exe 2009-03-17 18:09 679.34 KB
bin 2009-03-17 18:09
doc 2009-03-17 18:09
bin(*)DocTree.lua 2009-03-15 01:18 14.99 KB
DocTreeGUI.wlua 2009-03-15 01:02 8.49 KB
markdown-tests.lua 2009-02-23 18:56 108.41 KB
markdown.lua 2009-02-23 18:56 37.17 KB
doc(*)DocTree User Guide Sources
The user guide to DocTree is here, written in Markdown just like this file. It is translated to HTML by the same markdown.lua used by DocTree itself. See the Makefile for details of the translation.
from doc\readme.txt
demo.html 2009-02-25 01:44 3.92 KB
DocTree-options.png 2009-03-15 00:34 14.58 KB
DocTree-screen.PNG 2009-03-15 00:35 34.46 KB
DocTree.html 2009-03-15 11:55 12.21 KB
DocTree.txt 2009-03-15 11:55 10.65 KB
index.html 2009-02-24 22:40 678
index.txt 2009-02-24 15:37 274
ReadMe.html 2009-02-24 22:40 603
ReadMe.txt 2009-02-24 15:37 262
This report was produced by DocTree.lua (v0.05) at 2009-03-17 18:11