[Darktable-users] translation of user manual + Mallard

[Federico Bruni]

Hi

I wonder if translating the user manual is possible.. I think I've read on
this list that there are some problems at the moment, but I'm not sure that
I remember correctly.

I'm asking just out of curiosity.
I'm already involved in a big translation project (documentation of
lilypond) and I don't have any time left to contribute to another one,
except as occasional reviewer.

I'm writing this email also to let you know about this interesting tool,
Mallard:
http://projectmallard.org/
http://booki.flossmanuals.net/introduction-to-mallard/comparing-mallard-to-other-tools/

Never tried, but it seems interesting. Do you know it?
Don't know if it's the right tool for the documentation of Darktable.

[Tobias Ellinghaus]

Post by Federico Bruni
Hi

Hi.

Post by Federico Bruni
I wonder if translating the user manual is possible.. I think I've read on
this list that there are some problems at the moment, but I'm not sure that
I remember correctly.

The user manual is translated using the .po files in doc/usermanual/po/. To
update them run "make update-usermanual-<LANG>" in build/. If your language
doesn't have a .po file yet the update-usermanual-<LANG> target will probably
not exist, to fix that add the language to doc/usermanual/po/LINGUAS, clean
build/ and rerun cmake. That *should* add it so that the make call will
generate the .po file.

To generate the translated user manual run "make darktable-usermanual-<LANG>".

Post by Federico Bruni
I'm asking just out of curiosity.

Mind the cat.

[...]

Tobias

[Federico Bruni]

Post by Tobias Ellinghaus

Post by Federico Bruni
Hi

Hi.

Post by Federico Bruni
I wonder if translating the user manual is possible.. I think I've read

on

Post by Federico Bruni
this list that there are some problems at the moment, but I'm not sure

that

Post by Federico Bruni
I remember correctly.

The user manual is translated using the .po files in doc/usermanual/po/. To
update them run "make update-usermanual-<LANG>" in build/. If your language
doesn't have a .po file yet the update-usermanual-<LANG> target will probably
not exist, to fix that add the language to doc/usermanual/po/LINGUAS, clean
build/ and rerun cmake. That *should* add it so that the make call will
generate the .po file.

I've added 'it' to doc/usermanual/po/LINGUAS. Then:

