Hi Michael,

OK for substance.

Some remarks about form:

> Lastly, how important is the way these files are indented? I always use > tabs, and any editor I'm familiar with uses tabs to indent lines, while > these files seem to use spaces. Is is important to indent the XML in > this way?

- TAB are set to 2 spaces.

- Lines are less than 80 characters and spaces.

- When explaining a term, please add an
Resolution

This will automatcally appear in the "index" chapter: last line in the html summary.

- I noticed 2 typos: "reslution" and "noticable". You probably have a spelling command in your editor.

what
is the significance of adding "acronym" and "quote" tags? what are they for? they seem to have no influence on the final output.

For "acronym>, I don't know. But "quote" is important for internationalization. With Hello, I automatically get the French quotes in French html (« Hello ») with indivisible spaces!

I made these changes in your xml file. Do you want I push your changes?

Regards,

Julien

Den 23.02.2011 08:34, skreiv Julien Hardelin:

Hi Michael,

…

what
is the significance of adding "acronym" and "quote" tags? what are they for? they seem to have no influence on the final output.

For "acronym>, I don't know.

The tag capitalize the contents of the tag. gimp outputs GIMP.

BTW: For some reasons the tag does not work in Norwegian. Hello is written as "Hello" instead of «Hello». (We are using the same quotes as in French). Kolbjoern

But "quote" is important for
internationalization. WithHello, I automatically get the French quotes in French html (« Hello ») with indivisible spaces!

I made these changes in your xml file. Do you want I push your changes?

Regards,

Julien

Kolbjørn Stuestøl (Wednesday, 23. February 2011)

BTW: For some reasons the tag does not work in Norwegian. Hello is written as "Hello" instead of «Hello». (We are using the same quotes as in French).

This is a DocBook bug, IMHO. Try to change the quote chars manually (in /usr/share/xml/docbook/stylesheet/nwalsh/1.75.2/common/nn.xml or wherever your language file is) to be sure.

Bye, Ulf

Erstaunlich, wie vieles sich verständigt, ohne Verstand zu haben,
und wie viele Verstand haben, ohne sich verständigen zu können.
		-- Karlheinz Deschner

Michael Grosberg (Tuesday, 22. February 2011)

what is the significance of adding "acronym" and "quote" tags? what are they for? they seem to have no influence on the final output.

tags are important to set the correct quotation chars.

tags are used to convert the enclosed text to capital letters, AFAIK (I never did any tests), and add ...
to the HTML output, which may be used in CSS stylesheets. So right now they are not really important -- it's good style and correct if you use them, but nothing happens if you forget it.

Lastly, how important is the way these files are indented? I always use tabs, and any editor I'm familiar with uses tabs to indent lines, while these files seem to use spaces. Is is important to indent the XML in this way?

By convention we use two spaces. Mixing tabs and spaces will make the XML files less readable, especially if someone uses a different editor.

Bye,
Ulf

Religionen sind falsche Mittel zur Befriedigung
echter Bedürfnisse.
		-- Karlheinz Deschner

Den 23.02.2011 13:32, skreiv Ulf-D. Ehlert:

Kolbjørn Stuestøl (Wednesday, 23. February 2011)

BTW: For some reasons the tag does not work in Norwegian. Hello is written as "Hello" instead of «Hello». (We are using the same quotes as in French).

This is a DocBook bug, IMHO. Try to change the quote chars manually (in /usr/share/xml/docbook/stylesheet/nwalsh/1.75.2/common/nn.xml or wherever your language file is) to be sure.

Bye, Ulf

The Windows keyboard do not has the «» quote signs by default. Linux has. I'll give your suggestion a try. Until now I have deleted the tag and entered the signs by hand in my translated po files. (Not in the original xml files).
Thank you, Ulf.
Kolbjoern

Gimp-docs mailing list
Gimp-docs@lists.XCF.Berkeley.EDU
https://lists.XCF.Berkeley.EDU/mailman/listinfo/gimp-docs

The main reason for using things like and is to separate function
from appearance. With tags that describe the function of an entity, even if the appearance
is currently just plain text, it can be changed at any time by altering the rules for rendering
entities, without having to rewrite the xml code for the whole document. The principle is
to use a different tag for any entity that the manual *might sometime* want to render in a
special way.

Regarding tabs, the reason for using spaces instead is that there is no fixed rule for converting
tabs to spaces, so when tabs are used, the appearance of the document will vary depending
of which editor is used to work on it.

-- Bill

- When explaining a term, please add an
Resolution

This will automatcally appear in the "index" chapter: last line in the html summary.

I've been meaning to ask about this: There were 7 terms in concepts.xml but only one of them, channels, had an indexterm. So if I understand correctly, the reason is that those other terms are explained at length elsewhere, and THOSE places are linked to in the index, while there is no other reference to resolution in the help?

That is docbook rules: there is no varlistentry parent for indexterm but there is title. In varlistentry you must include indexterm within tags.
Please see > http://docbook.org/tdg/en/html/indexterm.html There are some inconsistencies in the index. It has to be reviewed.

I made these changes in your xml file. Do you want I push your changes?

Sure.

Done
http://git.gnome.org/browse/gimp-help-2/