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

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

Results for ark

...as of September 02 2010 22:25:44 (SVN revision 1171128)

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... okay!
6. Testing for applicable entities... OOPS! 4 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 251:

     -<listitem><para>Raphael Kubo da Costa
     -<email>kubito@gmail.com</email></para></listitem>
     -<listitem><para>Harald Hvaal
     -<email>haraldhv@stud.ntnu.no</email></para></listitem>
     +<listitem><para>&Raphael.Kubo.da.Costa;
     +&Raphael.Kubo.da.Costa.mail;</para></listitem>
     +<listitem><para>&Harald.Hvaal;
     +&Harald.Hvaal.mail;</para></listitem>
     

   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!