[Phpwm] Web application documentation - write once / output multiple formats
David Goodwin
david at codepoets.co.uk
Fri May 29 09:22:30 UTC 2009
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Ian Munday wrote:
> Slightly off-topic perhaps, but I'm wondering how people provide /
> deliver document for their applications?
>
> Historically, I've manually created HTML pages that I bring together
> with a simple table of contents (TOC) and which then load in a pop-up
> window. I can link to specific pages from within my application to
> make it 'context-sensitive'. A real requirement going forward is to
> improve the way help documentation is delivered in HTML (i.e. make it
> searchable), and also to provide multiple formats. I also want a
> write-once, but output in multiple formats solution. (Longer term I'm
> also thinking multiple languages - clearly each language will need to
> be written.)
>
> The formats that have been identified as most useful / relevant to the
> type of applications I'm involved in are:
>
> * HTML - searchable and with a tree-like TOC - a good example is http://livedocs.adobe.com/en_US/Lightroom/1.0/help.html?content=WSF3A57C22-0CDF-4401-9C10-2D0B3B7C7E40.html
> * PDF
> * CHM
>
> Has anyone found a good solution to this problem?
>
> Regards,
>
Aside from just having 3 different 'view' templates for each? No. (Or am
I missing the question?)
PDF is kind of the hardest, although we did use PDML once (with mixed
success).
Never touched CHM so can't comment.
David.
- --
David Goodwin
[ david at codepoets dot co dot uk ]
[ http://www.codepoets.co.uk ]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iEYEARECAAYFAkofqZYACgkQ/ISo3RF5V6aOqACggu4rBsn7k7QDvSk2zGqSkkJM
FFAAmwXSZC4GVkxjm+w+tZfW5i6NZxAy
=C8eZ
-----END PGP SIGNATURE-----
More information about the Phpwm
mailing list