Howdy,
I'd like to start adding some new content soon. Do we have common agreement to split user manual into chapters and use <XInclude> to join them? If we do, I'll go ahead and do it.
Also, why do we use lang="en" attribute everywhere in inkscapeUTFen.xml?
Colin, I think we need a simple Makefile to create HTML version (at least HTML). Since my bash mojo is not so cool for last couple of years, maybe you could have a look? ;)
Alexandre
"Alexandre Prokoudine" <alexandre.prokoudine@...2...> writes:
Also, why do we use lang="en" attribute everywhere in inkscapeUTFen.xml?
Probably for hysterical raisins, since it used to be a single file with both French and English in it.
Colin, I think we need a simple Makefile to create HTML version (at least HTML).
Just take the Makefile that is in there since a few weeks :)
The targets are fr, en, singlefr, singleen. It also has PDF targets etc., do "make help" in user_manual/.
Cheers Colin
On 9/26/07, Colin Marquardt wrote:
Also, why do we use lang="en" attribute everywhere in inkscapeUTFen.xml?
Probably for hysterical raisins, since it used to be a single file with both French and English in it.
OK, removed and committed to SVN. Also fixed header in French user guide which was set to article instead of book (as pointed out by Elisa).
Colin, I think we need a simple Makefile to create HTML version (at least HTML).
Just take the Makefile that is in there since a few weeks :)
The targets are fr, en, singlefr, singleen. It also has PDF targets etc., do "make help" in user_manual/.
Arrr, silly me :)
OK, here is XML file I have right now (attached). All chapters are splitted to separate documents. It's already easier to see what needs work :)
Basically the root document now contains links to separate chapters, so every contributor can work on his own part (chapter). We can create even smaller documents, but I don't think it's that necessarily.
If you are fine with this approach, I can commit changes, BUT :)
IMO, from what I see, the user guide needs restructuring (chapters on various menus should not be top-level chapters etc.). We can go one of two paths:
1. Wait until EN and FR user guides are in sync and then restructure/separate. 2. Agree on new outline of the document, separate chapters and then sync their content.
If we separate documents, we will need to store each translation (EN and FR) in its own directory. So the directories structure will look this way:
user_manual/xml/en/{english xml files here} user_manual/xml/fr/{french xml files here}
By the way, XML markup will need some work too. Generally, using simplesect inside sect1 is considered... well... not a usual way to structure documents :)
Please comment ;-)
Alexandre
"Alexandre Prokoudine" <alexandre.prokoudine@...2...> writes:
IMO, from what I see, the user guide needs restructuring (chapters on various menus should not be top-level chapters etc.). We can go one of two paths:
- Wait until EN and FR user guides are in sync and then restructure/separate.
Bringing them in sync so much that xml2po is happy is very hard, but I guess is worth the effort.
- Agree on new outline of the document, separate chapters and
then sync their content.
That would probably make it less daunting, since you can work your way from chapter to chapter. On the other hand, if you find something you must fix and use a text editor to search & replace some tags, it's quicker if you have a single chunk of text to work on.
If we separate documents, we will need to store each translation (EN and FR) in its own directory. So the directories structure will look this way:
user_manual/xml/en/{english xml files here} user_manual/xml/fr/{french xml files here}
It should look like whatever they use in the Gnome Doc project I guess. Many useful Gnome tools work better if they find such a structure. That is, unless we want to go with a structure from another project - but we shouldn't invent ours from scratch.
Sorry, I won't be around much in the next 10 days, but do keep up the pace :)
Cheers Colin
Le Wednesday 26 September 2007 02:41:24 Alexandre Prokoudine, vous avez écrit :
On 9/26/07, Colin Marquardt wrote:
Also, why do we use lang="en" attribute everywhere in inkscapeUTFen.xml?
Probably for hysterical raisins, since it used to be a single file with both French and English in it.
OK, removed and committed to SVN. Also fixed header in French user guide which was set to article instead of book (as pointed out by Elisa).
Colin, I think we need a simple Makefile to create HTML version (at least HTML).
Just take the Makefile that is in there since a few weeks :)
The targets are fr, en, singlefr, singleen. It also has PDF targets etc., do "make help" in user_manual/.
Arrr, silly me :)
OK, here is XML file I have right now (attached). All chapters are splitted to separate documents. It's already easier to see what needs work :)
Basically the root document now contains links to separate chapters, so every contributor can work on his own part (chapter). We can create even smaller documents, but I don't think it's that necessarily.
If you are fine with this approach, I can commit changes, BUT :)
IMO, from what I see, the user guide needs restructuring (chapters on various menus should not be top-level chapters etc.). We can go one of two paths:
- Wait until EN and FR user guides are in sync and then
restructure/separate. 2. Agree on new outline of the document, separate chapters and then sync their content.
What about this contents : Présentation d'inkscape (introduce Inkscape)
La boîte à outils (the tools)
Les dialogues (??? "pop-up" ?, like the windows to choose the color etc)
le menu Chemin (paths)
le menu Effets (effects)
les raccourcis claviers ("keyboard map" ?)
Ok it look like very simple but the chapter will be developed.
If we separate documents, we will need to store each translation (EN and FR) in its own directory. So the directories structure will look this way:
user_manual/xml/en/{english xml files here} user_manual/xml/fr/{french xml files here}
By the way, XML markup will need some work too. Generally, using simplesect inside sect1 is considered... well... not a usual way to structure documents :)
ah... i think the tag was original by Kevin. Then we can choose some better.
Please comment ;-)
Alexandre
lo
Probably for hysterical raisins, since it used to be a single file with both French and English in it.
not hysterical reason, but historical yes. I used to have both language in the same file because it was easier for me at the beginning. We've already clear french file from all the lang="fr"
Colin, I think we need a simple Makefile to create HTML version (at least HTML).
yes normally, producing html and pdf is quite easy. and with better result since you've updated it Colin ;)
Then i see no reason why not split our huge file in separated. But who would like to do a script for that ? ACSpike seem to have some knowledge, since he already made the script to split fr and en. let's ask him.
we should also review our picture policy and really know how to improve and quicken their update.
Cedric
"radar.map35@...6..." <radar.map35@...6...> writes:
lo
Probably for hysterical raisins, since it used to be a single file with both French and English in it.
not hysterical reason, but historical yes.
http://www.everything2.com/index.pl?node_id=519725 :) - but I admit that I used it wrongly, at least if the Jargon file is correct.
Cheers Colin
Le Tuesday 25 September 2007 22:50:10 Alexandre Prokoudine, vous avez écrit :
Howdy,
I'd like to start adding some new content soon. Do we have common agreement to split user manual into chapters and use <XInclude> to join them? If we do, I'll go ahead and do it.
i'm agree.
Also, why do we use lang="en" attribute everywhere in inkscapeUTFen.xml?
Colin, I think we need a simple Makefile to create HTML version (at least HTML). Since my bash mojo is not so cool for last couple of years, maybe you could have a look? ;)
Alexandre
This SF.net email is sponsored by: Microsoft Defy all challenges. Microsoft(R) Visual Studio 2005. http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/ _______________________________________________ Inkscape-docs mailing list Inkscape-docs@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-docs
participants (4)
-
Alexandre Prokoudine -
Colin Marquardt -
Elisa-yemanja -
radar.map35＠...6...