Bug 120268

Summary: Typos and oopsies in Kugar docs
Product: [Websites] docs.kde.org Reporter: Natalie <nat>
Component: CorrectionsAssignee: Documentation Editorial Team <kde-doc-english>
Status: RESOLVED NOT A BUG    
Severity: normal CC: dhillonv10
Priority: NOR    
Version: unspecified   
Target Milestone: ---   
Platform: Ubuntu   
OS: Linux   
Latest Commit: Version Fixed In:
Sentry Crash Report:

Description Natalie 2006-01-16 22:02:31 UTC
Version:            (using KDE KDE 3.5.0)
Installed from:    Ubuntu Packages
OS:                Linux

kugar.po

index.docbook:82

  - It includes &GUI; report template designer, report engine, 
  &konqueror; part for easy report preview and 

  - It includes a &GUI; report template designer, a report engine, 
  a &konqueror; part for easy report preview and 



index.docbook:86

  - The &kugar; Report Designer is a report template creation tool 
  for &kugar; report engine.

  - Shouldn't this be: The &kugar: Report Template Designer 
  or &kudesigner; ?

  - for the &kugar; report engine.


  - &kugar; report engine uses
  
  - The &kugar; report engine uses


  - and data file
  
  - and a data file



index.docbook:94

  - an overview of template's <acronym>DTD</acronym> 

  - an overview of the template's <acronym>DTD</acronym> 


  - for step-by-step explanation

  - for a step-by-step explanation



kugar_dataref.po

dataref.docbook:49

  - with value corresponding to detail level in the template.

  - with a value corresponding to the detail level in the template.


dataref.docbook:49

  - and uses the format as given in the 
  <sgmltag class=\"element\">KugarData</sgmltag> definition.

  - Is this the KugarData DTD?



kugar_designer.po

designer.docbook:30

  - The &kudesigner; allows

  - &kudesigner; allows
  (Compare next string: "&kudesigner; is a")


designer.docbook:30

  - Report page size defines 

  - The report page size
  or <tag>Report page size</tag>?


designer.docbook:62

  - such as report template, report section 

  - such as a report template, a report section 


  - Every time the element is placed

  - Every time an (?) element is placed


  - its Text property value

  - Could this be changed to: The property "Text to display" ?


designer.docbook:106
 
  - report page size

  - the report page size


designer.docbook:124

  - <guimenuitem>Open</guimenuitem>

  - <guimenuitem>Open...</guimenuitem>


designer.docbook:139

  - <action>Open</action> the report template from a list of recently
  opened templates.

  - <action>Display</action> a list of recently opened templates. 
  Select a file to open it.


designer.docbook:154

  - <guimenu>File</guimenu> <guimenuitem>Save As</guimenuitem>

  - <guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem>


designer.docbook:173

  - <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem>

  - <guimenu>File</guimenu> <guimenuitem>Print...</guimenuitem>


designer.docbook:241

  - Detail header will be added to 

  - The Detail header will be added to 


designer.docbook:283

  - Detail footer will be added to 

  - The Detail footer will be added to 



kugar_progguide.po

progguide,docbook:37, 56, 63

  - See <link linkend=\"...">...</link> section

  - See the section <link linkend=\"...">...</link>
  or
  See <link linkend=\"...">...</link>


progguide,docbook:37, 56, 63

  - <link linkend=\"prog-designer-plugin\">Creating &Qt; designer plugin</link>

  - <link linkend=\"prog-designer-plugin\">Creating a &Qt; designer plugin</link>


progguide,docbook:72

  - A &kugar; shell (report viewer) can be used

  - &kugar; shell (report viewer) can be used


progguide,docbook:106

  - <replaceable>template_file.kut</replaceable>
  -d <replaceable>data_file.kud</replaceable>\"</option>)
  </function>

  - <replaceable>template_file.ktf</replaceable>
  -d <replaceable>data_file.kdf</replaceable>\"</option>)
  </function>


progguide,docbook:117

  - &kugar; library includes two widgets for use.

  - The &kugar; library includes two widgets for use.


