On Wed, 09 Jul 2008 15:32:55 -0400, ingo wrote:

> wouldn't it be enough to publish the docpages as wikipages without
> giving the users the ability to edit de documentation, but they should
> be able to comment, discuss and propose additions to the documentation.
> The documentation editor can make changes to the docs based on this and
> republish the page.

Even still, the challenge remains of getting the data both in and out of 
the wiki for publication in the various formats.  The import itself isn't 
completely straightforward (have a look at my userpage for an early 
attempt with one section).

Jim

Post a reply to this message

in news:48753b6f@news.povray.org Jim Henderson wrote:

> Even still, the challenge remains of getting the data both in and out
> of the wiki for publication in the various formats.

either I was not clear or you misunderstood, I only want to convert 
from the current doc format to the wiki, not back. The editor can copy 
past the suggestions from the wiki into the orginal documentation, edit 
it if needed and add the tags needed for the povdoc format. Even if 
there is a simple wiki>povdoc conversion, an editor will have to go 
through the whole thing anyway to ad tags like the <indexentry>

I don't see this documentation maintained by the community without a 
responsible editor and editing is a hands on job. 've done it quite a 
few years ;)


ingo

Post a reply to this message

On Thu, 10 Jul 2008 15:03:55 -0400, ingo wrote:

> in news:48753b6f@news.povray.org Jim Henderson wrote:
> 
>> Even still, the challenge remains of getting the data both in and out
>> of the wiki for publication in the various formats.
> 
> either I was not clear or you misunderstood, I only want to convert from
> the current doc format to the wiki, not back. The editor can copy past
> the suggestions from the wiki into the orginal documentation, edit it if
> needed and add the tags needed for the povdoc format. Even if there is a
> simple wiki>povdoc conversion, an editor will have to go through the
> whole thing anyway to ad tags like the <indexentry>

The goal is to make the job easier for the editor as well. :-)

> I don't see this documentation maintained by the community without a
> responsible editor and editing is a hands on job. 've done it quite a
> few years ;)

As have I, along with having written a couple of books along the way. :-)

The way it's done IME in the publishing world is that there's a template 
that provides instructions to typesetting equipment - so, for example, a 
particular style would say "this is a tip" and defines in the typesetting 
how the information should look.

From the standpoint of maintaining the doc, something similar would make 
sense here.  The intent would be that not everyone could edit, but to 
make the transition back to the markup used by the POV team means less 
chance of content confusion, misplaced headers, and things like that.

The more automation there is, the better, since everyone here is a 
volunteer.  :-)

Jim

Post a reply to this message