[scribus-dev] Scribus documentation translations temporarily removed from builds

[Gregory Pittman]

On 11/30/2010 05:26 PM, Louis Desjardins wrote:
> 2010/11/30 Gregory Pittman <gpittman at iglou.com <mailto:gpittman at iglou.com>>
>
>     On 11/30/2010 02:24 PM, Louis Desjardins wrote:
>
>
>         I am not too sure to understand either just how the doc workflow
>         works.
>
>         Can we translate the doc? can we help write it? can this job be on a
>         wiki? (so we can work on it step by step, from time to time,
>         alone or in
>         a group of people). How can we improve the doc workflow, in fact.
>
>
>     Anyone can translate the docs. Simply pull them out of their
>     location and edit away. Usually what I see people do on the wiki,
>     which makes sense, is to copy the original, then stepwise work
>     through the html file paragraph by paragraph, leaving the tags other
>     structure in place as you go.
>
>     The structure of the docs directories and files is pretty
>     straightforward, as is the XML file that forms the index. I have
>     sent Christoph anything I make, since he has commit rights and I don't.
>
>
> Do we need commit rights to edit an online doc file? Or to submit a
> translation? My understanding of this is it’s tied to the application
> only by a URL. Thus, in no way does that affect the code. It’s a simple
> link to a website.
>
> Can we turn this into a wikipedia-like way to go? If for some reason
> someone makes an error and mixes things or deletes some content, we have
> ways to return to the previous stage. I see a lot of disadvantages at
> pulling out a file, edit away and then pushing it back, while there are
> ways to work in a collaborative (and sync) mode.

I don't have commit rights, and don't feel I need them. I think it's 
best to have that restricted to a small number of people -- Christoph 
can do that.

It's best to just leave these files in html (conversion to wiki format, 
and back to html just adds more work), in which case you can view them 
in a browser to make sure there are no typos and the layout is still Ok.

If you checkout from svn, you will find the docs in 
MainDir/scribus/doc/, under which there are directories for the various 
languages. Obviously, you want to pull the files to translate from the 
en/ directory (I'm not sure if the files inside fr/ are identical to 
those in en/). Inside en/ is a directory images/ for the webpage graphics.

What I have done when working on the docs was to copy the en/ and 
images/ directories and their files out to another directory outside of 
the svn download, so I can work more easily and protect my edits. Since 
the page links to images are relative, as long as you have images/ 
inside of your en/ or fr/ directory, the page will find images Ok.

An important other file to look at is en/menu.xml and fr/menu.xml, which 
create the menu lists for links. Without this, you would not know that 
the link from "Scribus Basics" ("Initiation à Scribus" en français) 
points to about2.html, which would be the file you need to edit.

My suggestion for a starting point, with the most value to users, would 
be to work on items in Scribus Basics.

Let me know if you need any other assistance.

Greg