Bug 115344 - Incomprehensible text in kgeography 0.4 handbook
Summary: Incomprehensible text in kgeography 0.4 handbook
Status: RESOLVED FIXED
Alias: None
Product: docs.kde.org
Classification: Websites
Component: general (show other bugs)
Version: unspecified
Platform: Compiled Sources Linux
: NOR normal
Target Milestone: ---
Assignee: Documentation Editorial Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-10-29 22:44 UTC by mkkot
Modified: 2006-01-05 21:08 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description mkkot 2005-10-29 22:44:01 UTC
Version:           0.4 (using KDE Devel)
Installed from:    Compiled sources
OS:                Linux

Hi,
I'm from kde-i18n team. I tried to translate kgeography 0.4 (from KDE 3.5) handbook and I meet this text:

<ignore> and </ignore>: must be yes if the division should be ignored when asking for divisions in that map. If it is allowClickMode KGeography will ask the division in the Click on division mode but not in others. This tag is optional: e.g. “Algeria” has this tag set to yes in the “Europe” map.

It is here: http://docs.kde.org/development/en/kdeedu/kgeography/description-file.html

I don't understand "allowClickMode" and "KGeography will ask the division". IMHO this doesn't have sense. Please, write it more clearly.
Comment 1 Anne-Marie Mahfouf 2005-12-28 23:51:40 UTC
SVN commit 492155 by annma:

bug 115344
BUG=115344


 M  +2 -2      index.docbook  


--- branches/KDE/3.5/kdeedu/doc/kgeography/index.docbook #492154:492155
@@ -322,7 +322,7 @@
 <sect1 id="description-file">
 <title>Description file</title>
 <para>
- Its file extension is <literal role="extension">.kgm</literal> and it should begin with <sgmltag class="starttag">map</sgmltag> and end with <sgmltag class="endtag">map</sgmltag>.
+ The description file is needed and its file extension is <literal role="extension">.kgm</literal>. It should begin with <sgmltag class="starttag">map</sgmltag> and end with <sgmltag class="endtag">map</sgmltag>.
 </para>
 <para>
  Inside of those tags there should be:
@@ -348,7 +348,7 @@
   <para><sgmltag class="starttag">capital</sgmltag> and <sgmltag class="endtag">capital</sgmltag>: the name of the capital of the division, &eg; <quote>Tirana</quote>.</para>
 </listitem>
 <listitem>
-  <para><sgmltag class="starttag">ignore</sgmltag> and <sgmltag class="endtag">ignore</sgmltag>: must be <userinput>yes</userinput> if the division should be ignored when asking for divisions in that map. If it is <userinput>allowClickMode</userinput> &kgeography; will ask the division in the Click on division mode but not in others. This tag is optional: &eg; <quote>Algeria</quote> has this tag set to <userinput>yes</userinput> in the <quote>Europe</quote> map.</para>
+  <para><sgmltag class="starttag">ignore</sgmltag> and <sgmltag class="endtag">ignore</sgmltag>: can be set to <userinput>yes</userinput>,  <userinput>allowClickMode</userinput> and <userinput>no</userinput>. If this tag is set to <userinput>yes</userinput> then the division will be ignored when asking for divisions in that map. It is then as if this division does not exist in &kgeography; quiz modes. If this tag is set to <userinput>allowClickMode</userinput> then &kgeography; will ask for the division in the <guibutton>Click Division in Map...</guibutton> mode but not in other quiz modes. Setting this tag to <userinput>no</userinput> means the division will appear in all modes (browse and quizzes). This tag is optional and when there is no <sgmltag class="starttag">ignore</sgmltag> tag that means as it is set to <userinput>no</userinput>. For example <quote>Algeria</quote> has this tag set to <userinput>yes</userinput> in the <quote>Europe</quote> map which means that <quo
 te>Algeria</quote> will not be part of any quiz in the <quote>Europe</quote> map.</para>
 </listitem>
 <listitem>
   <para><sgmltag class="starttag">flag</sgmltag> and <sgmltag class="endtag">flag</sgmltag>: the file (without any path) containing the flag of the division, &eg; <quote>albania.png</quote>. This tag is optional. Not needed for the divisions whose <sgmltag class="starttag">ignore</sgmltag> tag is set to <userinput>yes</userinput>.</para>
Comment 2 Anne-Marie Mahfouf 2005-12-29 00:08:12 UTC
I did my best to explain it clearly, I hope you will understand it better!
Comment 3 mkkot 2006-01-05 19:59:06 UTC
Big thanks, now it is really clear and helpful. But you did a little mistake in button's label:
then &kgeography; will ask for the division in the 
<guibutton>Click Division in Map...</guibutton> mode but not in other quiz 
modes.

Real button's name's <guibutton>Click Division in the Map...</guibutton>.


And for make this doc even more clearly, I suggest to change this:
It is then as if this division does not exist in &kgeography; quiz modes.

to:
 It takes place when this division does not match for &kgeography; quiz modes.

I hope, that I understood this sentence correctly. Sorry for any mistakes in proposals, I'm not native English speaker.
Comment 4 Anne-Marie Mahfouf 2006-01-05 21:08:09 UTC
Not sure if I can fix it further right now, anyone can advise me from kde-doc-english? 

All your suggestions are good by the way, thank you for your report and for following it up!