Home >  DocBook Sanitizer >  kde-4.x >  kdeutils >  printer-applet

Other kdeutils/printer-applet reports: [API Documentation] [Krazy Code Checker]

Results for printer-applet

...as of March 16 2010 01:09:17 (SVN revision 1103823)

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... OOPS! 1 issue found!
   The markup does not seem to use the &underFDL; entity. This is required for all KDE documentation files in order to include the Free Documentation License text.

   People who spent time on translating your document should be given credit appropriately. To do this, you need to specify two special comments in your markup:
   
   <!-- TRANS:ROLES_OF_TRANSLATORS -->
   This special comment must appear exactly once in your markup; you should put it at the end of your <authorgroup> element.
   
   <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
   There must only be one DocBook file in the directory which has this marker. It needs to be placed at the end of your document, right before the &underFDL; entity.

5. Verifying that preferred words of phrases were used... okay!
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 33:

     -<para>It is a &kde; port of system-config-printer's applet.py by Tim Waugh from Red Hat.</para>
     +<para>It is a &kde; port of system-config-printer's applet.py by Tim Waugh from &RedHat;.</para>
     

   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!