Dear all,
We provided a way for plugin creators to contribute content regarding
their plugins to the Rodin handbook. Read on, if this is of interest to
you.
As most of you know, we're currently revising the Rodin documentation
[1]. We explicitly limit our work to the core Rodin platform - we just
don't have the capacity to go beyond that. However, there has been some
interest from plugin developers to include their own documentation, or
at least to provide pointers. Our concern was that we don't have the
ability to perform quality control on those parts of the handbook.
We came up with the following solution. We created a special
Latex-Environment for Plugin contributions. The content appears on gray
background, and the environment is closed with a disclaimer stating that
the content may be out of date.
We added the use of this environment to the style guilde [2]. We also
provided a small section on ProB in the tutorial to demonstrate how this
approach works in practice [3].
We hope that you're happy with this approach, and that plugin-developers
will take advantage of it. Please let me know if you have any questions
or problems.
Best,
- Michael
[1] http://wiki.event-b.org/index.php/User_Documentation_Overhaul
[2] http://handbook.event-b.org/current/html/sect0004.html
[3] http://handbook.event-b.org/current/html/sect0014.html#a0000000099
|