RSS/Atom feed Twitter
Site is read-only, email is disabled

some docs fixes

This discussion is connected to the gimp-docs-list.gnome.org mailing list which is provided by the GIMP developers and not related to gimpusers.com.

This is a read-only list on gimpusers.com so this discussion thread is read-only, too.

5 of 5 messages available
Toggle history

Please log in to manage your subscriptions.

some docs fixes "Miroslav 15 Dec 00:42
  some docs fixes Ulf-D. Ehlert 15 Dec 20:14
   some docs fixes Miroslav Šulc 15 Dec 20:55
    some docs fixes Ulf-D. Ehlert 16 Dec 19:13
     some docs fixes Miroslav Šulc 16 Dec 21:09
"Miroslav
2010-12-15 00:42:30 UTC (almost 14 years ago)

some docs fixes

hi,

i am reading gimp documentation to learn gimp as i am complete newbie with gimp. as i am skilled with coding, i also decided to create some patches that fix issues in the documentation like wording etc. as i am newbie, i do not fix any content. i already put 5 patches on bugzilla and have one tiny on disk yet and did not finish reading the documentation yet.

there are three questions that i have:

1) as i did not follow gimp documentation project at all, i am not sure if it is the right time to create these patches, i have no idea whether there is an undergoing work elsewhere on preparing documentation for 2.8 release so my patches might not apply cleanly after these would be pushed into the main repo or maybe it's somewhere else already fixed.

2) should i also make patches that "move" documentation toward 2.8 release, like changes in shortcuts etc?

3) there are some inconsistencies in capitalization of chapter titles. i am really not sure whether i will find some time and will to fix this, but if i find it, what are the rules? i noticed some titles do not use capitalization of following words, but on the other hand, titles of images are sometimes capitalized.

also, if that would be preferable for you, i am skilled enough to do direct commits to the git repository, though my main scm that i use for my daily work is mercurial (which is pretty similar to git). but i suppose my help would be very limited as i am not skilled with gimp yet and i do not plan to read the documentation indefinetly :-) though i could probably help with extending the documentation while learning using gimp, but it's just hobby for me and it depends on my limited free time. anyway, i have no problem with putting patches on bugzilla, just that i might save you some time by direct commits.

also, i have one issue with understanding of documentation, the section about sample points. i was not able to make sample points work neither in gimp 2.6 nor 2.7 though i think i did it right (ctrl+click on ruler). anyone knows whether the documentation is correct and the feature does not work in gimp or there is some other way to make it work?

anyway, i must say that gimp documentation is really good and it's helping me to learn things that are not obvious to me from the gui and to understand some areas of making images.

miroslav

Ulf-D. Ehlert
2010-12-15 20:14:57 UTC (almost 14 years ago)

some docs fixes

Hi Miroslav,

Miroslav �ulc (Wednesday, 15. December 2010)

i am reading gimp documentation to learn gimp as i am complete newbie with gimp. as i am skilled with coding, i also decided to create some patches that fix issues in the documentation like wording etc. as i am newbie, i do not fix any content. i already put 5 patches on bugzilla and have one tiny on disk yet and did not finish reading the documentation yet.

Yes, thank you very much. :-) I just had no time (or was too lazy?) to apply them.

there are three questions that i have:

1) as i did not follow gimp documentation project at all, i am not sure if it is the right time to create these patches,

It's always the right time. ;-)

i have no
idea whether there is an undergoing work elsewhere on preparing documentation for 2.8 release so my patches might not apply cleanly after these would be pushed into the main repo or maybe it's somewhere else already fixed.

2) should i also make patches that "move" documentation toward 2.8 release, like changes in shortcuts etc?

No, not necessary. We did not start changing docs for v2.8.

3) there are some inconsistencies in capitalization of chapter titles. i am really not sure whether i will find some time and will to fix this, but if i find it, what are the rules? i noticed some titles do not use capitalization of following words, but on the other hand, titles of images are sometimes capitalized.

I'm not sure, too. It seems that most documentors prefer capitalization...

BTW: What do the official rules say?

also, if that would be preferable for you, i am skilled enough to do direct commits to the git repository, though my main scm that i use for my daily work is mercurial (which is pretty similar to git). but i suppose my help would be very limited as i am not skilled with gimp yet and i do not plan to read the documentation indefinetly :-) though i could probably help with extending the documentation while learning using gimp, but it's just hobby for me and it depends on my limited free time. anyway, i have no problem with putting patches on bugzilla, just that i might save you some time by direct commits.

So you have an account for git.gnome.org? Then I think it's ok if you commit (push) your patches. If you are not sure about your changes, use bugzilla (best way is to create patches with "git format-patch", but simple patches are also fine).

also, i have one issue with understanding of documentation, the section about sample points. i was not able to make sample points work neither in gimp 2.6 nor 2.7 though i think i did it right (ctrl+click on ruler). anyone knows whether the documentation is correct and the feature does not work in gimp or there is some other way to make it work?

It works: Ctrl-click on a ruler, hold the mouse button pressed, and move the pointer to the image.

