search

speedata / publisher

speedata Publisher - a professional database Publishing system
https://www.speedata.de/
GNU Affero General Public License v3.0
296 stars 36 forks source link

Put generated documentation online #2

Closed oneiros-de closed 12 years ago

oneiros-de commented 12 years ago

It would be quite helpful if the generated documentation could be viewed online. Or am I just blind in seeing the link?

pgundlach commented 12 years ago

See http://publisherhandbuch.speedata.de/ - but I'll add a link on the main pages. Thanks for the notice!

ousia commented 12 years ago

I have a suggestion on this.

Wouldn't it be possible to provide the documentation from http://publisherhandbuch.speedata.de/ in PDF format? I guess this is something that speedata Publisher can do and it would be a good example for generated output from Publisher.

pgundlach commented 12 years ago

Currently the documentation is in a plain text markup format. I'd like to transfer it to some XML format while in the same turn translate it into english. That way I can process is with the publisher. You are perfectly right, of course. That way I could have a decent example.

ousia commented 12 years ago

It is Textile, the lightweight markup for the documentation format? I thought that SP Publisher was able to process Textile the same way as XML (the first image at http://speedata.github.com/publisher/ seems to show it that way).

I think that DocBook would be a good XML format, since it is technical documentation. It is just my personal opinion, of course.

pgundlach commented 12 years ago

Currently it is textile and markdown. We can process text(lie) but need to convert to pdf first. While I totally agree with your suggestion, I have to postpone that task and get the english translation done first (working on that and making great progress). Then I'll create an english manual and after that, I will have a nicer document workflow.

ousia commented 12 years ago

Na ja... Deutsch wäre auch kein Problem für mich.

Eine deutsche Fassung des Handbuchs ist auch hilfreich für deutschsprechende Anwender (würde ich sagen).

pgundlach commented 12 years ago

I have created a new branch so that I can begin converting the documentation into XML format and generate HTML documentation (english and german) with an XSLT stylesheet. That way we have the documentation in one place and we can be sure that the english and german (and perhaps in the future) other languages are always in sync, at least for the command reference.