Task Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/task/ experience XML in a whole new way | exceptional tools for structured content solutions Mon, 18 Dec 2023 11:21:08 +0000 en-US hourly 1 https://wordpress.org/?v=6.7.1 https://www.stilo.com/wp-content/uploads/2017/03/favicon-150x150.png Task Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/task/ 32 32 p.step.choice() https://www.stilo.com/docs/migrate/task/p-step-choice/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64229 Syntax p.step.choice(number) number nesting level of the choices, usually 2 Purpose The step choice annotation is used to tell Migrate […]

The post p.step.choice() appeared first on Stilo.

]]> Syntax

p.step.choice(number)

number

nesting level of the choices, usually 2

Purpose

The step choice annotation is used to tell Migrate to create a choice element. The nesting level is usually 2, as the nesting level of the step in which the choices are set is generally 1, and you cannot have more than two levels in a set of steps.

This image shows you how to set a simple step choice rule.

Step choice rule

You will get output similar to the following as a result of this rule.

<step>
  <cmd>
    Click <uicontrol>Next</uicontrol> to install QuickTrace. A dialog box
    displays the End User License Agreement (EULA). Read the agreement.
  </cmd>
  <choices>
    <choice>
      <p>
        Click <uicontrol>No</uicontrol> if you cannot accept the agreement.
        The installer exits. Return the product to your distributor for 
        a full refund.
      </p>
    </choice>
    <choice>
      <p>
        Click <uicontrol>Yes</uicontrol> if you accept it. A dialog
        displays the name of the default installation directory,
        C:\Program Files\BirdsEye\QuickTrace.
      </p>
    </choice>
  </choices>
</step>

Step choices are only applicable in task topics; Migrate is able to handle situations where you may assign a step choice to an element in a non-task topic, though, by creating unordered lists in place of the step choices. Here is an example of the output from just such a situation.

<p>
  The minimum recommended hardware requirements for installing and running QuickTrace are:
</p>
<ul>
  <li>200MHz Pentium PC</li>
  <li>system memory:
    <ul>
      <li>- 32MB RAM for Windows 98</li>
      <li>- 64MB RAM for Windows NT or higher.</li>
    </ul>
  </li>
  <li>CD-ROM drive (can be used across a network)</li>
  <li>
    a graphics device with a SCART connector capable of VGA resolution or better (see for
    how to connect the cable to the device)
  </li>
  <li>parallel port</li>
  <li>network card.</li>
</ul>

The post p.step.choice() appeared first on Stilo.

]]> p.step.ordered.command() https://www.stilo.com/docs/migrate/task/p-step-ordered-command/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64231 Syntax p.step.ordered.command(number) number nesting level of the step, can be 1 or 2 Purpose The step.ordered.command() annotation is used to […]

The post p.step.ordered.command() appeared first on Stilo.

]]> Syntax

p.step.ordered.command(number)

number

nesting level of the step, can be 1 or 2

Purpose

The step.ordered.command() annotation is used to make a paragraph into a step. The nesting level can be 1 or 2, as DITA supports two levels of steps. The second level of step annotation is called a substep. Any further levels of nesting are treated as numbered lists.

Migrate will use the assigned DITA schema to determine what DITA output will be generated. It will create a command in an ordered step, if that is allowed. If there is a step open already at the same nesting level, Migrate will create the next step in the list and create a command inside that.

If there is a step open at a higher nesting level, it will open a command in an ordered step nested inside that step, so long as this does not exceed two levels of nesting. If there are already two levels of step open, Migrate will create an ordered list nested inside the second level of step.

If there is a step open at a lower level of nesting, Migrate will close the command in that step and will close the step itself; Migrate will then create a new step at the outer level of nesting and will create a command inside that new step.

If neither a step nor a substep are allowed, Migrate will create a numbered list.

If you are using the annotation p.title.unknown-topic() for your topic titles and you use this annotation in a topic body, this gives Migrate a strong indication of which topic type to create. Please see the topic title annotations for more on the p.title.unknown-topic() annotation.

If you are using DITA 1.3, steps may also appear in a troubleshooting topic in the remedy section of the troubleSolution section. Annotate the steps as usual, and Migrate will open the remedy section. Please see p.cause for more information.

This image shows you how to set both level 1 and level 2 step rules.

Step ordered command rule

You will get output similar to the following as a result of these rules.

