| Title | Livedocs: The promised land |
|---|---|
| Student | Hannes Magnusson |
| Mentor | Michael Wallner |
| Abstract | |
|
Livedocs introduction:
"Livedocs is a tool to display DocBook XML files in a web browser on the fly, without the need of building all HTML target files first. It was started as a project to simplify the task of PHP Manual contributors, to check their changes as they will show up in the documentation. To use Livedocs, a little preprocessing work is needed, but after that, the script collection even works on modified XML files. The main advantage of Livedocs for the PHP Manual is the dramatically reduced time-to-live interval, since modified XML files can be pushed to servers without the need of building all the HTML files even for small changes. Additionaly to this, Livedocs also does a good job of providing search results for keywords found in the manual, as well as keeping track of relations of translated files to their English equivalents, notifying readers, if they read a seriously outdated translation." (http://cvs.php.net/viewvc.cgi/livedocs/README?revision=1.17) Livedocs is said to be the solution to all our (php.net) documentation problems and I intend to keep that promise by any means necessary. |
|