Thank for your help,

bye, Ulf

Kein größeres Verbrechen als Gleichgültigkeit.
Gleichgültigsein heißt unablässig morden.
		-- Karlheinz Deschner
Miroslav Šulc
2010-12-15 20:55:45 UTC (almost 14 years ago)

some docs fixes

hi,

thanks for response, i was already giving up :-)

Dne 15.12.2010 21:14, Ulf-D. Ehlert napsal(a):

Hi Miroslav,

Miroslav �ulc (Wednesday, 15. December 2010)

i am reading gimp documentation to learn gimp as i am complete newbie with gimp. as i am skilled with coding, i also decided to create some patches that fix issues in the documentation like wording etc. as i am newbie, i do not fix any content. i already put 5 patches on bugzilla and have one tiny on disk yet and did not finish reading the documentation yet.

Yes, thank you very much. :-) I just had no time (or was too lazy?) to apply them.

i have 10 patches in my local git repo now fixing various problems, and now even in the proper format. i just did not want to spam bugzilla more.

there are three questions that i have:

1) as i did not follow gimp documentation project at all, i am not sure if it is the right time to create these patches,

It's always the right time. ;-)

cool :-)

i have no
idea whether there is an undergoing work elsewhere on preparing documentation for 2.8 release so my patches might not apply cleanly after these would be pushed into the main repo or maybe it's somewhere else already fixed.

2) should i also make patches that "move" documentation toward 2.8 release, like changes in shortcuts etc?

No, not necessary. We did not start changing docs for v2.8.

well, i guess i can make them then and when the time comes, i can just send them the right way.
i just do not want do duplicate someone elses work. time is precious :-)

3) there are some inconsistencies in capitalization of chapter titles. i am really not sure whether i will find some time and will to fix this, but if i find it, what are the rules? i noticed some titles do not use capitalization of following words, but on the other hand, titles of images are sometimes capitalized.

I'm not sure, too. It seems that most documentors prefer capitalization...

BTW: What do the official rules say?

nothing as far as i can remember. but generally, chapter topic in english should use capitalization except words like "the", "of" etc. at least that is what i was taught at school long time ago. about image titles, i am not sure whether they should be considered as titles (so capitalized) or just as labels without capitalization.

also, if that would be preferable for you, i am skilled enough to do direct commits to the git repository, though my main scm that i use for my daily work is mercurial (which is pretty similar to git). but i suppose my help would be very limited as i am not skilled with gimp yet and i do not plan to read the documentation indefinetly :-) though i could probably help with extending the documentation while learning using gimp, but it's just hobby for me and it depends on my limited free time. anyway, i have no problem with putting patches on bugzilla, just that i might save you some time by direct commits.

So you have an account for git.gnome.org? Then I think it's ok if you commit (push) your patches. If you are not sure about your changes, use bugzilla (best way is to create patches with "git format-patch", but simple patches are also fine).

well, i do not have account on git.gnome.org yet. and they say i should create one only if somebody tells me it's a good idea to do so :-)

also, i spent some time today on reading how git works exactly so as i wrote above, i have the patches in the format-patch format now too. i just don't know what to do with them, did not want to create extra spam on bugzilla.

also, i have one issue with understanding of documentation, the section about sample points. i was not able to make sample points work neither in gimp 2.6 nor 2.7 though i think i did it right (ctrl+click on ruler). anyone knows whether the documentation is correct and the feature does not work in gimp or there is some other way to make it work?

It works: Ctrl-click on a ruler, hold the mouse button pressed, and move the pointer to the image.

well, just tried with latest 2.7 and does not work, neither with mouse (that even does not catch click, weird) nor with stylus. in fact i am not even able to put guide on ruler that way. i must have something wrong in setup then.

Thank for your help,

bye,
Ulf

miroslav

Ulf-D. Ehlert
2010-12-16 19:13:45 UTC (almost 14 years ago)

some docs fixes

Miroslav Šulc (Wednesday, 15. December 2010)

i have 10 patches in my local git repo now fixing various problems, and now even in the proper format. i just did not want to spam bugzilla more.

Bugreports and bugfixes are obviously not spam. If you report bugs via bugzilla you make sure that we don't forget them. :-)

3) there are some inconsistencies in capitalization of chapter titles.

[...]

I'm not sure, too. It seems that most documentors prefer capitalization...

BTW: What do the official rules say?

nothing as far as i can remember. but generally, chapter topic in english should use capitalization except words like "the", "of" etc. at least that is what i was taught at school long time ago. about image titles, i am not sure whether they should be considered as titles (so capitalized) or just as labels without capitalization.

If I remember correctly I had learned the same rule at school (also long time ago), but meanwhile I think it depends on the weather, on the day of the week, or on some random number...

well, i do not have account on git.gnome.org yet. and they say i should create one only if somebody tells me it's a good idea to do so :-)

also, i spent some time today on reading how git works exactly so as i wrote above, i have the patches in the format-patch format now too. i just don't know what to do with them, did not want to create extra spam on bugzilla.