<steps>
  <step>
    <cmd>See instructions below.</cmd>
  </step>
  <step>
    <cmd>Install the Hex Coupler Guard as follows:</cmd>
    <substeps>
      <substep>
        <cmd>Spread the inner guard and place it over the coupler.</cmd>
        <info>
          <note type="note">
            NOTE: Do not spread the inner and outer guards more 
            than necessary for guard installation. Over spreading 
            the guards may alter their fit and appearance.
          </note>
        </info>
      </substep>
      <substep>
        <cmd>
          With the inner guard straddling the support bracket, 
          install a cap screw through the hole in the support 
          bracket and guard located closest to the pump. Do not
          tighten the capscrew.
        </cmd>
      </substep>
      <substep>
        <cmd>Spread the outer guard and place it over the inner guard.</cmd>
      </substep>
      <substep>
        <cmd>
          Install the outer guard cap screws by following 
          the step stated below which pertains to your 
          particular pump:
        </cmd>
        <ul>
          <li>
            For pumps with a motor saddle support bracket:
            <p>
              Ensure the outer guard is straddling the support 
              arm, and install but do not tighten the two 
              remaining cap screws.
            </p>
          </li>
          <li>
            For pumps without a motor saddle support bracket:
            <p>
              Insert the spacer washer between the holes 
              located closest to the motor in the outer 
              guard, and install but do not tighten the 
              two remaining cap screws.
            </p>
          </li>
        </ul>
      </substep>
      <substep>
        <cmd>
          Position the outer guard so it is centered on
          the shaft, and so there is less than a 1/4" 
          of shaft exposed.
        </cmd>
      </substep>
      <substep>
        <cmd>Holding the guard in this position, 
             tighten the three cap screws.</cmd>
      </substep>
    </substeps>
  </step>
  <step>
    <cmd>Close the cover.</cmd>
  </step>
</steps>


Supporting Reference Material
The post p.step.ordered.command() appeared first on Stilo.

]]>
					
		
		
			
		
		p.step.result
		https://www.stilo.com/docs/migrate/task/p-step-result/
		
		
		Mon, 15 Mar 2021 00:00:00 +0000
				https://www.stilo.com/?post_type=docs&p=64233

					Syntax p.step.result Purpose The annotation p.step.result gives you information about the expected result of a step. This could indicate a […]


The post p.step.result appeared first on Stilo.

]]>
										Syntax

p.step.result


Purpose


The annotation p.step.result gives you information about the expected result of a step. This could indicate a screen or a progress indicator that appears.


Step results are useful to let the user know they are on track, but should not be used for every step because they quickly become repetitive.


This image shows you how to set a simple step result rule.


Step result rule


You will get output similar to the following as a result of this rule.


<steps>
  <step>
    <cmd>Click Start → Program Files → BirdsEye QuickTrace → Uninstall.</cmd>
    <stepresult>
      <p>
        The InstallShield setup wizard starts and displays 
        a dialog offering three choices.
      </p>
    </stepresult>
  </step>
  <step>
    <cmd>Click Remove.</cmd>
    <stepresult>
      <p>A message box asks you to confirm the 
         deletion of the QuickTrace files.</p>
    </stepresult>
  </step>
  <step>
    <cmd>Click OK.</cmd>
    <stepresult>
      <p>
        The wizard displays a progress dialog as it 
        deletes the files, and then displays the 
        Maintenance Complete dialog when it has 
        finished removing QuickTrace. 
      </p>
    </stepresult>
  </step>
  <step>
    <cmd>Click Finish.</cmd>
    <stepresult>
      <p>The setup wizard exits.</p>
      <p>You have finished removing the QuickTrace 
         software installation.</p>
    </stepresult>
  </step>
</steps>


 


The post p.step.result appeared first on Stilo.

]]>
					
		
		
			
		
		p.step.unordered.command()
		https://www.stilo.com/docs/migrate/task/p-step-unordered-command/
		
		
		Mon, 15 Mar 2021 00:00:00 +0000
				https://www.stilo.com/?post_type=docs&p=64235

					Syntax p.step.unordered.command(number) number nesting level of the step, usually 1 Purpose The step.unordered.command() annotation is used to make a paragraph […]


The post p.step.unordered.command() appeared first on Stilo.

]]>
										Syntax

p.step.unordered.command(number)


number


nesting level of the step, usually 1


Purpose


The step.unordered.command() annotation is used to make a paragraph into a step that is not numbered, but is a bullet point. The nesting level is usually 1, as steps are generally the first level of a set of instructions.


Migrate will use the assigned DITA schema to determine what DITA output will be generated. It will create a command in an unordered step, if that is allowed. If that isn’t allowed, it will then try to create a choice, if that is allowed.


If neither of those are allowed, then Migrate will create an item in a bulleted list. If there is a list item open at a higher nesting level, Migrate will begin a new list nested inside that list item. If there is a list item open at the same nesting level, Migrate will create the next item in that list. If there is a list item open with a lower nesting level, Migrate will close that list, any list item containing that list, and will start a new list item at the outer nesting level.