./build.sh
cd build
make update-usermanual-it
make: *** No rule to make target `update-usermanual-it'. Stop.

I can find only the target 'usermanual' and 'locale_it' in the Makefile.

[Victor L]

Hello,

Here is the procedure I followed :

Install gnome-doc-util doxygene on your computer (sudo apt-get install -y
gnome-doc-util doxygene on Ubuntu for example). I'm not sure the two are
necessary..
Pull the git and run build.sh.

Then cd ./build && make darktable-usermanual-html should work.
Unfortunately I get an error :

***@desktop:~/darktable/build$ make darktable-usermanual-html
[ 0%] Built target darktable_single_xml
[100%] Built target target_media_images
Scanning dependencies of target darktable-usermanual-html
[100%] Updating usermanual.css
[100%] Building html usermanual
No adjustColumnWidths function available.
Processing terminated by xsl:message at line 402
make[3]: *** [doc/usermanual/html/index.html] Erreur 1
make[2]: *** [doc/usermanual/CMakeFiles/darktable-usermanual-html.dir/all]
Erreur 2
make[1]: *** [doc/usermanual/CMakeFiles/darktable-usermanual-html.dir/rule]
Erreur 2
make: *** [darktable-usermanual-html] Erreur 2

I don't know how to solve this and if this is a bug, help would be
appreciated.
Bye !

[Ulrich Pegelow]

Hi,

in order to properly build the html version of the manual you need to
have saxon version 6.5 installed on your computer. It typically consists
of a single file saxon.jar or saxon6.jar (or the like) in /usr/share/java.

In addition our build routines need to find the corresponding docbook
extension library. This are unfortunately named similarly (typically
saxon65.jar) and should sit in a place within your docbook installation
folder. Something like
/usr/share/xml/docbook/stylesheet/nwalsh/1.78.0/extensions/saxon65.jar

Ulrich

Post by Victor L
Hello,
Install gnome-doc-util doxygene on your computer (sudo apt-get install
-y gnome-doc-util doxygene on Ubuntu for example). I'm not sure the two
are necessary..
Pull the git and run build.sh.
Then cd ./build && make darktable-usermanual-html should work.
[ 0%] Built target darktable_single_xml
[100%] Built target target_media_images
Scanning dependencies of target darktable-usermanual-html
[100%] Updating usermanual.css
[100%] Building html usermanual
No adjustColumnWidths function available.
Processing terminated by xsl:message at line 402
make[3]: *** [doc/usermanual/html/index.html] Erreur 1
make[2]: ***
[doc/usermanual/CMakeFiles/darktable-usermanual-html.dir/all] Erreur 2
make[1]: ***
[doc/usermanual/CMakeFiles/darktable-usermanual-html.dir/rule] Erreur 2
make: *** [darktable-usermanual-html] Erreur 2
I don't know how to solve this and if this is a bug, help would be
appreciated.
Bye !

[Federico Bruni]

I'm getting the same error of Victor.

# aptitude show libsaxon-java | grep Version
Version: 1:6.5.5-10

# ls /usr/share/java | grep saxon
saxon-6.5.5.jar
saxon.jar
saxon-jdom-6.5.5.jar
saxon-jdom.jar

In case it matters, when I run the build I see this:

-- Could NOT find Java (missing: Java_JAR_EXECUTABLE Java_JAVAC_EXECUTABLE
Java_JAVAH_EXECUTABLE Java_JAVADOC_EXECUTABLE) (found version "1.7.0.25")

Post by Ulrich Pegelow
Hi,
in order to properly build the html version of the manual you need to
have saxon version 6.5 installed on your computer. It typically consists
of a single file saxon.jar or saxon6.jar (or the like) in /usr/share/java.
In addition our build routines need to find the corresponding docbook
extension library. This are unfortunately named similarly (typically
saxon65.jar) and should sit in a place within your docbook installation
folder. Something like
/usr/share/xml/docbook/stylesheet/nwalsh/1.78.0/extensions/saxon65.jar
Ulrich

Post by Victor L
Hello,
Install gnome-doc-util doxygene on your computer (sudo apt-get install
-y gnome-doc-util doxygene on Ubuntu for example). I'm not sure the two
are necessary..
Pull the git and run build.sh.
Then cd ./build && make darktable-usermanual-html should work.
[ 0%] Built target darktable_single_xml
[100%] Built target target_media_images
Scanning dependencies of target darktable-usermanual-html
[100%] Updating usermanual.css
[100%] Building html usermanual
No adjustColumnWidths function available.
Processing terminated by xsl:message at line 402
make[3]: *** [doc/usermanual/html/index.html] Erreur 1
make[2]: ***
[doc/usermanual/CMakeFiles/darktable-usermanual-html.dir/all] Erreur 2
make[1]: ***
[doc/usermanual/CMakeFiles/darktable-usermanual-html.dir/rule] Erreur 2
make: *** [darktable-usermanual-html] Erreur 2
I don't know how to solve this and if this is a bug, help would be
appreciated.
Bye !

------------------------------------------------------------------------------
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
_______________________________________________
Darktable-users mailing list
https://lists.sourceforge.net/lists/listinfo/darktable-users

[Federico Bruni]

Post by Victor L
Install gnome-doc-util doxygene on your computer (sudo apt-get install -y
gnome-doc-util doxygene on Ubuntu for example). I'm not sure the two are
necessary..

thank you, after installing these two packages (and re-running the build
from scratch) I have the targets I need:

$ make help | grep usermanual
... usermanual
... update-usermanual
... update-usermanual-cs
... update-usermanual-de
... update-usermanual-fr
... update-usermanual-it
... update-usermanual-nl
... update-usermanual-pl
... update-usermanual-pt_BR
... update-usermanual-sv

BTW, no -html target because I don't have Saxon (as Ulrich pointed out):

# apt-file search saxon.jar
docbook-xsl-saxon: /usr/share/java/docbook-xsl-saxon.jar
libsaxon-java: /usr/share/java/saxon.jar

Installing libsaxon-java should fix it.
There's no documentation about compiling the usermanual and set new
translations? If I succedd, can I add a page in the user's wiki?

[Federico Bruni]

Post by Federico Bruni
$ make help | grep usermanual
... usermanual
... update-usermanual
... update-usermanual-cs
... update-usermanual-de
... update-usermanual-fr
... update-usermanual-it
... update-usermanual-nl
... update-usermanual-pl
... update-usermanual-pt_BR
... update-usermanual-sv

now I have -html but only for the english language,I think:

$ make help | grep html
... darktablerc.html
... darktable-usermanual-html


update-usermanual-it works fine and it generates darktable_single-it.xml
how can I generate the html file?

[Ulrich Pegelow]

Post by Federico Bruni
$ make help | grep usermanual
... usermanual
... update-usermanual
... update-usermanual-cs
... update-usermanual-de
... update-usermanual-fr
... update-usermanual-it
... update-usermanual-nl
... update-usermanual-pl
... update-usermanual-pt_BR
... update-usermanual-sv
$ make help | grep html
... darktablerc.html
... darktable-usermanual-html
update-usermanual-it works fine and it generates darktable_single-it.xml
how can I generate the html file?

Before you spend much time with all this stuff, I hope you are aware
that there currently is no up-to-date translation of the usermanual at
all. The only one we have is the english original version.

Ulrich

[Federico Bruni]

Post by Ulrich Pegelow
Before you spend much time with all this stuff, I hope you are aware
that there currently is no up-to-date translation of the usermanual at
all. The only one we have is the english original version.

I know, I'm spending time on this stuff because I may want to translate the
usermanual.
But I want to be sure that my work can be used before starting

[Ulrich Pegelow]

Post by Ulrich Pegelow
Before you spend much time with all this stuff, I hope you are aware
that there currently is no up-to-date translation of the usermanual at
all. The only one we have is the english original version.
I know, I'm spending time on this stuff because I may want to translate
the usermanual.
But I want to be sure that my work can be used before starting

If you want to play with that I'd recommend to go for the translated PDF
as AFAIK we don't have targets to generate translated html versions
(nobody needs them).

So you would need to:

cd ./build/doc/usermanual
make darktable-usermanual-it

However, you will notice that the Italian language version is not
existing as a target yet and would need to be added. You may take the
French version as a model. Beware that also for the French version there
is no up-to-date translation - and it would be a *lot* of work for any
language.

Ulrich

[Federico Bruni]

Post by Ulrich Pegelow

Post by Ulrich Pegelow
Before you spend much time with all this stuff, I hope you are aware
that there currently is no up-to-date translation of the usermanual at
all. The only one we have is the english original version.
I know, I'm spending time on this stuff because I may want to translate
the usermanual.
But I want to be sure that my work can be used before starting

If you want to play with that I'd recommend to go for the translated PDF
as AFAIK we don't have targets to generate translated html versions (nobody
needs them).

well, this is your opinion :-)

Post by Ulrich Pegelow
cd ./build/doc/usermanual
make darktable-usermanual-it

this creates only a .xml file
I can see no PDF file

Post by Ulrich Pegelow
However, you will notice that the Italian language version is not existing
as a target yet and would need to be added. You may take the French version
as a model. Beware that also for the French version there is no up-to-date
translation - and it would be a *lot* of work for any language.

I've already added 'it' to LINGUAS.
I know it's a lot of work, that's why I'm trying to understand how it works
before starting

[johannes hanika]

Post by Federico Bruni

Post by Ulrich Pegelow

Post by Ulrich Pegelow
Before you spend much time with all this stuff, I hope you are aware
that there currently is no up-to-date translation of the usermanual at
all. The only one we have is the english original version.
I know, I'm spending time on this stuff because I may want to translate
the usermanual.
But I want to be sure that my work can be used before starting

If you want to play with that I'd recommend to go for the translated PDF
as AFAIK we don't have targets to generate translated html versions (nobody
needs them).

well, this is your opinion :-)

Post by Ulrich Pegelow
cd ./build/doc/usermanual
make darktable-usermanual-it

this creates only a .xml file
I can see no PDF file

did you have a look in doc/usermanual (not build/[..])?

j.

Post by Federico Bruni

Post by Ulrich Pegelow
However, you will notice that the Italian language version is not
existing as a target yet and would need to be added. You may take the
French version as a model. Beware that also for the French version there is
no up-to-date translation - and it would be a *lot* of work for any
language.

I've already added 'it' to LINGUAS.
I know it's a lot of work, that's why I'm trying to understand how it
works before starting
------------------------------------------------------------------------------
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
_______________________________________________
Darktable-users mailing list
https://lists.sourceforge.net/lists/listinfo/darktable-users

[Federico Bruni]

Post by Federico Bruni
this creates only a .xml file

Post by Federico Bruni
I can see no PDF file

did you have a look in doc/usermanual (not build/[..])?

oops, I was checking only inside build/. Yes the translated PDF file is
there.
I've added some basic instructions on the users' wiki:
http://www.darktable.org/redmine/projects/users/wiki/Translating_the_usermanual

[johannes hanika]

Post by Federico Bruni

Post by Federico Bruni
this creates only a .xml file

Post by Federico Bruni
I can see no PDF file

did you have a look in doc/usermanual (not build/[..])?

oops, I was checking only inside build/. Yes the translated PDF file is
there.
http://www.darktable.org/redmine/projects/users/wiki/Translating_the_usermanual

nice, thanks :)

[Victor L]

The instructions works fine for me, thanks.

There is one image missing :
Image not found. URI:
/home/victor/darktable/build/doc/usermanual/media/images/darkroom_module_icon_invert.jpg.
(See position 921:412)
This file doesn't exist in the git repo.

And two other "warnings" :
Line 1 of a paragraph overflows the available area by 4725 millipoints.
(See position 2223:375)
span="inherit" on fo:block, but no explicit value found on the parent FO.

I can't find where is the original english manual. Can you point me the
file ?

Bye !

Post by johannes hanika

Post by Federico Bruni

Post by Federico Bruni
this creates only a .xml file

Post by Federico Bruni
I can see no PDF file

did you have a look in doc/usermanual (not build/[..])?

oops, I was checking only inside build/. Yes the translated PDF file is
there.
http://www.darktable.org/redmine/projects/users/wiki/Translating_the_usermanual

nice, thanks :)
------------------------------------------------------------------------------
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
_______________________________________________
Darktable-users mailing list
https://lists.sourceforge.net/lists/listinfo/darktable-users

[Ulrich Pegelow]

Post by Victor L
The instructions works fine for me, thanks.
/home/victor/darktable/build/doc/usermanual/media/images/darkroom_module_icon_invert.jpg.
(See position 921:412)
This file doesn't exist in the git repo.

Thanks for the hint. I probably forgot to add it to git. Will do in a
second.

Post by Victor L
Line 1 of a paragraph overflows the available area by 4725 millipoints.
(See position 2223:375)
span="inherit" on fo:block, but no explicit value found on the parent FO.

These are just warnings. Hopefully we can fix them before the final
version 1.4 manual gets published.

Post by Victor L
I can't find where is the original english manual. Can you point me the
file ?

As Jo has pointed out. Surprisingly the final PDFs are not found in
darktable/build/doc/usermanual but in darktable/doc/usermanual.

Ulrich

[Victor L]

I'm not looking for the final file but for the source (*.po ?), sorry for
the misunderstanding.
In every .po file there are english quotes and the translation. But where
are the original english quotes ? This is what i'm looking for.

Post by Victor L

Post by Victor L
The instructions works fine for me, thanks.

/home/victor/darktable/build/doc/usermanual/media/images/darkroom_module_icon_invert.jpg.

Post by Victor L
(See position 921:412)
This file doesn't exist in the git repo.

Thanks for the hint. I probably forgot to add it to git. Will do in a
second.

Post by Victor L
Line 1 of a paragraph overflows the available area by 4725 millipoints.
(See position 2223:375)
span="inherit" on fo:block, but no explicit value found on the parent FO.

These are just warnings. Hopefully we can fix them before the final
version 1.4 manual gets published.

Post by Victor L
I can't find where is the original english manual. Can you point me the
file ?

As Jo has pointed out. Surprisingly the final PDFs are not found in
darktable/build/doc/usermanual but in darktable/doc/usermanual.
Ulrich
------------------------------------------------------------------------------
Android is increasing in popularity, but the open development platform that
developers love is also attractive to malware creators. Download this white
paper to learn more about secure code signing practices that can help keep
Android apps secure.
http://pubads.g.doubleclick.net/gampad/clk?id=65839951&iu=/4140/ostg.clktrk
_______________________________________________
Darktable-users mailing list
https://lists.sourceforge.net/lists/listinfo/darktable-users

[Federico Bruni]

Post by Victor L
I'm not looking for the final file but for the source (*.po ?), sorry for
the misunderstanding.
In every .po file there are english quotes and the translation. But where
are the original english quotes ? This is what i'm looking for.

what are you trying to do exactly?
the original english template is doc/usermanual/po/darktable-usermanual.pot
AFAICS it is updated when you run 'make update-usermanual-XX'

[Tobias Ellinghaus]

Post by Federico Bruni

Post by Federico Bruni
this creates only a .xml file

Post by Federico Bruni
I can see no PDF file

did you have a look in doc/usermanual (not build/[..])?

oops, I was checking only inside build/. Yes the translated PDF file is
there.
http://www.darktable.org/redmine/projects/users/wiki/Translating_the_userman
ual

The documentation was already in git, see doc/usermanual/README. Having
something in the Wiki is good, too, but please put it into the regular one,
the user's Wiki is not the place for this.

Tobias

[Federico Bruni]

Post by Federico Bruni
http://www.darktable.org/redmine/projects/users/wiki/Translating_the_userman

ual

The documentation was already in git, see doc/usermanual/README. Having
something in the Wiki is good, too, but please put it into the regular one,
the user's Wiki is not the place for this.

I missed that file, I think that it contains all the information needed,
even if not in an easy-to-use form.
I've added a note to the wiki page above.

BTW, I've started the italian translation. Just preface and first chapter
so far (4%).
I think I'll send a pull request once I've done chapters 2 and 3. The rest
of the manual will be translated later. Hopefully other italian translators
will step in to review and translate.