Using bugzilla and creating patches with "git format-patch" is a good way to start.

i was not able to make sample points

[...]

It works: Ctrl-click on a ruler, hold the mouse button pressed, and move the pointer to the image.

well, just tried with latest 2.7 and does not work, neither with mouse (that even does not catch click, weird) nor with stylus. in fact i am not even able to put guide on ruler that way. i must have something wrong in setup then.

But your mouse works, so that you can, for example, create selections using the mouse?

Bye,
Ulf

Sie vernichten Getreide - und sammeln Brot für die Welt.
		-- Karlheinz Deschner
Miroslav Šulc
2010-12-16 21:09:13 UTC (almost 14 years ago)

some docs fixes

Dne 16.12.2010 20:13, Ulf-D. Ehlert napsal(a):

Miroslav Šulc (Wednesday, 15. December 2010)

i have 10 patches in my local git repo now fixing various problems, and now even in the proper format. i just did not want to spam bugzilla more.

Bugreports and bugfixes are obviously not spam. If you report bugs via bugzilla you make sure that we don't forget them. :-)

well, i hope you will not regret what you wrote :-P anyway, it's little bit discouraging to see no reaction for the bugs at bugzilla but i guess the docs team is busy with other things (like real life, christmas, end of year related work etc). it's understandable as this is just volunteer work, i just like to see things moving forward :-)

3) there are some inconsistencies in capitalization of chapter titles.

[...]

I'm not sure, too. It seems that most documentors prefer capitalization...

BTW: What do the official rules say?

nothing as far as i can remember. but generally, chapter topic in english should use capitalization except words like "the", "of" etc. at least that is what i was taught at school long time ago. about image titles, i am not sure whether they should be considered as titles (so capitalized) or just as labels without capitalization.

If I remember correctly I had learned the same rule at school (also long time ago), but meanwhile I think it depends on the weather, on the day of the week, or on some random number...

yes, it looks that way when reading the documentation, each part was written under different circumstances :-P in my opinion, all titles should be capitalized, but label of images should not. i know this is just style issue, it does not affect the quality of the content, but the documentation would definitely look more professional with these things fixed. in fact the documentation is really cool, but things like duplicated words and these style issues are little bit distracting (to me).

well, i do not have account on git.gnome.org yet. and they say i should create one only if somebody tells me it's a good idea to do so :-)

also, i spent some time today on reading how git works exactly so as i wrote above, i have the patches in the format-patch format now too. i just don't know what to do with them, did not want to create extra spam on bugzilla.

Using bugzilla and creating patches with "git format-patch" is a good way to start.

well, as i think of it, the best way would be to create the patches on gimp-help-2-6-0 branch (to fix current documentation) and then merge them to master branch and update them to the changes in master branch (to have the fixes at the latest changes too), but that would produce even more work (now i have 10 patches and it's sure not final number) and (afaik) i cannot do patches for merges so someone from the docs team would have to spend his/her time on this.

also, i noticed that some changes in gimp-help-2-6-0 branch were not merged into master branch which might complicate the merge little bit. at least 'git log remotes/origin/master..remotes/origin/gimp-help-2-6-0' shows some commits. though when looking at it more deeply, it seems some changes from release reported as not merged are in master anyway, so maybe they were done as different commits (which is not in my opinion correct, they should be merged from the instead, this way it creates little mess with the merges).

anyway, in my opinion my fixes should go both to gimp-help-2-6-0 and to master, which means i should redo the patches for gimp-help-2-6-0 and then someone with push rights should merge the commits to master (so the list of unmerged commits from branch to master does not grow) and master should be then scanned for the issues and fixed too in case some things that the patches fix would be still left there (due to changes in master). what is your opinion? and if you'd agree with this approach, how will we do that? looks like it will take some time when several people working on it. i just don't like wasting time, whether it is my time or time of somebody else :-)

i was not able to make sample points

[...]

It works: Ctrl-click on a ruler, hold the mouse button pressed, and move the pointer to the image.

well, just tried with latest 2.7 and does not work, neither with mouse (that even does not catch click, weird) nor with stylus. in fact i am not even able to put guide on ruler that way. i must have something wrong in setup then.

But your mouse works, so that you can, for example, create selections using the mouse?

well, to be exact, i have laptop with synaptics touchpad and wacom tablet. as tablet gestures work weird in linux (they are not usable), i have touch features of table disabled, but still, there is some issue with loading synaptics driver for my touchpad as since i plugged the tablet, some advanced features of the touchpad (like scrolling) do not work and i did not have time to fix this yet.

anyway, clicking with mouse works everywhere except the image window it seems (clicking into image window does not work, but clicking on menu in image window works, so it looks like window manager can handle the clicks but gimp cannot). so i can't paint with touchpad (nor trigger context menu in image window) but i can paint with stylus. but even with stylus i can't place guides nor create sample points.

also, i have one more question. i noticed that in some cases dialog fields are not marked with tags so they appear in documentation as regular text. i guess all references to dialog fields should be marked with tags, am i correct?

Bye,
Ulf

miroslav