<?xml version="1.0" encoding="UTF-8"?><div xmlns="http://www.tei-c.org/ns/1.0" xml:id="learn_editionDiagnostics" resp="or:odd_HOUL3_wtm or:odd_JENS1_wtm or:odd_GALL2_pfr" ana="audAnthologyLead audEditor audEncoder">
   
   <head>Edition Diagnostics</head>
   
   <div xml:id="learn_editionDiagnostics_prior">
      <head>Prior Reading</head>
      
      <list rend="bulleted">
         <item><ptr target="doc:learn_generalDiagnostics"/></item>
      </list>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_rationale">
      <head>Rationale</head>
      
      <p>LEMDO has set up a number of diagnostic checks for your edition that you will find useful as you prepare your edition. These diagnostics provide statistics about characters, entrances and exits, and spoken lines. Diagnostics also help you to encode links correctly to anchors from your collation and annotations. For that reason, we recommend that editors regularly check their edition diagnostics. This documentation will guide you through the process of checking your edition diagnostics and clearing any potential errors therein.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_practice">
      <head>Practice: Run Edition Diagnostics</head>
      
      <p>To run edition diagnostics, first open the file for your modernized text. In the tool bar at the top of your Oxygen window, click the red play button:
         <figure>
            <graphic url="img:run_transformation.png" mimeType="image/png" width="34px" height="29px">
               <desc resp="pers:HOUL3">Oxygen play button</desc>
            </graphic>
         </figure>
      </p>
      
      <p>It typically takes some time to run the diagnostics. Once they are complete, a new tab will automatically open in your default Web browser with an HTML page listing diagnostics. At the top of the Web page will be the date that the diagnostics were generated and the ID for your edition. Each set of diagnostics and statistics is available through a drop-down on the HTML page.</p>
      
      <p>Note that diagnostics that have no potential issues will have the number zero (0) beside them, while those diagnostics that do find potential issues will give the number of issues you need to resolve.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_stats">
      <head>Edition Statistics</head>
      
      <p>The first drop-down on your edition diagnostics page is for statistics. This section includes counts for number of acts, scenes, speeches, stage directions, and speaking characters in your edition. In addition, the length of your modernized text is given in both characters and words. Finally, you can see the total number of elements and attributes that you and the LEMDO team have added to your file.</p>
      
      <p>The statistics section also offers statistics by character. In this table, each character in your edition is listed along with the number of speeches they give, number of words that they speak, their average speech length, the average length of words that they speak, the number distinct words that they use, and how many of their total words are distinct (given as a decimal between 0.0 and 1.0 with 1.0 meaning each word spoken is distinct). This information may be helpful to you when you write your critical introduction.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_unusedAnchors">
      <head>Unused Anchors Diagnostic</head>
      
      <p>LEMDO uses anchors and pointers to link annotations and collations to modernized texts. All <gi>anchor</gi> elements should be linked to from somewhere in your edition. This diagnostic finds <gi>anchor</gi> elements that are not linked to from anywhere within the edition.</p>
      
      <p>To resolve this diagnostic, you will first check that the anchor is not being linked to from another edition by searching the <ident>texts</ident> directory in the LEMDO repo. (Other editions should <emph>not</emph> be linking to anchors in your edition. They should be linking to the acts/scenes and speeches in your modern text, speeches or WLNs in your semi-diplomatic text, and <gi>div</gi>s or paragraphs in your critical paratexts.) Follow these steps to check that no other edition is linking to your anchors:
         <list rend="numbered">
            <item>Copy the xml:id of the unused anchor. You can copy this directly from your edition diagnostics.</item>
            <item>Right click on the <ident>texts</ident> directory in Oxygen’s project pane.</item>
            <item>Select <quote>Find/Replace in Files…</quote></item>
            <item>Paste the xml:id in the <quote>Text to find</quote> text box.</item>
            <item>Click <quote>Find All</quote>.</item>
         </list>
         If there are no files linking to the anchor (as is likely the case, given LEMDO’s general diagnostic that looks for such links), only one result will come up (the anchor itself). In those cases, you may delete the unused anchor. If there is another edition linking to the anchor, leave the anchor in place but let the LEMDO team know that someone is linking to your edition so that we can help the other editor link in the LEMDO-allowed ways.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_ptrsNotPointing">
      <head>Pointers not Pointing at Anything Diagnostic</head>
      
      <p>All pointers must link to an entity with an xml:id. This diagnostic finds <gi>ptr</gi> elements that are trying to link to non-existent xml:ids. If a file is committed with a pointer not pointing at anything, the LEMDO build will break. Checking this diagnostic <emph>before</emph> you commit files containing new <gi>ptr</gi> elements prevents the build breaking on this issue.</p>
      
      <p>To resolve this diagnostic, search your edition for the pointer that is not pointing at anything and correct the value of its <att>target</att> attribute so that it correctly links to an entity. These errors are almost always typos (<q>3411</q> when you mean <q>341</q>.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_ptrsWrongOrder">
      <head>Annotations and Collations Whose Pointers Are in the Wrong Order Diagnostic</head>
      
      <p>When annotations and collation link to anchors in a modernized text, the first target must link to the <gi>anchor</gi> element that comes first in the modernized text while the second target must link to the <gi>anchor</gi> that comes second. If the anchors are invoked in the wrong order, our processor will not be able to mark the span and the LEMDO build will break. Checking this diagnostic before you commit your annotations or collation file prevents the build breaking on this issue.</p>
      
      <p>To resolve this diagnostic, search for the annotation or collation entry that links to anchors in the wrong order and correct the order. Run your edition diagnostics again to ensure that the issue is fixed.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_inconsistentFacs">
      <head>facs Attributes that do not Follow a Consistent Expected Pattern Diagnostic</head>
      
      <p>LEMDO allows you to make links from <gi>pb</gi> (page beginning) elements to facsimile images using the <att>facs</att> attribute. Because all facsimile images are associated with xml:ids that are consecutively numbered and we link to facsimile images for all pages in semi-diplomatic transcriptions (including blank pages), we expect the links to follow the pattern of consecutively numbered xml:ids. This diagnostic finds any inconsistencies in the expected pattern.</p>
      
      <p>To resolve this diagnostic, check that your <att>facs</att> links are correct. See <ptr target="doc:learn_MS_linkFacsimiles"/> for more information.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_missingSpeaker">
      <head>Missing <gi>speaker</gi> Elements Diagnostic</head>
      
      <p>All speeches in modernized texts should have speech prefixes encoded using the <gi>speaker</gi> element. This diagnostic finds <gi>sp</gi> elements (speeches) without a child <gi>speaker</gi> element. If you have a compelling reason not to give a speech prefix to a speech, take up the matter with your anthology lead(s), who will in turn take the matter to the LEMDO team.</p>
      
      <p>To resolve this diagnostic, open your modernized text file and add <gi>speaker</gi> elements to speeches that do not yet have them. For more information on speech prefixes in modernized texts, see <ptr target="doc:learn_encodeSpeaker"/>.</p>
      
      <p>Note that not all speeches in semi-diplomatic transcriptions will have speech prefixes. See <ptr target="doc:learn_semiDipSpeaker"/> and <ptr target="doc:learn_speechesWithoutSpeakers"/> for our encoding practice in semi-diplomatic transcriptions.</p>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_entrancesExits">
      <head>Entrances and Exits</head>
      
      <p>LEMDO lists all of the entrances and exits encoded in each scene of your modernized texts in the <soCalled>entrances and exits</soCalled> section of the edition diagnostics page. This information is often helpful to editors determining scene divisions. It is also useful information if you want to create a doubling chart.</p>
      
      <p>If the list seems to be missing an entrance or exit, check that your encoding is correct. All entrances and exits should be encoded using the <gi>stage</gi> element. For entrances, ensure that the <att>type</att> attribute on the <gi>stage</gi> element has the <val>entrance</val> value on it. For exits, ensure that the <att>type</att> attribute has the <val>exit</val> value on it.</p>
      
      <p>For more detailed information on encoding stage directions in modernized texts, see <ptr target="doc:learn_encodeStageDirections"/> and <ptr target="doc:learn_stageType"/>. For information on encoding stage directions in semi-diplomatic transcriptions, see <ptr target="doc:learn_encode_OSstage"/>.</p>
   </div>
   
  <!-- <!-\- HOUL3 to JENS1: I'm not sure how to work this last diagnostic. Please add missing content about it. -\-><!-\- JENS1 to HOUL3: I cannot get the Diagnostics to run on any file. Will leave this div commented out until I understand it. -\->
   <div xml:id="learn_editionDiagnostics_CSS">
      <head>Results of Validating the CSS in the Target Document</head>
      
      
   </div>-->
   
   
   <div xml:id="learn_editionDiagnostics_otherResources">
      <head>Other Resources</head>
      
      <list rend="bulleted">
         <item>LEMDO YouTube video: <ref target="https://youtu.be/q2lNpVGf50k">Putting It All Together (Editorial)</ref></item>
      </list>
   </div>
   
   
   <div xml:id="learn_editionDiagnostics_further">
      <head>Further Reading</head>
      
      <list rend="bulleted">
         <item><ptr target="doc:learn_checkLinks"/></item>
      </list>
   </div>
</div>