Skip to content

4eyes/x4ebase

Repository files navigation

Extension Manual

This is a template manual aiming to pave the way to developers when it comes about documentation. The template provides a structure that a developer can take over and, in addition, many useful snippets and examples. Documentation is written in reST format. Refer to Help writing reStructuredText to get some more insight about the syntax and available reST editors. For instance, you might be particularly interested how you can :

  • generate the documentation using on-line services (@todo to write)
  • make links accros projects
  • how you should write TypoScript reference.

Any idea or suggestion for improving this template can be drop to our team. And remember: documentation is like gift wrapping, it looks like superfluous, but your friend tends to be rather disappointed when their presents arrive in supermarket carrier bags. (Documentation-Driven Design quote)