If you are using DITA 1.3, steps may also appear in a troubleshooting topic in the remedy section of the troubleSolution section. Annotate the steps as usual, and Migrate will open the remedy section. Please see p.cause for more information.


This image shows you how to set an unordered step rule.


Step unordered command rule


You will get output similar to the following as a result of this rule.


<steps-unordered>
  <step>
    <cmd>an interface unit that connects to an Ethernet LAN</cmd>
  </step>
  <step>
    <cmd>a USB cable to connect the interface unit to a trace port</cmd>
  </step>
  <step>
    <cmd>software on CD-ROM that enables an EYE debugger 
         to communicate with the interface unit</cmd>
  </step>
  <step>
    <cmd>
      a serial cable that can be used to configure and operate 
      the QuickTrace unit if Ethernet is not available
    </cmd>
  </step>
  <step>
    <cmd>a power supply for the QuickTrace unit</cmd>
  </step>
  <step>
    <cmd>printed copies of this User Guide and an Installation Guide</cmd>
  </step>
</steps-unordered>


Supporting Reference Material
The post p.step.unordered.command() appeared first on Stilo.

]]>
					
		
		
			
		
		p.property
		https://www.stilo.com/docs/migrate/task/p-property/
		
		
		Mon, 18 Dec 2023 11:21:08 +0000
				https://www.stilo.com/?post_type=docs&p=85636

					Syntax p.property Purpose The p.property annotation is used to tag an element as being a row of a property table. […]


The post p.property appeared first on Stilo.

]]>
										Syntax

p.property


Purpose


The p.property annotation is used to tag an element as being a row of a property table. This annotation allows the grouping of span property elements into a single <property> tag. The content does not need to be contained in a table in the source document.


Example


The following is an example of a time when you might want to use the annotation




 


The following is an example of a rule that will apply the annotation




The following is the DITA XML output for the rule:


<properties>


<prophead>


<proptypehd>Property</proptypehd>


<propvaluehd>Value</propvaluehd>


<propdeschd>Description</propdeschd>


</prophead>


   <property>


<proptype>Input  </proptype>


<propvalue>None  </propvalue>


<propdesc>This function does not take user input.</propdesc>


    </property>


         <property>


<proptype>Output  </proptype>


<propvalue>None  </propvalue>


<propdesc>This function does not produce output.</propdesc>


  </property>


         <property>


<proptype>Arguments  </proptype>


<propvalue>Two  </propvalue>


<propdesc>This function takes two arguments: item and range.</propdesc>


  </property>


</properties>


 


The post p.property appeared first on Stilo.

]]>
					
		
		
			
		
		s.property.description
		https://www.stilo.com/docs/migrate/task/s-property-description/
		
		
		Mon, 18 Dec 2023 11:14:56 +0000
				https://www.stilo.com/?post_type=docs&p=85631

					Syntax s.property.description Purpose The s.property.description annotation is used to tag a span element as being the description of a property. […]


The post s.property.description appeared first on Stilo.

]]>
										Syntax

s.property.description


Purpose


The s.property.description annotation is used to tag a span element as being the description of a property. It will associate the property description with a preceding property type and/or value.


 


The property description acts as the definition of or other information regarding a property’s value.


Example


The following is an example of a time when you might want to use the annotation




 


The following is an example of a rule that will apply the annotation




The following is the DITA XML output for the rule:


<property>


<proptype>Input  </proptype>


<propvalue>None  </propvalue>


 <propdesc>This function does not take user input.</propdesc>


</property>


<property>


<proptype>Output  </proptype>


<propvalue>None  </propvalue>


<propdesc>This function does not produce output.</propdesc>


</property>


<property>


<proptype>Arguments  </proptype>


<propvalue>Two  </propvalue>


<propdesc>This function takes two arguments: item and range.</propdesc>


</property>


 


The post s.property.description appeared first on Stilo.

]]>
					
		
		
			
		
		s.trademark
		https://www.stilo.com/docs/migrate/task/s-trademark/
		
		
		Mon, 18 Dec 2023 11:04:47 +0000
				https://www.stilo.com/?post_type=docs&p=85626

					Syntax s.trademark(tmtype)             tmtype is the type of trademark. This argument is mandatory. It can take the following values: tm […]


The post s.trademark appeared first on Stilo.

]]>
										Syntax

s.trademark(tmtype)


            tmtype is the type of trademark. This argument is mandatory. It can take the following values:


    

  • tm
    • 

  • reg
    • 

  • service
    • 

  • -dita-use-conref-target
    • 



