Home >  DocBook Sanitizer >  kde-4.x >  kdeutils >  okteta

Other kdeutils/okteta reports: [API Documentation] [Krazy Code Checker]

Results for okteta

...as of March 15 2010 01:08:23 (SVN revision 1103397)

1. Checking for well-formed XML... okay!
2. Checking for proper DOCTYPE declaration... okay!
3. Scanning for multiple root elements... okay!
4. Looking for proper translator markers... okay!
5. Verifying that preferred words of phrases were used... OOPS! 6 issues found!
   
   • In line 123: Prefer 'navigation panels' over 'sidebars'.

     ..a menu bar, a toolbar, a status bar, one or several sidebars with tools, and..

   • In line 172: Prefer 'navigation panels' over 'sidebars'.

     ..which docks either in one of the sidebars or freely floats as a window. You..

   • In line 174: Prefer 'titlebar' over 'title bar'.

     ..pressing the &LMB; on the title bar of a tool view, moving it as you like and..

   • In line 308: Prefer 'folder' over 'directory'. (Only use 'directory' for CLI)

     ..of the user's directory for program data (find that by executing..

   • In line 310: Prefer 'folder' over 'directory'. (Only use 'directory' for CLI)

     ..You may need to create this directory if there are not any structure..

   • In line 315: Prefer 'folder' over 'directory'. (Only use 'directory' for CLI)

     ..<para>E.g. with the program data directory <filename class="directory">.kde</filename>..

   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.

6. Testing for applicable entities... OOPS! 1 issue 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 1109:

     -<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.

7. Checking for invalid image references... okay!