diff options
| author | R. Tyler Ballance <tyler@monkeypox.org> | 2009-11-16 21:09:13 -0800 |
|---|---|---|
| committer | R. Tyler Ballance <tyler@monkeypox.org> | 2009-11-16 21:09:13 -0800 |
| commit | d9ce7916e309e2393d824e249f512d2629e5e181 (patch) | |
| tree | 6b7ad5cd6292f6e017e048fbeb4551facbabd174 /docs/TODO | |
| parent | e43765a679b84c52df875e9629d303e304af50a1 (diff) | |
| download | python-cheetah-d9ce7916e309e2393d824e249f512d2629e5e181.tar.gz | |
Revert "Delete the "old" docs directory to make way for fancy smancy sphinx"docs
This reverts commit 5dc95cfcd015628665d3672e56d0551943b5db6b.
Diffstat (limited to 'docs/TODO')
| -rw-r--r-- | docs/TODO | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/TODO b/docs/TODO new file mode 100644 index 0000000..8c22561 --- /dev/null +++ b/docs/TODO @@ -0,0 +1,46 @@ +Cheetah Documentation TODO +-------------------------- + +Cheetah FAQ +=============================================================================== +A place for specific questions & answers for troubleshooting. Some questions +may duplicate material in the Users' Guide, but some paragraphs in the UG will +be moved to the FAQ. +- Why am I getting a NotFound error? I put my variable in the searchList! +- Why is my template output empty? +- Why are my $property, $file, ... placeholders misbehaving? + +Users' Guide: +=============================================================================== +- 200+ e-mails in MO's mailbox regarding possible doc updates. +- more examples in the Webware section (EL) +- more examples/advice all over the Users' Guide about recommended/ + non-recommended strategies (MO) + +Developers' Guide: +=============================================================================== +- Finish. (MO) + +Quick Reference Guide: +=============================================================================== +Cheat sheet on Cheetah syntax and usage. (MO but not soon) + +Beginners' Guide: +=============================================================================== +Written for somebody who has to maintain templates but +doesn't know Python. Looking for a writer, somebody who trains such +maintainers and knows what their needs are. To get the correct LaTeX +structure, copy users_guide.tex and one of its chapters, and modify as +necessary. + + +HOWTOs: +======= +Somebody offered to write some HOWTOs on specialized topics. Who was it? + +BNF: +==== +- write a formalized grammar for Cheetah in BNF. MO partly did in +a Developer's Guide appendix. Essentially, the directives still need +to be done, and a proofreading of the rest. Move to separate text file and +find somebody to finish it. |