<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dmodule [
<!NOTATION PNG SYSTEM "PNG" >
<!ENTITY ICN-S1KDNPP-A-000000-A-KHZAE-00001-A-001-01 SYSTEM "ICN-S1KDNPP-A-000000-A-KHZAE-00001-A-001-01.PNG" NDATA PNG>
]>
<dmodule xmlns:dc="http://www.purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.s1000d.org/S1000D_5-0/xml_schema_flat/descript.xsd">
  <identAndStatusSection>
    <dmAddress>
      <dmIdent>
        <dmCode modelIdentCode="S1KDNPP" systemDiffCode="A" systemCode="00" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/>
        <language languageIsoCode="en" countryIsoCode="CA"/>
        <issueInfo issueNumber="000" inWork="11"/>
      </dmIdent>
      <dmAddressItems>
        <issueDate year="2020" month="05" day="05"/>
        <dmTitle>
          <techName>s1kd-tools PythonScript interface for Notepad++</techName>
          <infoName>README</infoName>
        </dmTitle>
      </dmAddressItems>
    </dmAddress>
    <dmStatus issueType="new">
      <security securityClassification="01"/>
      <responsiblePartnerCompany>
        <enterpriseName>khzae.net</enterpriseName>
      </responsiblePartnerCompany>
      <originator>
        <enterpriseName>khzae.net</enterpriseName>
      </originator>
      <applic>
        <displayText>
          <simplePara>All</simplePara>
        </displayText>
      </applic>
      <brexDmRef>
        <dmRef>
          <dmRefIdent>
            <dmCode modelIdentCode="S1000D" systemDiffCode="G" systemCode="04" subSystemCode="1" subSubSystemCode="0" assyCode="0301" disassyCode="00" disassyCodeVariant="A" infoCode="022" infoCodeVariant="A" itemLocationCode="D"/>
          </dmRefIdent>
        </dmRef>
      </brexDmRef>
      <qualityAssurance>
        <unverified/>
      </qualityAssurance>
    </dmStatus>
  </identAndStatusSection>
  <content>
    <refs>
      <externalPubRef xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://notepad-plus-plus.org">
        <externalPubRefIdent>
          <externalPubTitle>Notepad++</externalPubTitle>
        </externalPubRefIdent>
      </externalPubRef>
      <externalPubRef xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://npppythonscript.sourceforge.net">
        <externalPubRefIdent>
          <externalPubTitle>PythonScript</externalPubTitle>
        </externalPubRefIdent>
      </externalPubRef>
      <externalPubRef xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://github.com/kibook/s1kd-tools">
        <externalPubRefIdent>
          <externalPubTitle>s1kd-tools</externalPubTitle>
        </externalPubRefIdent>
      </externalPubRef>
    </refs>
    <description>
      <figure>
        <title>s1kd-tools PythonScript menu</title>
        <graphic infoEntityIdent="ICN-S1KDNPP-A-000000-A-KHZAE-00001-A-001-01"/>
      </figure>
      <levelledPara>
        <title>General</title>
        <para>
          These are a set of scripts for the
          <externalPubRef xlink:href="http://npppythonscript.sourceforge.net">
            <externalPubRefIdent>
              <externalPubTitle>PythonScript</externalPubTitle>
            </externalPubRefIdent>
          </externalPubRef>
          plugin which provide an interface for using the
          <externalPubRef xlink:href="https://github.com/kibook/s1kd-tools">
            <externalPubRefIdent>
              <externalPubTitle>s1kd-tools</externalPubTitle>
            </externalPubRefIdent>
          </externalPubRef>
          within
          <externalPubRef xlink:href="https://notepad-plus-plus.org">
            <externalPubRefIdent>
              <externalPubTitle>Notepad++</externalPubTitle>
            </externalPubRefIdent>
          </externalPubRef>.
        </para>
      </levelledPara>
      <levelledPara>
        <title>Install</title>
        <para>Copy the <verbatimText verbatimStyle="vs02">s1kd-tools</verbatimText> directory to the PythonScript user scripts folder, typically <verbatimText verbatimStyle="vs02">%APPDATA%\Notepad++\plugins\config\PythonScript\scripts</verbatimText>.</para>
      </levelledPara>
      <levelledPara>
        <title>Functions</title>
        <para>
          <randomList>
            <listItem>
              <para>
                <emphasis>Acronyms</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>List acronyms</emphasis>
                    </para>
                    <para>Generate a list of acronyms in the data module.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Markup acronyms from file</emphasis>
                    </para>
                    <para>Markup acronyms using the specified acronym definitions file.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Markup acronyms</emphasis>
                    </para>
                    <para>Markup acronyms using the .acronyms file.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Remove acronym markup</emphasis>
                    </para>
                    <para>Convert acronym markup back to plain text.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
            <listItem>
              <para>
                <emphasis>Applicability</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>Applicability filtering</emphasis>
                    </para>
                    <para>Filter the CSDB object for a given set of conditions.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check all applicability</emphasis>
                    </para>
                    <para>Check the applicability of the CSDB object using all product attribute and condition values, as defined in the ACT and CCT.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check applicability properties</emphasis>
                    </para>
                    <para>Check that the product attributes, conditions, and values used for each are defined in the ACT and CCT.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check nested applicability</emphasis>
                    </para>
                    <para>Check that all product attribute and condition values used in nested applicability annotations are subsets of the values used in their parents.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check product applicability</emphasis>
                    </para>
                    <para>Check that the CSDB object is valid for all product instances defined in the PCT.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check standalone applicability</emphasis>
                    </para>
                    <para>Check the applicability of the CSDB object using only the product attribute and condition values explicitly used within the object.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Generate display text</emphasis>
                    </para>
                    <para>Generate the display text for applicability annotations in the CSDB object.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
            <listItem>
              <para>
                <emphasis>BREX</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>Check against BREX DM</emphasis>
                    </para>
                    <para>Check the CSDB object against a selected BREX data module.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check against default BREX</emphasis>
                    </para>
                    <para>Check the CSDB object against the appropriate S1000D Default BREX.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Check against referenced BREX</emphasis>
                    </para>
                    <para>Check the CSDB object against the BREX data module it references.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
            <listItem>
              <para>
                <emphasis>ICN</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>Add ICN</emphasis>
                    </para>
                    <para>Add the NOTATION and ENTITY declarations for an ICN to the CSDB object.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
            <listItem>
              <para>
                <emphasis>New</emphasis>
              </para>
              <para>Create new types of CSDB objects.</para>
            </listItem>
            <listItem>
              <para>
                <emphasis>References</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>Insert reference</emphasis>
                    </para>
                    <para>Insert a reference to a selected CSDB object.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Synchronize references</emphasis>
                    </para>
                    <para>Generate the References table for a data module.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Text-to-reference</emphasis>
                    </para>
                    <para>Generate the XML for references from the currently selected text. If no text is selected, transform all references in the current CSDB object.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Update references</emphasis>
                    </para>
                    <para>Update the titles of referenced CSDB objects.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
            <listItem>
              <para>
                <emphasis>Transform</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>Add neutral metadata</emphasis>
                    </para>
                    <para>Add IETP neutral metadata to the CSDB object.</para>
                  </listItem>
                  <listItem>
                    <para>
                      <emphasis>Remove neutral metadata</emphasis>
                    </para>
                    <para>Remove IETP neutral metadata from the CSDB object.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
            <listItem>
              <para>
                <emphasis>Validate</emphasis>
              </para>
              <para>
                <randomList>
                  <listItem>
                    <para>
                      <emphasis>Check against schema</emphasis>
                    </para>
                    <para>Validate the CSDB object against its schema.</para>
                  </listItem>
                </randomList>
              </para>
            </listItem>
          </randomList>
        </para>
      </levelledPara>
    </description>
  </content>
</dmodule>