progguide,docbook:120

  - <classname>KReportViewer</classname> class is designed

  - The <classname>KReportViewer</classname> class is designed


progguide,docbook:125

  - <classname>MReportViewer</classname> class is designed

  - The <classname>MReportViewer</classname> class is designed


progguide,docbook:142

  - The <classname>MReportViewer</classname> (and <classname>
  KReportViewer</classname> too)

  - <classname>MReportViewer</classname> (and <classname>
  KReportViewer</classname> too)


progguide,docbook:176

  - Sets report data from <replaceable>data_file_name</replaceable> file.

  - Does this mean:
   The source for "report data" is the file <replaceable>data_file_name</replaceable>.
   ?

progguide,docbook:184
progguide,docbook:197
progguide,docbook:205

  - Same as previous.


progguide,docbook:184, 205

  - of <classname>QIODevice</classname> class

  - of the <classname>QIODevice</classname> class


progguide,docbook:205

  - For example, to obtain report template from network storage or database

  - For example, to obtain a report template from network storage or from a database


progguide,docbook:231

  - Designer plugin will allow

  - The designer plugin will allow


  - and preview it correctly.

  - Preview the plugin? or the report?


progguide,docbook:267

  - A header file for <classname>KugarWidgetPlugin</classname>, 
  <classname>QWidgetPlugin</classname> successor;

  - A header file for the <classname>KugarWidgetPlugin</classname>, 
  <classname>QWidgetPlugin</classname> successor;


progguide,docbook:268

  - A source file for <classname>KugarWidgetPlugin</classname>, 
  <classname>QWidgetPlugin</classname> successor;

  - A source file for the <classname>KugarWidgetPlugin</classname>, 
  <classname>QWidgetPlugin</classname> successor;


progguide,docbook:231

  - Project file for <application>QMake</application> utility.

  - A project file for the <application>QMake</application> utility.



kugar_starting.po

starting.docbook:43

  - <parameter>sample1.kud</parameter> <option>-r
  </option> <parameter>sample1.kut</parameter></userinput>

  - <parameter>sample1.kdf</parameter> <option>-r
  </option> <parameter>sample1.ktf</parameter></userinput>


starting.docbook:53

  - <replaceable>template.kut</replaceable></group>

  - <replaceable>template.ktf</replaceable></group>



kugar_template.po

template.docbook:72

  - before details of given level on the report.

  - before details of a given level on the report.


template.docbook:82

  - The report can have unlimited number of details.

  - The report can have an unlimited number of details.



kugar_template-elements.po

template-elements.docbook:33

  - Section bands

  - What are Section bands?
  Section groups? Section separators?


template-elements.docbook:95 template-elements.docbook:164
template-elements.docbook:234 template-elements.docbook:277

  - If you don't want this,section set this value to

  - If you don't want this section, set this value to


template-elements.docbook:285

  - This is an attribute from a <sgmltag class=\"attribute\">row</sgmltag> 
  element in a data file.

  - This is an attribute of a <sgmltag class=\"attribute\">row</sgmltag> 
  element in a data file.


template-elements.docbook:789 template-elements.docbook:1370

  - This is an attribute from <sgmltag 
  class=\"attribute\">row</sgmltag> element in a data file.

  - This is an attribute of a <sgmltag 
  class=\"attribute\">row</sgmltag> element in a data file.


template-elements.docbook:1169 template-elements.docbook:1747
template-elements.docbook:2262

  - If data type other than date, set to <sgmltag 
  class=\"attvalue\">0</sgmltag>.

  - If the data type is other than date, set this to <sgmltag 
  class=\"attvalue\">0</sgmltag>.



template-elements.docbook:1242 template-elements.docbook:1820
template-elements.docbook:2335

  - If data type other than a numeric type, set to 0.

  - If the data type is other than a numeric type, set this to 0.


template-elements.docbook:1252

  - Sets the field's currency symbol If data type other than currency, 
  set to 

  - Sets the field's currency symbol. If the data type is other than 
  currency, set this to 


template-elements.docbook:1274 template-elements.docbook:1852

  - If data type other than a numeric type, set to 

  - If the data type is other than a numeric type, set this to 



