English Breakfast Network

Almost, but not quite, entirely unlike tea.

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/otherdoc.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-files.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 1 issue found!
    • In line 16: Prefer 'email' over 'e-mail'.

      ..<para>If it does, you can now report the problem to the developer's list, and mention that you have anonymous file that reproduces the problem. When requested, send the anonymous file via private e-mail to whichever developer requests it.</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.

  7. Testing for applicable entities... OOPS! 2 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 9:
      -<para>The .KMY file is a gzipped XML file.  If you wish to learn about the structure of the file, you can gunzip it and load it in your favorite text editor.</para>
      +<para>The .KMY file is a gzipped &XML; file.  If you wish to learn about the structure of the file, you can gunzip it and load it in your favorite text editor.</para>
      
    • Entity could be used in line 14:
      -	<para>To save a copy of your file in this way, open the File menu from the application menu bar, and choose &quot;Save as...&quot;.  For the file type, choose &quot;Anonymous (.ANON.XML)&quot;.  This will save off a copy of your data in anoymous form.</para>
      +	<para>To save a copy of your file in this way, open the File menu from the application menu bar, and choose &quot;Save as...&quot;.  For the file type, choose &quot;Anonymous (.ANON.&XML;)&quot;.  This will save off a copy of your data in anoymous form.</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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/views-reports.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 3.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-accounts.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 4 issues found!
    • In line 73: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..As with the personal information dialog, this data is not currently used by &kappname; but will be required by future releases for certain features. Once you have entered the name click on <guibutton>OK</guibutton> to select the institution or click on <guibutton>Cancel</guibutton> to not use an institution for this account. To select an existing institution simply click on the institution drop down list...

    • In line 143: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..To make this account your primary account check the tickbox labelled <guilabel>Preferred account</guilabel> This account will then be used by default within &kappname; for your convenience...

    • In line 205: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If this is not a Credit Card account then all required information has been gathered and you can add the account to &kappname; by clicking on the <guibutton>Finish</guibutton> button. If you do not wish to add the account click on <guibutton>Cancel</guibutton>...

    • In line 244: Prefer 'drop down box' over 'drop down list'.

      ..To open an account in the Ledgers view you can either click on the link to the account from the Home view, or click on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="ledgers_view.png"/></imageobject></inlinemediaobject>Ledgers</guiicon> icon in the view selector and select the account in the drop down list at the top of the view...

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-schedules.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 8 issues found!
    • In line 43: Prefer '&ie;' over 'ie.'. (Use the entity!)

      ..The schedule consists of two main parts; the scheduling data and the transaction itself. The scheduling data records the occurrence of the schedule, ie. when the transaction is to be entered into the ledger and how. The transaction data records normal transaction information and will be entered in to the ledger as-is...

    • In line 157: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<title>Letting &kappname; enter the transaction into the register</title>..

    • In line 159: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..To let &kappname; enter the transaction for you when needed make sure that the check box labelled <guilabel>Enter this into the ledger automatically</guilabel> is checked otherwise when the transaction is due to be entered, &kappname; will open a dialog box asking you to confirm that you want it to be entered. This behavior is configurable and more information can be found in the Settings section...

    • In line 164: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<title>Letting &kappname; know when the schedule will finish</title>..

    • In line 323: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<title>Letting &kappname; enter the schedule(s) for you</title>..

    • In line 325: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Alternatively &kappname; can check which schedules are due upon startup and enter them for you if the appropriate option was checked when setting up the schedule...

    • In line 329: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If the option was not checked then &kappname; will open the previously mentioned dialog and you can follow the steps mentioned there. &kappname; will also open the dialog if the amount is an estimate so you can enter the real amount...

    • In line 333: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..You can also opt to have &kappname; not check the schedules on startup by deselecting the option in the Settings dialog and any overdue schedules or schedules due 'today' will be shown in the Home view for you to enter manually...

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-search.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. 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 83:
      -regular expresssion.  For details on how to craft a regular expression, visit the Qt documentation at doc.trolltech.com, and look for the QRegExp class.
      +regular expresssion.  For details on how to craft a regular expression, visit the &Qt; documentation at doc.trolltech.com, and look for the QRegExp class.
      

    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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-categories.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/views-categories.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 3.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/introduction.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 5 issues found!
    • In line 8: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Put simply, &kappname; is a personal finances manager for KDE. It enables users of open source operating systems to keep careful track of their personal finances by providing a broad array of financial features and tools...

    • In line 23: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Based on tried and tested double entry accounting principles &kappname; ensures that your finances are kept in correct order...

    • In line 30: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<title>What &kappname; is not</title>..

    • In line 33: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..As a personal finances manager, &kappname; is not intended to scale to the needs of an average business. It would be possible to create client / supplier / document features through plugins...

    • In line 37: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..&kappname; is not simply a clone of the commercially-available personal finance programs. Although many of the features present in &kappname; can be found in other similar applications, &kappname; strives to present an individual and unique view of your finances...

    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.

  7. 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 8:
      -Put simply, &kappname; is a personal finances manager for KDE.  It enables users of open source operating systems to keep careful track of their personal finances by providing a broad array of financial features and tools.
      +Put simply, &kappname; is a personal finances manager for &kde;.  It enables users of open source operating systems to keep careful track of their personal finances by providing a broad array of financial features and tools.
      

    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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-institutions.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-transactions.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 3.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-loans.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 1 issue found!
    • In line 25: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..A loan is an agreement where a borrower receives money from a lender and agrees to return the money at some future date. &kappname; allows you to track loans with which you borrow money (you are the borrower) or lend money (you are the lender). In personal finance, it always seems that a person always borrows more than he or she lends. This means that you will generally be the borrower and a mortgage company or auto loan company will generally be the lender. In the circumstance where you loan money to a family member or a friend, you can use &kappname; to track this loan as well...

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/views-institutions.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 3.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-reconciliation.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 2 issues found!
    • In line 27: Prefer 'drop down box' over 'drop down list'.

      ..To reconcile an account click on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="reconcile.png"/></imageobject></inlinemediaobject> Reconcile Ledgers</guiicon> icon in the account selector, choose your account from the drop down list and then click on the <guibutton>Reconcile</guibutton> button...

    • In line 94: Prefer '&eg;' over 'e.g.'. (Use the entity!)

      ..The interest field is for interest you gained. If you have to pay interest for e.g. a credit card account, this has to be entered as charge...

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/views-home.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 3.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-database.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 10 issues found!
    • In line 24: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<para>As of release 1.0, &kappname; allows you to hold your data in a relational database. One of the advantages of using this industry-standard format is that it may allow you to view your data using one of the graphic front ends such as OpenOffice.org<trademark class="copyright"/>, perhaps in some format that &kappname; currently doesn't provide. Also, a little knowledge of SQL (Structured Query Language, the language used world-wide to access relational databases) should enable you more easily to extract data to feed into some external program, as for example a budgeting application.</para>..

    • In line 26: Prefer '&ie;' over 'i.e.'. (Use the entity!)

      ..<para>It should be noted that the current release of the program merely treats the database in the same fashion as an ordinary file, in that it reads all the data into memory when opened, and writes updated data back when closed. A more conventional method of database access, i.e. reading and updating data only as required, is planned for a future release.</para>..

    • In line 32: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<para>To access the database, &kappname; uses the SQL module supplied by Trolltech<trademark class="registered"/> as part of their Qt<trademark class="registered"/> programming system. This module supports a number of different database systems through a collection of drivers. Among the more popular open-source systems for which drivers are available are MySQL<trademark class="registered"/>, SQLite and PostgreSQL The module also supports the 'heavier', more industrial, systems such as Oracle<trademark class="registered"/> and IBM DB2<trademark class="registered"/></para>..

    • In line 44: Prefer '&etc;' over 'etc.'. (Use the entity!)

      ..<para>Looking after databases is a little more complex than dealing with regular files. Each system has different methods for performing those necessary administrative tasks such as initial creation, assigning permissions to various users, producing backups etc. Describing these is outside the scope of this manual, but all of the supported products provide comprehensive reference documentation, and a quick search of the web will point you at many tutorials on the subject.</para>..

    • In line 57: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<para>On your first usage, &kappname; will attempt to create the necessary table structures. In order to achieve the maximum compatibility between various database types, only a subset of common data types are used. There may nevertheless be situations where a particular type is not supported, and in this case, provision has been made to generate the SQL code necessary to create tables. This code can then be modified as required and used to create the tables outside of &kappname;. Should you find yourself in this situation, help can usually be obtained from &devlist;.</para>..

    • In line 73: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<para>The default database name is KMyMoney, but you may choose some other name if you like. SQLite has one database per file; selecting this driver opens the file dialog. For database types other than MySQL, the database name must be pre-created, though &kappname; will create all table structures where necessary.</para>..

    • In line 105: Prefer '&eg;' over 'e.g.'. (Use the entity!)

      ..<para>To extract data, e.g. into a spreadsheet or external file, it is almost invariably necessary to select linked data from one or more tables. This is done by 'joining' the tables, using a field which is common to each. You can find a lot more information about how this is done from the online tutorials mentioned above. The following table lists the fields used to define these inter-table relationships.</para>..

    • In line 256: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<para>Having data in an industry standard format does give you the ability to modify it outside the &kappname; application. DON'T DO IT unless you really know what you're doing, and always be certain to make a backup copy of your data first. If you get it wrong, &kappname; may not be able to access your data, and you could even end up losing it altogether. You have been warned!</para>..

    • In line 262: Prefer 'lowercase' over 'lower-case'.

      ..<para>Most database systems allow you to store commonly used queries and procedures, and in some cases, these may be held as tables within your database itself. As you will have guessed from the above, all the tables used by &kappname; begin with the lower-case letters 'kmm'. This standard will be maintained, and only tables beginning with these letters will be updated. Thus provided you avoid these in the naming of your queries etc., you should not experience any problems.</para>..

    • In line 262: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<para>Most database systems allow you to store commonly used queries and procedures, and in some cases, these may be held as tables within your database itself. As you will have guessed from the above, all the tables used by &kappname; begin with the lower-case letters 'kmm'. This standard will be maintained, and only tables beginning with these letters will be updated. Thus provided you avoid these in the naming of your queries etc., you should not experience any problems.</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.

  7. Testing for applicable entities... OOPS! 3 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 32:
      -  <para>To access the database, &kappname; uses the SQL module supplied by Trolltech<trademark class="registered"/> as part of their Qt<trademark class="registered"/> programming system. This module supports a number of different database systems through a collection of drivers. Among the more popular open-source systems for which drivers are available are MySQL<trademark class="registered"/>, SQLite and PostgreSQL The module also supports the 'heavier', more industrial, systems such as Oracle<trademark class="registered"/> and IBM DB2<trademark class="registered"/></para>
      +  <para>To access the database, &kappname; uses the SQL module supplied by Trolltech<trademark class="registered"/> as part of their &Qt;<trademark class="registered"/> programming system. This module supports a number of different database systems through a collection of drivers. Among the more popular open-source systems for which drivers are available are MySQL<trademark class="registered"/>, SQLite and PostgreSQL The module also supports the 'heavier', more industrial, systems such as Oracle<trademark class="registered"/> and IBM DB2<trademark class="registered"/></para>
      
    • Entity could be used in line 38:
      -  <para>In addition to the database software itself, you must also install the corresponding Qt<trademark class="registered"/> driver module. Most distributions will include driver modules for the more popular databases. Otherwise, check with the <ulink url="http://www.trolltech.com">Trolltech web site </ulink> and search for 'SQL drivers'</para>
      +  <para>In addition to the database software itself, you must also install the corresponding &Qt;<trademark class="registered"/> driver module. Most distributions will include driver modules for the more popular databases. Otherwise, check with the <ulink url="http://www.trolltech.com">Trolltech web site </ulink> and search for 'SQL drivers'</para>
      
    • Entity could be used in line 69:
      -This box lists all Qt SQL drivers installed on your system. Select the driver for your database type. If the one you want is not in the list, you need to install the appropriate driver. See your distro documentation, or visit the <ulink url="http://www.trolltech.com/" type="">Trolltech web site</ulink> and search for 'SQL drivers'.
      +This box lists all &Qt; SQL drivers installed on your system. Select the driver for your database type. If the one you want is not in the list, you need to install the appropriate driver. See your distro documentation, or visit the <ulink url="http://www.trolltech.com/" type="">Trolltech web site</ulink> and search for 'SQL drivers'.
      

    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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-widgets.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... OOPS! 1 issue found!

    Just like elements without any content, multiple root elements make it impossible to translate the DocBook file into other languages. You should split a file with multiple root elements up into a bunch of files with one root element each.

  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 6 issues found!
    • In line 5: Prefer '&eg;' over 'eg.'. (Use the entity!)

      ..Whenever &kappname; needs information about a specific date, eg. the posting date of a transaction of the opening date of an account,..

    • In line 5: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Whenever &kappname; needs information about a specific date, eg. the posting date of a transaction of the opening date of an account,..

    • In line 87: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..As long as matching entries exist in the list of payees/payers maintained by &kappname; they will be presented in a box beneath or above..

    • In line 107: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If a name is entered that is not yet known to &kappname; you will be asked if you wants to create a new payee/payer record...

    • In line 116: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..As long as matching entries exist in the list of categories/accounts known to &kappname; they will be presented in a box beneath or above..

    • In line 136: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If a name is entered that is not yet known to &kappname; you will be asked if you wants to create a new category record...

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-ledgers.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 10 issues found!
    • In line 28: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The Ledgers view is where most of the functionality of &kappname; lies...

    • In line 138: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Please note that the actual transaction method is not directly used by &kappname; but is purely for grouping/reporting purposes...

    • In line 152: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Enter the required information using the following notes on the available fields. Note that many fields have 'Auto Completion' turned on. That is the field will try and finish your input for you. If you start typing &kappname; will offer alternatives matching the characters you have entered so far. To select an entry click on it using the mouse or keyboard, or if your entry is not listed keep typing to add the new value. The next time you type the value in, &kappname; will find it for you after the first few characters have been input...

    • In line 158: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The Payee is who the money came from/to. If the payee is a new entry &kappname; will ask if you wish to add this to the Payees view. Any other information related to a payee, such as the address details can be updated in this view later...

    • In line 165: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The Category lets you associate this transaction with another account for accounting purposes and to let you create reports and or group certain transactions. Type the name of the category into the required field. If you have entered the category and it does not exist then &kappname; will prompt you to create a new one...

    • In line 168: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If this transaction is a multipart transaction, i.e you wish to associate the transaction with more than one category, &kappname; can let you do that. An example transaction might be a cash machine withdrawal of 50 that you use 10 on food, 20 on beer and 20 as spare cash. The transaction will therefore be assigned three categories, Food, Beer and Cash. To assign these categories to the transaction click on the <guibutton>Split</guibutton> button. This brings up the <link linkend="details.ledgers.split">Split Editor</link>. Enter the categories, creating any new ones as needed, and input the amount per category. Click on <guibutton>OK</guibutton> to save the assignments. Note that the category field in the transaction input form now displays <emphasis>Split transaction</emphasis>..

    • In line 189: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The transaction date can also be entered to specify when the transaction took place. See the special &kappname; fields section for more information on the date input field and it can be used to make entering dates quicker and easier...

    • In line 228: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..To do this you must first let &kappname; know that you don't want to use the transaction from by opening the settings dialog and unchecking the <guilabel>Use transaction form</guilabel> option...

    • In line 232: Prefer 'menubar' over 'menu bar'.

      ..This is performed by selecting <guimenu>Settings</guimenu><guimenuitem>Configure &kappname;</guimenuitem> from the menu bar and selecting the <guiicon><inlinemediaobject><imageobject><imagedata fileref="register.png"></imagedata></imageobject></inlinemediaobject>Register</guiicon> icon from the list on left. The option to uncheck is labelled <guilabel>Show transaction form</guilabel>. When finished click on <guibutton>OK</guibutton> to be ready to directly enter transactions...

    • In line 309: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The solution is to tell &kappname; that the transactions are the same, using the manual matching interface...

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-integrity.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 3.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-investments.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 5 issues found!
    • In line 23: Prefer 'they are' over 'they're'.

      ..Stocks, bonds, and mutual funds are the most common investments, so they're the ones supported most directly...

    • In line 24: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Futures, commodities, options and more complex derivatives are also sometimes used, but &kappname; has no special functionality for them. As long as they behave like a stock or a bond, they can be tracked easily...

    • In line 184: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..You can enter any two of these, and &kappname; will calculate the third...

    • In line 208: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Now that &kappname; supports multiple currencies and investments, you'd probably like to combine the two...

    • In line 329: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<guimenuitem>Update Stock and Currency Prices...</guimenuitem> </menuchoice> menu option to bring up the online price quotes dialog. Press <guibutton>Update All</guibutton> to fetch quotes for all investments and currencies in your &kappname; file...

    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.

  7. Testing for applicable entities... OOPS! 7 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 350:
      -	You should feel comfortable reading HTML, and writing complex regular expressions.
      +	You should feel comfortable reading &HTML;, and writing complex regular expressions.
      
    • Entity could be used in line 364:
      -	The first thing to worry about in an online quote source is the URL.
      +	The first thing to worry about in an online quote source is the &URL;.
      
    • Entity could be used in line 368:
      -	This URL is then fetched, all HTML tags are removed, and that stripped file is then sent to the page parser.
      +	This &URL; is then fetched, all &HTML; tags are removed, and that stripped file is then sent to the page parser.
      
    • Entity could be used in line 371:
      -	Note that the URL can also be a file: URL, which the quote fetcher takes to mean an executable script.
      +	Note that the &URL; can also be a file: &URL;, which the quote fetcher takes to mean an executable script.
      
    • Entity could be used in line 374:
      -	Your URL would be &quot;file:/path/to/getquote.sh %1&quot;.
      +	Your &URL; would be &quot;file:/path/to/getquote.sh %1&quot;.
      

    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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/views-outbox.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 1 issue found!
    • Found empty <para> element in line 4.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-payees.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... okay!
  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-formats.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 13 issues found!
    • In line 19: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..This chapter describes the formats in which &kappname; stores it's data in permanent form on the users disk. In..

    • In line 20: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..general, &kappname; stores it's information in form of an XML document. Depending on the actual format, this..

    • In line 43: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..working of &kappname; is fully understood or instructions from the developers tell you what to do. Don't blame the..

    • In line 53: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..This is the normal format used by &kappname; when you store a file with the extension <literal role="extension">.kmy</literal>..

    • In line 61: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If you want to look at a GZIP compressed file, rename it to a filename ending in <literal role="extension">.gz</literal> (e.g. <filename>myfinances.kmy</filename> into <filename>myfinances.kmy.gz</filename>, then use <command>gunzip</command> to uncompress the file and look at it. You don't have to compress it before loading it into &kappname; the next time, because &kappname; can read the uncompressed data as well. Nevertheless, if you save it thereafter, it will be saved compressed again. Use the <link linkend="details.formats.plain">.xml</link> extension to write it in uncompressed format...

    • In line 68: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Using the GPG-encrpyted file format is a very secure method to store your personal finance data on your disk. When &kappname; has been instructed through the settings dialog to store your data encrypted, it will cipher the data using GPG and the key you provided before actually storing it on disk. When opening an encrypted file, you have to provide the passphrase necessary to open your keyring. The encrypted file itself will be stored in GPG's <emphasis>ASCII armored</emphasis> format...

    • In line 91: Prefer 'email' over 'e-mail'.

      ..On the encryption page of the settings dialog you have a field where you can enter the key-id of the key that should be used for encryption and decryption. You can use either the key-id, the e-mail address associated with this key or any other valid GPG key identification as value for this field. When you enter the key-id, &kappname; will check it's validity and turn on a green LED in the dialog if a key is found...

    • In line 91: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..On the encryption page of the settings dialog you have a field where you can enter the key-id of the key that should be used for encryption and decryption. You can use either the key-id, the e-mail address associated with this key or any other valid GPG key identification as value for this field. When you enter the key-id, &kappname; will check it's validity and turn on a green LED in the dialog if a key is found...

    • In line 101: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<title>The &kappname; recover key</title>..

    • In line 103: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Also on this page of the settings dialog you have the choice to select supplemental encryption with the &kappname; recover key. This option is available to you, if that key is stored in your <application>GPG</application> keyring. Selecting this option will allow you to recover your data even in the case you loose your own private key. This is possible, because the data is not only encrypted for your own key, but also for the &kappname; recover key. This key is only available to selected &kappname; developers (at the time of writing only to the author)...

    • In line 106: Prefer 'email' over 'e-mail'.

      ..Under normal circumstances, you will open/save/close your file as usual. In the abnormal case of loss of your key, you have the chance to contact one of the developers who has access to the &kappname; recover key and request help to recover your data. You may contact the developers via e-mail to the &kappname; developer mailing list at &devlist;...

    • In line 106: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Under normal circumstances, you will open/save/close your file as usual. In the abnormal case of loss of your key, you have the chance to contact one of the developers who has access to the &kappname; recover key and request help to recover your data. You may contact the developers via e-mail to the &kappname; developer mailing list at &devlist;...

    • In line 114: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..This format is not intended to be used for normal data storage. It is supported as a method to supply the &kappname; development team with your file in case of a problem without disclosing any of your financial data. If instructed by the developers use the <guimenuitem>Save as...</guimenuitem> menu item to store your data in anonymous format by selecting <literal role="extension">.anon.xml</literal> as file extension. To verify that your problem still exists, reload this anonymized file and try to duplicate your problem. If it shows, send the file to the developer mailing list at &devlist; for further investigation. If the problem does not show ... well, I don't want to think about this scenario right now...

    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.

  7. Testing for applicable entities... OOPS! 2 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 20:
      -general, &kappname; stores it's information in form of an XML document. Depending on the actual format, this
      -XML document will be written
      +general, &kappname; stores it's information in form of an &XML; document. Depending on the actual format, this
      +&XML; document will be written
      

    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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/details-impexp.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... okay!
  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 27 issues found!
    • In line 28: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The &kappname; GnuCash importer handles direct reading of standard (XML)..

    • In line 34: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<listitem><para>import into an existing &kappname; file</para></listitem>..

    • In line 74: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..It should be noted that &kappname; is..

    • In line 87: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..the account. &kappname; supports 5 main types of account, Asset, Liability,..

    • In line 91: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..all other accounts are held subordinate to one of these. &kappname; enforces..

    • In line 115: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..structure, as a holder for other accounts. Though &kappname; does not..

    • In line 124: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<title>Equivalence of GnuCash and &kappname; account types</title>..

    • In line 184: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..balance (i.e. must balance out to zero). &kappname; encourages, but does not..

    • In line 230: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..(NOTE: &kappname; does not currently support accounts denominated in 'defunct' currencies..

    • In line 241: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..products, in that &kappname; requires any account denominated in a security..

    • In line 277: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..a package called Finance::Quote. &kappname; does not support this at present, and has..

    • In line 372: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..any case should be reported to the &kappname; developer list &devlist;...

    • In line 432: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..To import a QIF file, first ensure you have a valid &kappname; file open. Then select <guimenuitem>Import</guimenuitem> <guimenuitem>Qif</guimenuitem> from the <guimenu>File</guimenu> menu...

    • In line 450: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If you want &kappname; to automatically enter new payees check the appropriate option otherwise &kappname; will prompt you each time a new payee is found...

    • In line 493: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..When &kappname; has finished importing the QIF transactions the account will be shown with the imported transactions listed in Yellow...

    • In line 525: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Please note that if you are importing a file with investment transactions, those investments must first exist in your &kappname; file...

    • In line 526: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The trading symbol is used to match, so please ensure that the symbol in &kappname; is exactly the same as the one in the file you're importing...

    • In line 535: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..This profile tells &kappname; about the peculiarities of your file...

    • In line 611: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..You can still import that file into &kappname; using a QIF Import Filter...

    • In line 643: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<sect2><title>Special &kappname; QIF extensions</title>..

    • In line 689: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..It should be available from whatever source you got the base &kappname; RPM...

    • In line 691: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The &kappname; build process will detect these and compile the plugin...

    • In line 726: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..Please note that if you are importing a file with investment transactions, those investments must first exist in your &kappname; file...

    • In line 727: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..The trading symbol is used to match, so please ensure that the symbol in &kappname; is exactly the same as the one in the file you're importing...

    • In line 738: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..It will then import the downloaded OFX file into the &kappname; file you most recently had open...

    • In line 741: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..If you need to import the OFX file into some other &kappname; file, load up that file in &kappname; first, and then visit your bank...

    • In line 753: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..To enable this, you must compile &kappname; with the --enable-ofxbanking switch...

    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.

  7. 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 28:
      -The &kappname; GnuCash importer handles direct reading of standard (XML)
      +The &kappname; GnuCash importer handles direct reading of standard (&XML;)
      

    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.

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

Running Checks

...on http://kmymoney2.cvs.sourceforge.net/*checkout*/kmymoney2/kmymoney2/doc/en/views-schedules.docbook?rev=HEAD

  1. Checking for well-formed XML... okay!
  2. Checking for proper DOCTYPE declaration... OOPS! 1 issue found!
    Failed to determine DOCTYPE declaration! If you do have a <!DOCTYPE .. declaration in your markup, please drop a note about this false alert to Frerich Raabe about this, together with the markup you gave to the sanitizer.

    Not using the most up to date DOCTYPE declaration for your markup means not being able to use the entities which might be suggested below, when checking for applicable entities.

  3. Testing for empty elements... OOPS! 16 issues found!
    • Found empty <para> element in line 24.
    • Found empty <para> element in line 29.
    • Found empty <para> element in line 34.
    • Found empty <para> element in line 41.
    • Found empty <para> element in line 45.
    • Found empty <para> element in line 49.
    • Found empty <para> element in line 56.
    • Found empty <para> element in line 60.
    • Found empty <para> element in line 65.
    • Found empty <para> element in line 70.
    • Found empty <para> element in line 76.
    • Found empty <para> element in line 80.
    • Found empty <para> element in line 85.
    • Found empty <para> element in line 89.
    • Found empty <para> element in line 94.
    • Found empty <para> element in line 100.

    Elements without any content make it impossible to translate the DocBook file into other languages; in particular, the xml2po program which is used by the KDE translation framework will break. You need to remove those elements, or fill them with some dummy content like "FILL ME WITH CONTENT" or such.

  4. Scanning for multiple root elements... okay!
  5. Looking for proper translator markers... OOPS! 2 issues found!
    TRANS:ROLES_OF_TRANSLATORS not present. It is required, please add it. It should be placed right before </authorgroup>.
    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.

  6. Verifying that preferred words of phrases were used... OOPS! 1 issue found!
    • In line 95: Prefer '' over '&kappname;'. (Use the entity for this application instead)

      ..<sect2 id="views.schedule.autoenter"><title>Letting &kappname; enter the schedules</title>..

    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.

  7. Testing for applicable entities... okay!
  8. Checking for invalid image references... okay!

Running Checks

...on