DITA Metrics Definitions

Return to DITA Metrics Help Main Page Return to DITA Metrics Basic Help Main Page

DITA Metrics Definitions

  • Words
    • Published Words:
      All Words in DITA files that appear in published output. If Topic "A" contains 100 words and appears 25 times in published documents, it is counted as 2,500 words.
    • Words Counted Once:
      All words in DITA files that appear in the output, but only counted once. If Topic "A" contains 100 words and appears 25 times in published documents, it is counted as 100 words.

      PLEASE NOTE: If content is copied from one DITA file to another, that is two DITA files have identical content, that content will be counted twice. The Samalander Metrics module only deals with references to files and elements within files. It does not evaluate content in any way except to count the words in the file or element.

    • Referenced Words:
      All words in DITA files that are referenced in the published output. If Topic "A" contains 100 words and appears 25 times in published documents, it is counted as 2,500 words. PLEASE NOTE: see Referenced Clarification for more information.
    • Words Referenced Percentage:
      Defined as: Referenced-Words/Published-Words.
    • Words Reuse Percentage:
      Defined as: (1 - (Words-Counted-Once/Published-Words)*100).
  • Elements
    • Topics
      • Published Topics:
        All Topics in DITA files that appear in published output.
      • Topics Counted Once:
        All topics in DITA files that appear in the output, but only counted once. If Topic "A" contains 100 topics and appears 25 times in published documents, it is counted as 100 topics.
      • Referenced Topics:
        All topics in DITA files that are referenced in the published output.
      • Topics Referenced Percentage:
        Defined as: Referenced-Topics/Published-Topics.
      • Topics Reuse Percentage:
        Defined as: (1 - (Topics-Counted-Once/Published-Topics)*100)
    • Bodies
      • Published Bodies:
        All Bodies in DITA files that appear in published output.
      • Bodies Counted Once:
        All bodies in DITA files that appear in the output, but only counted once. If Topic "A" contains 100 bodies and appears 25 times in published documents, it is counted as 100 bodies.)
      • Referenced Bodies:
        All bodies in DITA files that are referenced in the published output)
      • Bodies Referenced Percentage:
        Defined as: "Referenced Bodies/Published Bodies"
      • Bodies Reuse Percentage:
        Defined as: "(1 - (Bodies Counted Once/Published Bodies)*100)"
    • Tasks
      • Published Tasks:
        All Tasks in DITA files that appear in published output.
      • Tasks Counted Once:
        All tasks in DITA files that appear in the output, but only counted once. If Topic "A" contains 100 tasks and appears 25 times in published documents, it is counted as 100 tasks.
      • Referenced Tasks:
        All tasks in DITA files that are referenced in the published output.
      • Tasks Referenced Percentage:
        Defined as: Referenced Tasks/Published Tasks.
      • Tasks Reuse Percentage:
        Defined as: (1 - (Tasks Counted Once/Published Tasks)*100).
  • Total referenced elements percentage:
    Defined as: Sum of referenced Topics and Tasks and Bodies / Sum of published Topics and Tasks and Bodies.
  • Total reused elements percentage
    Defined as (1 - (sum of topics, tasks, bodies, counted once) / (sum of published topics, tasks, bodies)) * 100.

Return to DITA Metrics Help Main Page Return to DITA Metrics Basic Help Main Page