Purpose


The s.trademark annotation is used to tag a span element as being a trademarked word, phrase, slogan, logo, or any other trademarked content. The trademark must be identified in the rule as which type of trademark it is, as described in the previous section.


Example


The following is an example of a time when you might want to use the annotation




 


The following is an example of a rule that will apply the annotation




The following is the DITA XML output for the rule:


<title>Installing the XYZ MegaPro Processor</title>


<conbody>


<p>Before installing your <tm tmtype=”tm”>XYZ MegaPro Processor</tm>, ensure


 


The post s.trademark appeared first on Stilo.

]]>
					
		
		
			
		
		s.xref
		https://www.stilo.com/docs/migrate/task/s-xref/
		
		
		Mon, 18 Dec 2023 11:02:20 +0000
				https://www.stilo.com/?post_type=docs&p=85622

					Syntax s.xref Purpose The s.xref annotation is used to tag a span or paragraph element as being a cross reference […]


The post s.xref appeared first on Stilo.

]]>
										Syntax

s.xref


Purpose


The s.xref annotation is used to tag a span or paragraph element as being a cross reference to another location within a topic. This can refer to something in the same or another topic, or a completely external source.


 


This annotation can be applied on its own. In this scenario, the content tagged will become an xref element with an external scope and the content as the href.


 


This annotation can also be applied in conjunction with the annotation set-attribute(href=\{variable}). In this scenario, the content tagged will become an xref with an external scope, and will assign {variable} as the href.


 


This annotation is not required to be applied to an existing link in the source document. Migrate will automatically apply <xref> tags to any span with an internal or external hyperlink. Applying this annotation to an existing hyperlink will cause an <xref> tag to be nested as a <ph> element inside the automatically generated tags.


Example


The following is an example of a time when you might want to use the annotation




 


The following is an example of a rule that will apply the annotation




The following is the DITA XML output for the rule:


For an element where the href is not specified:


<p>This sentence contains a <xref href=”cross%20reference” scope=”external”>cross reference</xref> to an external document.</p>


 


For an element where the href is applied manually:


<p>This sentence contains a <xref href=”www.stilo.com” scope=”external”>cross reference</xref> to www.stilo.com.</p>


 


The post s.xref appeared first on Stilo.

]]>
					
		
		
			
		
		s.citation
		https://www.stilo.com/docs/migrate/task/s-citation/
		
		
		Mon, 18 Dec 2023 11:00:12 +0000
				https://www.stilo.com/?post_type=docs&p=85618

					Syntax s.citation Purpose The s.citation annotation is used to tag a span element as being a cited source supporting a […]


The post s.citation appeared first on Stilo.

]]>
										Syntax

s.citation


Purpose


The s.citation annotation is used to tag a span element as being a cited source supporting a statement or providing reference to a quotation.


Example


The following is an example of a time when you might want to use the annotation




 


The following is an example of a rule that will apply the annotation




The following is the DITA XML output for the rule:


<title>Quote Example</title>


<conbody>


<p>This sentence contains a quote: <q>this is the quote</q> (<cite>Author, 2023</cite>).</p>


 


The post s.citation appeared first on Stilo.

]]>
					
		
		
			
		
		p.ui.screen
		https://www.stilo.com/docs/migrate/task/p-ui-screen/
		
		
		Mon, 18 Dec 2023 10:57:36 +0000
				https://www.stilo.com/?post_type=docs&p=85612

					Syntax p.ui.screen Purpose The p.ui.screen annotation is used to tag an element as being a representation of a text-based user […]


The post p.ui.screen appeared first on Stilo.

]]>
										Syntax

p.ui.screen


Purpose


The p.ui.screen annotation is used to tag an element as being a representation of a text-based user interface. Examples of text-based user interfaces include DOS or the Windows command console.


Example


The following is an example of a time when you might want to use the annotation




 


The following is an example of a rule that will apply the annotation




The following is the DITA XML output for the rule:


<title>GOS User Interface</title>


<conbody>


<screen>FILE  EDIT  OPTIONS  HELP  EXIT&#x2028;

+—————————————————————————————————————————————+&#x2028;

| Line:1  Col:1  F1=HELP                                                                                                                                       |&#x2028;

|>_                                                                                                                                                                                   |&#x2028;

|                                                                                                                                                                                       |&#x2028;

|                                                                                                                                                                                       |                                                                                  &#x2028;

|                                                                                                                                                                                       |&#x2028;

|                                                                                                                                                                                       |&#x2028;

+—————————————————————————————————————————————+</screen>


</conbody>


</concept>


 


 


The post p.ui.screen appeared first on Stilo.

]]>