TypeFriendly user manual builder - please review
Posted: Wed Jul 08, 2009 6:15 am
Hi everyone,
I'd like to share with you with my another project and see your opinion about it. Its name is TypeFriendly and the purpose: building the documentations, user manuals and other sorts of HTML publications.
I started thinking about it a couple of months ago, unsatisfied with the results achieved with DocBook and the lack of a complete user manual framework for this format, like on php.net or Zend Framework. Rather than dealing with XML parsers etc. I decided to write a more compact solution in PHP.
TypeFriendly uses plain text files as a source form of the chapters. The text is formatted with Markdown and supports syntax highlighting with GeSHi. TypeFriendly automatically generates the navigation between the pages and allows to manipulate the chapter order in a convenient way. It also provides some tools to document the user API (not limited to PHP), generating appendices etc. and a multilingual support (currently the messages for three languages are provided: English, Polish and Slovak). However, its goal is not to replace phpDocumentor or Doxygen. They are very good tools for generating the API docs from the source code, whereas TypeFriendly is designed for reference guides like this: http://framework.zend.com/manual/en/ in the first place.
An example can be found here:
- http://static.invenzzia.org/docs/tf/0_1/book/en/
- The source version of the above: http://svn.invenzzia.org/browser/TypeFr ... /0.1/docs/
The project website: http://www.invenzzia.org/en/projects/typefriendly
Any ideas or suggestions?
I'd like to share with you with my another project and see your opinion about it. Its name is TypeFriendly and the purpose: building the documentations, user manuals and other sorts of HTML publications.
I started thinking about it a couple of months ago, unsatisfied with the results achieved with DocBook and the lack of a complete user manual framework for this format, like on php.net or Zend Framework. Rather than dealing with XML parsers etc. I decided to write a more compact solution in PHP.
TypeFriendly uses plain text files as a source form of the chapters. The text is formatted with Markdown and supports syntax highlighting with GeSHi. TypeFriendly automatically generates the navigation between the pages and allows to manipulate the chapter order in a convenient way. It also provides some tools to document the user API (not limited to PHP), generating appendices etc. and a multilingual support (currently the messages for three languages are provided: English, Polish and Slovak). However, its goal is not to replace phpDocumentor or Doxygen. They are very good tools for generating the API docs from the source code, whereas TypeFriendly is designed for reference guides like this: http://framework.zend.com/manual/en/ in the first place.
An example can be found here:
- http://static.invenzzia.org/docs/tf/0_1/book/en/
- The source version of the above: http://svn.invenzzia.org/browser/TypeFr ... /0.1/docs/
The project website: http://www.invenzzia.org/en/projects/typefriendly
Any ideas or suggestions?