Difference between revisions of "Collaborative Documentation using Drupal"
(→Priority) |
m (→Export feature) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 12: | Line 12: | ||
== Export feature== | == Export feature== | ||
Export book's content, in order to be able to import them back. This will also be used to store the documentation into subversion | Export book's content, in order to be able to import them back. This will also be used to store the documentation into subversion | ||
| − | *[S1] export to the importable content (Wiki based + meta data) | + | *<strike>[S1] export to the importable content (Wiki based + meta data)</strike> |
*[S2] export to docbook|DITA or similar to generate the PDF output | *[S2] export to docbook|DITA or similar to generate the PDF output | ||
| + | *<strike>[S3] export to the static HTML content</strike> | ||
| + | |||
| + | * About [S3] .. still need to improve the output for navigation, and also handle the tags, ... better theme, and so on ... This is not critical for now. | ||
== CMS feature == | == CMS feature == | ||
| Line 19: | Line 22: | ||
*<strike>[E2] resolve the wiki link inside the drupal CMS (wikitool .. but find a hack to work without unique title ...)</strike>. | *<strike>[E2] resolve the wiki link inside the drupal CMS (wikitool .. but find a hack to work without unique title ...)</strike>. | ||
*[E3] build a dedicated drupal theme for the documentation site | *[E3] build a dedicated drupal theme for the documentation site | ||
| + | |||
* About [E2]: For unique title, this is more a hack or workaround, you can have non unique title, but you should avoid. | * About [E2]: For unique title, this is more a hack or workaround, you can have non unique title, but you should avoid. | ||
| Line 24: | Line 28: | ||
= Priority = | = Priority = | ||
| − | * C1, L1 | + | * <strike>C1, L1</strike> |
* E2 | * E2 | ||
* S1 | * S1 | ||
| Line 35: | Line 39: | ||
== Details == | == Details == | ||
| − | * | + | * Todo: integrate generated eiffel documentation from EiffelStudio .. (i.e: static html). The way to reference it from drupal is done using [[ref:....|title]] syntax (interwiki) |
| − | * | + | * Todo: customize the site's theme |
| − | * | + | * Todo: implement the export to wikitext from Drupal |
| + | * Todo: implement the export to PDF ... or whatever | ||
| + | |||
| + | |||
| + | = Misc = | ||
| + | * Wikitext syntax: [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Cheatsheet] | ||
| + | * How to edit a wikitext page: http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page | ||
Latest revision as of 08:17, 14 September 2008
Not Ready for Review: This Page is Under Development!
Contents
Plan
Things to do
Import feature
Importing content into Drupal's CMS and apply book structure
[C1] Convert previous xmldoc (ISE) content, into importable content for Drupal's CMS (Wiki based + meta data)[L1] Import this specific format + meta data such as parent's page, page order ...- [L2] Import documentation of eiffel libraries generated by EiffelStudio
Export feature
Export book's content, in order to be able to import them back. This will also be used to store the documentation into subversion
[S1] export to the importable content (Wiki based + meta data)- [S2] export to docbook|DITA or similar to generate the PDF output
[S3] export to the static HTML content
- About [S3] .. still need to improve the output for navigation, and also handle the tags, ... better theme, and so on ... This is not critical for now.
CMS feature
- [E1] Wysiwyg editor ... for the wikitext, there is a mediawiki extension based on FCKEditor (try to port it to Drupal)
[E2] resolve the wiki link inside the drupal CMS (wikitool .. but find a hack to work without unique title ...).- [E3] build a dedicated drupal theme for the documentation site
- About [E2]: For unique title, this is more a hack or workaround, you can have non unique title, but you should avoid.
- About [E1]: this sounds quite tricky to port FCKeditor/Wikitext to drupal. Tricky .. or long, but we'll see...
Priority
-
C1, L1 - E2
- S1
- L2
Roadmap
- ~10 Sept: provide intranet Drupal-CMS to edit the documentation online using wikitext on drupal
- end of Sept: make this "intranet" site public, thus ... Internet accessible by the Eiffel community. But let's keep quiet on this. Since it will be between alpha and beta quality. Need dedicated theme, better integration with existing Eiffel websites
- Mid October: Announce, and allow people to become editor if they wish to contribute (they'll have to request this privilege)
Details
- Todo: integrate generated eiffel documentation from EiffelStudio .. (i.e: static html). The way to reference it from drupal is done using title syntax (interwiki)
- Todo: customize the site's theme
- Todo: implement the export to wikitext from Drupal
- Todo: implement the export to PDF ... or whatever
Misc
- Wikitext syntax: Cheatsheet
- How to edit a wikitext page: http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page