kugar_tutorial.po

tutorial.docbook:35

  - <filename>sample1.kut</filename> and <filename>sample1.kud</filename>

  - <filename>sample1.ktf</filename> and <filename>sample1.kdf</filename>


tutorial.docbook:75

  - Empty Report dialog

  - Empty Report window

tutorial.docbook:81

  - Report headers and footers are printed at first, and the 
  last pages of the report

  - Report headers and footers are printed on the first page 
  and on the last page of the report


  - If data structure is more complex or it is organized

  - If the data structure is more complex or if it is organized


  - See <filename>sample3.kut</filename> and <filename>sample3.kud</filename> 

  - See <filename>sample3.ktf</filename> and <filename>sample3.kdf</filename> 


tutorial.docbook:97

  - Now add report header and footer, page header and 
  footer and then detail. When adding detail section,

  - Now add a report header and footer, a page header and 
  footer and then a detail. When adding a detail section,


tutorial.docbook:108

  - Setting detail level

  - Setting the detail level


tutorial.docbook:128

  - To do this &RMB; on the Report Header section or click
  <guilabel>Edit Properties</guilabel> button

  - To do this &RMB; click on the Report Header section or click
  the <guilabel>Edit Properties</guilabel> button


  - Properties window should be shown.

  - The Properties window should be shown.


tutorial.docbook:145

  - Now set a Report Header's height to 70.

  - Now set the Report Header's height to 70.


  - Set Page Header's height to 45 and Detail's to 30. Page and 
  Report Footers should be 32 mm in height.

  - Set the Page Header's height to 45 and the Detail's height to 30.
  The Page and Report Footers should be 32 mm in height.


tutorial.docbook:166

  - Label text and background colors,

  - The Label's foreground and background colors,


  - <link linkend=\"field-element\">Field</link> can be placed 

  - A <link linkend=\"field-element\">Field</link> can be placed 
  or
  <link linkend=\"field-element\">Fields</link> can be placed 


  - General report appearance

  - The general report appearance


tutorial.docbook:190

  - Note, that the

  - Note that the


tutorial.docbook:197

  - Also add field elements to the detail section.

  - We will also add field elements to the detail section.


  - Note, that

  - Note that


  - to <quote>[<userinput>field_name</userinput>]</quote>

  - to <quote>[<userinput>field_name</userinput>]</quote>.


tutorial.docbook:204

  - Special with Type=0

  - A special with Type=0


tutorial.docbook:211

  - The last element to be placed is <guilabel>Calculated Field</guilabel> 
  for <quote>copies</quote> field.

  - The last element to be placed is a <guilabel>Calculated Field</guilabel> 
  for the <quote>copies</quote> field.


  - To acquire a sum(copies) set calculated field's 

  - To acquire a sum (copies) set the calculated field's 


tutorial.docbook:238

  - in file <filename>sample1.kud</filename>

  - in the file <filename>sample1.kdf</filename>


tutorial.docbook:246

  - &lt;KugarData Template=\"sample1.kut\"&gt;\n

  - &lt;KugarData Template=\"sample1.ktf\"&gt;\n


tutorial.docbook:251

  - Generating report

  - Generating the report


tutorial.docbook:253

  - (<filename>sample1.kut</filename>) and a report data file
  (<filename>sample1.kud</filename>)

  - (<filename>sample1.ktf</filename>) and a report data file
  (<filename>sample1.kdf</filename>)


tutorial.docbook:257

  - <replaceable>sample1.kut</replaceable></option> <option>
  -d <replaceable>sample1.kud</replaceable>

  - <replaceable>sample1.ktf</replaceable></option> <option>
  -d <replaceable>sample1.kdf</replaceable>
Comment 1 Raphael Langerhorst 2006-02-11 20:15:37 UTC
SVN commit 508443 by raphael:

CCBUG: 120268
CCMAIL: kde-i18n-doc@kde.org

Fix parts of this bug (up to designer.docbook),
to be continued soon.


 M  +1 -1      dataref.docbook  
 M  +9 -9      index.docbook  


