Bug 121751

Summary: krita documentation typos and errors
Product: [Websites] docs.kde.org Reporter: Burkhard Lück <lueck>
Component: generalAssignee: Sander Koning <sanderkoning>
Status: RESOLVED FIXED    
Severity: normal    
Priority: NOR    
Version: unspecified   
Target Milestone: ---   
Platform: Compiled Sources   
OS: Linux   
Latest Commit: Version Fixed In:
Sentry Crash Report:
Attachments: patch for sander
new screenshot as example for Chapter 5 Filters

Description Burkhard Lück 2006-02-11 10:49:49 UTC
Version:            (using KDE Devel)
Installed from:    Compiled sources

Hi Sander,

great documentation!

found some typos and "unvisible" screenshots, svn diff follows

Some problems / questions:

In the tutorial in section "A Small selections and layers tutorial" 
you write:
The image above is the image we will work with. Save it to disk 
(by right-clicking on it and choosing Save Image As...)

This does not work in khelpcenter, only if you generate the documentation 
as html files and view them in konqueror :(

Is it possible to provide a link to this image in the docbook?

Chapter 4. Selections
Later you can subtract from the selection with say the select-eraser.

I don't understand this sentence, -v please
Comment 1 Burkhard Lück 2006-02-11 10:53:01 UTC
Created attachment 14636 [details]
patch for sander

fixed some typos.
 
Chapter 7 Command Reference -> Dialogs
fixed the image names to display all missing screenshots

Please provide the image you used in the screenshots (New Adjustment Layer
dialog, 
Brightness / Contrast dialog, Bumpmap dialog etc)
in section Command Reference - Dialogs for the translators
Comment 2 Burkhard Lück 2006-02-11 10:58:31 UTC
Created attachment 14637 [details]
new screenshot as example for Chapter 5 Filters

Chapter 5 Filters
would be a nice improvement to display original and filtered image 
side by side as shown in my attachment.

Is it possible to display two images side by side in a kde docbook?
I couldn't find a way to do this, so I created a new image
crocusses-bumpmap.png
Comment 3 Sander Koning 2006-02-11 16:25:36 UTC
Thanks! I've got a lot of comments by our famous Natalie which I'll append to this report to keep all stuff in one place.

> The image above is the image we will work with. Save it to disk 
> (by right-clicking on it and choosing Save Image As...) 
> This does not work in khelpcenter, only if you generate the documentation 
> as html files and view them in konqueror :( 
> 
> Is it possible to provide a link to this image in the docbook? 

I don't know. If there is a way to do so other than to use a URL to some external server (which will definitely be outdated at some point), tell me!
 
> Chapter 4. Selections 
> Later you can subtract from the selection with say the select-eraser. 
>
> I don't understand this sentence, -v please 

should perhaps be rewritten to something like
"Later on, you can subtract areas from the selection by using, for example, the Erase Selection tool"

> Please provide the image you used in the screenshots (New Adjustment Layer 
> dialog, Brightness / Contrast dialog, Bumpmap dialog etc) 
> in section Command Reference - Dialogs for the translators 

Where's the best way to do so?
Comment 4 Burkhard Lück 2006-02-22 13:46:34 UTC
1. Tutorial "A Small selections and layers tutorial" 
perhaps change 
The image above is the image we will work with. Save it to disk 
(by right-clicking on it and choosing Save Image As...)
to
The image above is the image we will work with. Start krita with this 
image (in the documentation folder $KDEDIR/share/doc/HTML/en/krita/tutorial-select-layer-sample.png)
and save it to your Home folder (by choosing Save Image As...).

Perhaps the user needs an explanation about $KDEDIR?
I have no idea how to provide a link in the docbook to start krita with a certain image:(

2. 
>> Please provide the image you used in the screenshots (New Adjustment Layer 
>> dialog, Brightness / Contrast dialog, Bumpmap dialog etc) 
>> in section Command Reference - Dialogs for the translators 

>Where's the best way to do so?

Put a README.SCREENSHOTS and the *.png's into kritas documentation folder?

3.  Chapter 5 Filters display 
original and filtered image side by side

If you like this idea, I could take the necessary screenshots

Please apply my patch (id=14636) to get visible screenshots
 
Comment 5 Sander Koning 2006-06-08 08:10:12 UTC
SVN commit 549298 by skoning:

Finally fix Burkhard's bug report :)
Well, almost... the side-by-side screenshots still have to be made, but that's coming up.

BUG:121751



 M  +2 -2      commands-dialogs.docbook  
 M  +1 -1      commands-menus.docbook  
 M  +2 -2      index.docbook  
 M  +1 -1      introduction.docbook  
 M  +6 -3      tutorial-select-layer.docbook  
 M  +2 -2      using-selections.docbook  


--- branches/koffice/1.6/koffice/doc/krita/commands-dialogs.docbook #549297:549298
@@ -745,7 +745,7 @@
 <screeninfo>The Custom Convolution filter</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="filters-customconvolution.png" format="PNG" />
+<imagedata fileref="dialogs-customconvolution.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>The Custom Convolution filter</phrase>
@@ -836,7 +836,7 @@
 <screeninfo>The Image Restauration dialog</screeninfo>
 <mediaobject>
 <imageobject>
-<imagedata fileref="" format="PNG" />
+<imagedata fileref="dialogs-imagerestoration.png" format="PNG" />
 </imageobject>
 <textobject>
 <phrase>The Image Restauration dialog</phrase>
--- branches/koffice/1.6/koffice/doc/krita/commands-menus.docbook #549297:549298
@@ -1109,7 +1109,7 @@
 </menuchoice></term>
 <listitem><para><action>Opens the <link
 linkend="commands-dialogs-layers-layerproperties"><guilabel>Layer
-Properties</guilabel>dialog</link>.</action> You can change the name,
+Properties</guilabel> dialog</link>.</action> You can change the name,
 colorspace, opacity, composite mode and position of the current layer
 here.</para></listitem>
 </varlistentry>
--- branches/koffice/1.6/koffice/doc/krita/index.docbook #549297:549298
@@ -75,8 +75,8 @@
 
 <!-- Date and version information of the documentation -->
 
-<date>2006-01-31</date>
-<releaseinfo>1.5.0</releaseinfo>
+<date>2006-06-08</date>
+<releaseinfo>1.6-pre</releaseinfo>
 
 <!-- Abstract about this handbook -->
 
--- branches/koffice/1.6/koffice/doc/krita/introduction.docbook #549297:549298
@@ -63,7 +63,7 @@
 erase, airbrush and more.</para></listitem>
 
 <listitem><para>Filters: &krita; can multithread the operation of some
-filters. Flters can be previewed in the filter gallery. Available filters
+filters. Filters can be previewed in the filter gallery. Available filters
 include color adjustment, sharpen or blur, emboss, raindrops, and
 more.</para></listitem>
 
--- branches/koffice/1.6/koffice/doc/krita/tutorial-select-layer.docbook #549297:549298
@@ -16,9 +16,12 @@
 </screenshot>
 
 <para>
-The image above is the image we will work with. Save it to disk (by
-right-clicking on it and choosing <guilabel>Save Image As...</guilabel>) and
-then open it in &krita; &mdash; your screen will look a bit like this (we have
+The image above is the image we will work with. Start krita with this 
+image (in the documentation folder
+<filename>$<envar>KDEDIR</envar>/share/doc/HTML/en/krita/tutorial-select-layer-sample.png</filename>) 
+and save it to your Home folder (by choosing <guilabel>Save Image As...</guilabel>).
+
+Then open it in &krita; &mdash; your screen will look a bit like this (we have
 zoomed in):
 </para>
 
--- branches/koffice/1.6/koffice/doc/krita/using-selections.docbook #549297:549298
@@ -25,8 +25,8 @@
 A whole range of tools exist to make selections. From rectangles, ellipses
 and freehand to the more exotic like color range select. When you make
 several selections they add up. So a rectangle select followed by an
-ellipse select select both areas. Later you can subtract from the selection
-with say the select-eraser.
+ellipse select select both areas. Later on, you can subtract areas from
+the selection by using, for example, the Erase Selection tool.
 </para><para>
 To get back to normal (no active selection), choose
 <menuchoice><guimenu>Select</guimenu><guimenuitem>Deselect</guimenuitem>