[maemo-community] The role of the docmaster

[From: Jarmo.Tikka at nokia.com]

Hi, 

>-----Original Message-----
>From: ext Murray Cumming [mailto:murrayc at murrayc.com] 
>Sent: 15 June, 2009 18:16
>To: List for community development
>Cc: Tikka Jarmo (Nokia-D/Helsinki)
>Subject: Re: The role of the docmaster
>
>On Mon, 2009-05-25 at 16:24 +0200, Murray Cumming wrote:
>> > 3. Create documentation infrastructure that can handle very big
>> documents and is independent from format that is used to publish 
>> documents
>> >   - Diablo Reference Manual and Training Material is now in Latex
>> format and Latex can handle very big documents
>> >   - From latex we are able to generate all needed release formats
>> e.g. for Frementle we are able to release same docs wit high quality 
>> as PDF docs, HTML docs and MediaWiki docs.
>> >   - next output format will be Eclipse xhtml
>> 
>> The developers who are able to help you are used to editing DocBook 
>> XML, gtk-doc and doxygen. The tools they use (library.gnome.org, 
>> DevHelp) use these formats.
>> 
>> DocBook (and DocBook processors) has no particular problem 
>with large 
>> files.
>> 
>> DocBook is very standard and popular and can output to these formats 
>> with fop (or one of the even-better proprietary processors). Well it 
>> probably does not generate Mediawiki markup, because why on earth 
>> would you want to generate content for a wiki. Generated content 
>> should not be edited in the generated form.
>
>Jarmo, could you confirm here that you
>- do indeed plan to generate wiki markup from the latex sources, and

We are able to import all our latex docs into MediaWiki. This is now tested functionlaity.

>- do want those wiki pages to be editable,

All wiki pages (maybe exception being front page because of spam) in mameo.org wiki are editable. I have no plans to change that. It would kind of spoil the purpose of wiki as a service :).

>- and you really do expect those wiki changes to be 
>reintegrated with the original latex sources?

Yes. Is somebody makes truble to fix our docs in our wiki we will review those changes and integreate to the origin latex and our version control. It may be that our teams do not approve all changes done in wiki and do not ingtegrate them because of that but that is then review decicion from our technology owners.

Cheers,
//Jarmo

> 
>--
>murrayc at murrayc.com
>www.murrayc.com
>www.openismus.com
>
>