Other kdeutils/kgpg reports: [API Documentation] [Krazy Code Checker]
Results for kgpg
...as of September 02 2010 22:26:04 (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! 2 issues found!
-
In line 356:
Prefer 'cannot' over 'can't'.
..<para>First you can choose the key you will use to sign the key. Then you can enter how carefully you checked that she really is the person she pretends to be. This information will be stored together with the signature so it is a guidance for everyone else who might need that signature (more on this below). And then comes the option that would help you if you can't meet Alice in person: <guilabel>Local signature (cannot be exported)</guilabel>. When you activate that option a special version of a signature will be created that can never even by accident leave you keyring.</para>..
-
In line 358:
Prefer 'cannot' over 'can't'.
..<para>But why is it important how carefully you checked Alice's identity? Who should care? There is a different way to solve your problem with the identity of Alice. If you can't visit Alice anytime soon just think of Trent. You know Trent has a keypair, too. And Trent is a globetrotter, being on a different continent at least twice a month. If you are lucky he will fly close to Alice soon. So you will go and meet with Trent to sign keys. Then you will drop Alice a note that Trent will be at her place soon and ask her if she can meet with him too to sign keys. After all this has happened you know that Trent's key can be trusted and Trent knows that Alice's key can be trusted. If you trust Trent that he has carefully checked Alice's identity then you can also trust her key.</para>..
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 356:
Prefer 'cannot' over 'can't'.
- 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 151:
-<para>&kgpg; is integrated in &konqueror; and Dolphin. It means that when you right click on a file, you can choose +<para>&kgpg; is integrated in &konqueror; and &dolphin;. It means that when you right click on a file, you can choose
-
Entity could be used in line 208:
-<title>Encrypting a file from &konqueror; or Dolphin</title> +<title>Encrypting a file from &konqueror; or &dolphin;</title>
-
Entity could be used in line 252:
-which are available in the <link linkend="conf-encryption">KGpg configuration</link>.</para> +which are available in the <link linkend="conf-encryption">&kgpg; configuration</link>.</para>
-
Entity could be used in line 267:
-<title>Decrypting a file from &konqueror; or Dolphin</title> +<title>Decrypting a file from &konqueror; or &dolphin;</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 151:
- Checking for invalid image references... okay!