--- trunk/koffice/doc/kugar/dataref.docbook #508442:508443
@@ -62,7 +62,7 @@
 The <sgmltag class="element">KugarData</sgmltag> element contains zero
 or more <sgmltag class="element">Row</sgmltag> elements.  A <sgmltag
 class="element">Row</sgmltag> must contain one <sgmltag class="attribute">level</sgmltag>
-attribute with value corresponding to detail level in the template. Other attributes
+attribute with a value corresponding to detail level in the template. Other attributes
 represent data columns.
 </para>
 <para>
--- trunk/koffice/doc/kugar/index.docbook #508442:508443
@@ -79,23 +79,23 @@
 <chapter id="introduction">
 <title>Introduction</title>
 
-<para> &kugar; is a report creation tool for &Qt; and &kde;. It
-includes &GUI; report template designer, report engine, &konqueror; part
-for easy report preview and a set of examples.  </para>
+<para> &kugar; is a report creation tool for &Qt; and &kde;. It includes
+a &GUI; report template designer, a report engine, a &konqueror; part
+for easy report preview and a set of examples.</para>
 
-<para> The &kugar; Report Designer is a report template creation tool
-for &kugar; report engine.  &kugar; report engine uses an &XML; based
-report template file (which can be created by hand or with
-&kudesigner;) and data file (also in &XML; format) to create
+<para> The &kudesigner; is a report template creation tool
+for the &kugar; report engine. The &kugar; report engine uses an &XML;
+based report template file (which can be created by hand or with
+&kudesigner;) and a data file (also in &XML; format) to create
 reports. To get more information on &kudesigner; refer to the <link
 linkend="designer-manual">Report Template Designer Manual</link>.
 </para>
 
 <para> See <link linkend="template-dtd"> The KugarTemplate Document
-Type Definition</link> for an overview of template's
+Type Definition</link> for an overview of the template's
 <acronym>DTD</acronym> (file format), <link
 linkend="kugardata-dtd">KugarData Document Type Definition</link> and
-<link linkend="tutorial">Tutorial</link> for step-by-step explanation
+<link linkend="tutorial">Tutorial</link> for a step-by-step explanation
 on how reports can be created.  </para>
 
 <para> Programmers should also refer to the <link
Comment 2 Raphael Langerhorst 2006-02-13 18:25:52 UTC
SVN commit 509079 by raphael:

CCBUG: 120268
CCMAIL: kde-i18n-doc@kde.org

more fixes for the kugar handbook, designer and progguide files done


 M  +14 -13    designer.docbook  
 M  +17 -17    progguide.docbook  
Comment 3 Raphael Langerhorst 2006-02-13 20:35:48 UTC
SVN commit 509138 by raphael:

CCBUG: 120268
CCMAIL: kde-i18n-doc@kde.org

All feedback is now processed, except the following open issues:

dataref.docbook:49

  - and uses the format as given in the 
  <sgmltag class=\"element\">KugarData</sgmltag> definition.

  - Is this the KugarData DTD?

designer.docbook:30

  - Report page size defines 

  - The report page size
  or <tag>Report page size</tag>?

 --- I (raphael) have changed that to <guilabel> for now, is that correct?

designer.docbook:62

  - its Text property value

  - Could this be changed to: The property "Text to display" ?

progguide,docbook:176

  - Sets report data from <replaceable>data_file_name</replaceable> file.

  - Does this mean:
   The source for "report data" is the file
<replaceable>data_file_name</replaceable>.
   ?

progguide,docbook:184
progguide,docbook:197
progguide,docbook:205

  - Same as previous.


template-elements.docbook:33

  - Section bands

  - What are Section bands?
  Section groups? Section separators?

 M  +3 -3      starting.docbook  
 M  +28 -28    template-elements.docbook  
 M  +2 -2      template.docbook  
 M  +33 -33    tutorial.docbook  
Comment 4 Vikram Dhillon 2010-01-17 22:42:24 UTC
Kugar has been removed since koffice2 so its documentation isn't present in the SVN trunk. The user-base still has some docs. from KDE 3.5. I will try and get those up-to-date. Therefore marking this one invalid. Thanks.