Other kdeutils/okteta reports: [API Documentation] [Krazy Code Checker]
Results for okteta
...as of September 02 2010 22:26:18 (SVN revision 1171128)
- Checking for well-formed XML... okay!
- Checking for proper DOCTYPE declaration... okay!
- Scanning for multiple root elements... okay!
- Looking for proper translator markers... okay!
- Verifying that preferred words of phrases were used...
OOPS! 12 issues found!
-
In line 118:
Prefer 'navigation panels' over 'sidebars'.
..a menu bar, a toolbar, a status bar, one or several sidebars with tools, and..
-
In line 167:
Prefer 'navigation panels' over 'sidebars'.
..which docks either in one of the sidebars or freely floats as a window. You..
-
In line 169:
Prefer 'titlebar' over 'title bar'.
..pressing the &LMB; on the title bar of a tool view, moving it as you like and..
-
In line 313:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..of the user's directory for program data (find that by executing..
-
In line 315:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..You may need to create this directory if there are no structure..
-
In line 321:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..<para>For example, with the program data directory <filename class="directory">.kde</filename>..
-
In line 347:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..would be the directory <filename class="directory">ExampleStructure</filename> with all its contents...
-
In line 393:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..<literal>X-KDE-PluginInfo-Name</literal>. The value of this field must match the name of the directory containing the file as well as the name of the <literal role="extension">.desktop</literal> file. When creating &XML; structure definitions the name of the <literal role="extension">.osd</literal> file must also match the name. </para>..
-
In line 395:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..<para>In this example we would have a directory named <filename>simplestruct</filename>..
-
In line 397:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..the directory would also contain a file named <filename>simplestruct.osd</filename>. Using JavaScript we would have a file named <filename>main.js</filename> instead.</para>..
-
In line 444:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..<para>Now create a directory <filename class="directory">simplestruct</filename>..
-
In line 445:
Prefer 'folder' over 'directory'.
(Only use 'directory' for CLI)
..inside the structure installation directory (see manually installing structure definitions)..
For the sake of consistency (and proper spelling), there is a centralized list of common phrases and how they should be spelt in KDE manuals. This covers cases such as "file system" vs. "filesystem" or "Spell-check" vs. "Spellcheck". It's a matter of professional appearance, and you should really try to make your spelling consistent with that of the other KDE documents.
-
In line 118:
Prefer 'navigation panels' over 'sidebars'.
- Testing for applicable entities...
OOPS! 13 issues found!
Note:It is not guaranteed that the document is still valid after applying these suggestions! If you happen to see a suggestion which would break the document, please send Frerich Raabe a mail about it.
-
Entity could be used in line 302:
- <title>Installing using KNewStuff</title> + <title>Installing using &knewstuff;</title>
-
Entity could be used in line 304:
- KNewStuff support in &okteta;. To install an existing structure open the settings dialog of the + &knewstuff; support in &okteta;. To install an existing structure open the settings dialog of the
-
Entity could be used in line 376:
- X-KDE-PluginInfo-Author=Alex Richardson - X-KDE-PluginInfo-Email=foo.bar@email.org - X-KDE-PluginInfo-Name=simplestruct - X-KDE-PluginInfo-Version=1.0 - X-KDE-PluginInfo-Website=http://www.plugin.org/ - X-KDE-PluginInfo-Category=structure - X-KDE-PluginInfo-License=LGPL - X-KDE-PluginInfo-EnabledByDefault=false + X-&kde;-PluginInfo-Author=&Alex.Richardson; + X-&kde;-PluginInfo-Email=foo.bar@email.org + X-&kde;-PluginInfo-Name=simplestruct + X-&kde;-PluginInfo-Version=1.0 + X-&kde;-PluginInfo-Website=http://www.plugin.org/ + X-&kde;-PluginInfo-Category=structure + X-&kde;-PluginInfo-License=LGPL + X-&kde;-PluginInfo-EnabledByDefault=false
-
Entity could be used in line 528:
- This includes for example the file header for PNG files and the ELF file header. + This includes for example the file header for PNG files and the &ELF; file header.
-
Entity could be used in line 1167:
-<title>Windows Menu</title> +<title>&Windows; Menu</title>
There are a lot of entities available to authors of KDE manuals which make it easy to keep the spelling of applications and abbreviations consistent. Using them makes sure that application names are capitalized and marked up correctly, licensed terms get proper 'trademark' and 'copyright' signs, keys which are labelled differently in different countries (such as the 'Ctrl' key which is labelled 'Strg' on german keyboards) get automatically translated and more. To make a long story short - you don't lose anything when using entities as much as possible, but you gain a lot.
-
Entity could be used in line 302:
- Checking for invalid image references... okay!