2012-08-07 18:19:37 +00:00
|
|
|
# About this Documentation
|
|
|
|
|
|
|
|
|
|
<!-- type=misc -->
|
|
|
|
|
|
2013-08-22 22:32:25 +00:00
|
|
|
The goal of this documentation is to comprehensively explain Etherpad,
|
2012-08-07 18:19:37 +00:00
|
|
|
both from a reference as well as a conceptual point of view.
|
|
|
|
|
|
|
|
|
|
Where appropriate, property types, method arguments, and the arguments
|
|
|
|
|
provided to event handlers are detailed in a list underneath the topic
|
|
|
|
|
heading.
|
|
|
|
|
|
|
|
|
|
Every `.html` file is generated based on the corresponding
|
|
|
|
|
`.markdown` file in the `doc/api/` folder in the source tree. The
|
|
|
|
|
documentation is generated using the `tools/doc/generate.js` program.
|
|
|
|
|
The HTML template is located at `doc/template.html`.
|
