Programming Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/programming/ experience XML in a whole new way | exceptional tools for structured content solutions Mon, 18 Dec 2023 10:43:52 +0000 en-US hourly 1 https://wordpress.org/?v=6.7.1 https://www.stilo.com/wp-content/uploads/2017/03/favicon-150x150.png Programming Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/programming/ 32 32 p.parameter.entry https://www.stilo.com/docs/migrate/programming/p-parameter-entry/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64202 Syntax p.parameter.entry p.parameter.term(level) level nesting level for the list, any integer p.parameter.definition(level) level nesting level for the list, any integer […]

The post p.parameter.entry appeared first on Stilo.

]]> Syntax

p.parameter.entry

p.parameter.term(level)

level

nesting level for the list, any integer

p.parameter.definition(level)

level

nesting level for the list, any integer

Purpose

Parameter lists are sets of terms paired with their possible values. These parameters are inputs to an object of some kind. Sometimes these appear as tables in legacy documentation, while other times they appear as plain text. Parameter lists may be nested, with the level value indicating nesting depth.

Example:

Following are the parameters that apply to the annotation conref():

key

short label used to identify the text being referenced; any String

id-for-the-library (optional)

the file ID for your conref file; any String

filename (optional)

name for your file; this file will be included in your DITA output; any String

content (optional)

the text that will replace the conref in the published document; any String

topic-type (optional)

type of topic for your library file; String for topic type

Since the terms and definitions are in different paragraphs, you will need to use the annotations p.parameter.term() and p.parameter.definition() to mark up the paragraphs.

This is what your rules may look like.

Rules for paragraph-level parameter list terms and values

Your output may look like this.

<parml>
  <plentry>
    <pt>key</pt>
    <pd> short label used to identify the text being referenced; any String</pd>
  </plentry>
  <plentry>
    <pt>id-for-the-library (optional)</pt>
    <pd> the file ID for your conref file; any String</pd>
  </plentry>
  <plentry>
    <pt>filename (optional)</pt>
    <pd> name for your file; this file will be included in your DITA output; any String</pd>
  </plentry>
  <plentry>
    <pt>content (optional)</pt>
    <pd> the text that will replace the conref in the published document; any String</pd>
  </plentry>
  <plentry>
    <pt>topic-type (optional)</pt>
    <pd> type of topic for your library file; String for topic type</pd>
  </plentry>
</parml>


The post p.parameter.entry appeared first on Stilo.

]]>
					
		
		
			
		
		p.parameter.term
		https://www.stilo.com/docs/migrate/programming/p-parameter-term/
		
		
		Mon, 15 Mar 2021 00:00:00 +0000
				https://www.stilo.com/?post_type=docs&p=64204

					Syntax p.parameter.entry p.parameter.term(level) level nesting level for the list, any integer p.parameter.definition(level) level nesting level for the list, any integer […]


The post p.parameter.term appeared first on Stilo.

]]>
										Syntax

p.parameter.entry


p.parameter.term(level)


level


nesting level for the list, any integer


p.parameter.definition(level)


level


nesting level for the list, any integer


Purpose


Parameter lists are sets of terms paired with their possible values. These parameters are inputs to an object of some kind. Sometimes these appear as tables in legacy documentation, while other times they appear as plain text. Parameter lists may be nested, with the level value indicating nesting depth.


Example:


Following are the parameters that apply to the annotation conref():


key


short label used to identify the text being referenced; any String


id-for-the-library (optional)


the file ID for your conref file; any String


filename (optional)


name for your file; this file will be included in your DITA output; any String


content (optional)


the text that will replace the conref in the published document; any String


topic-type (optional)


type of topic for your library file; String for topic type


Since the terms and definitions are in different paragraphs, you will need to use the annotations p.parameter.term() and p.parameter.definition() to mark up the paragraphs.


This is what your rules may look like.


Rules for paragraph-level parameter list terms and values


Your output may look like this.


<parml>
  <plentry>
    <pt>key</pt>
    <pd> short label used to identify the text being referenced; any String</pd>
  </plentry>
  <plentry>
    <pt>id-for-the-library (optional)</pt>
    <pd> the file ID for your conref file; any String</pd>
  </plentry>
  <plentry>
    <pt>filename (optional)</pt>
    <pd> name for your file; this file will be included in your DITA output; any String</pd>
  </plentry>
  <plentry>
    <pt>content (optional)</pt>
    <pd> the text that will replace the conref in the published document; any String</pd>
  </plentry>
  <plentry>
    <pt>topic-type (optional)</pt>
    <pd> type of topic for your library file; String for topic type</pd>
  </plentry>
</parml>




The post p.parameter.term appeared first on Stilo.

]]>
					
		
		
			
		
		p.parameter.definition
		https://www.stilo.com/docs/migrate/programming/p-parameter-definition/
		
		
		Mon, 15 Mar 2021 00:00:00 +0000
				https://www.stilo.com/?post_type=docs&p=64206

					Syntax p.parameter.entry p.parameter.term(level) level nesting level for the list, any integer p.parameter.definition(level) level nesting level for the list, any integer […]


The post p.parameter.definition appeared first on Stilo.

]]>
										Syntax

p.parameter.entry


p.parameter.term(level)


level


nesting level for the list, any integer


p.parameter.definition(level)


level


nesting level for the list, any integer


Purpose


Parameter lists are sets of terms paired with their possible values. These parameters are inputs to an object of some kind. Sometimes these appear as tables in legacy documentation, while other times they appear as plain text. Parameter lists may be nested, with the level value indicating nesting depth.


Example:


Following are the parameters that apply to the annotation conref():


key


short label used to identify the text being referenced; any String


id-for-the-library (optional)


the file ID for your conref file; any String


filename (optional)


name for your file; this file will be included in your DITA output; any String


content (optional)


the text that will replace the conref in the published document; any String


topic-type (optional)


type of topic for your library file; String for topic type


Since the terms and definitions are in different paragraphs, you will need to use the annotations p.parameter.term() and p.parameter.definition() to mark up the paragraphs.


This is what your rules may look like.


Rules for paragraph-level parameter list terms and values


Your output may look like this.


<parml>
  <plentry>
    <pt>key</pt>
    <pd> short label used to identify the text being referenced; any String</pd>
  </plentry>
  <plentry>
    <pt>id-for-the-library (optional)</pt>
    <pd> the file ID for your conref file; any String</pd>
  </plentry>
  <plentry>
    <pt>filename (optional)</pt>
    <pd> name for your file; this file will be included in your DITA output; any String</pd>
  </plentry>
  <plentry>
    <pt>content (optional)</pt>
    <pd> the text that will replace the conref in the published document; any String</pd>
  </plentry>
  <plentry>
    <pt>topic-type (optional)</pt>
    <pd> type of topic for your library file; String for topic type</pd>
  </plentry>
</parml>




The post p.parameter.definition appeared first on Stilo.

]]>
					
		
		
			
		
		s.parameter.definition
		https://www.stilo.com/docs/migrate/programming/s-parameter-definition/
		
		
		Mon, 15 Mar 2021 00:00:00 +0000
				https://www.stilo.com/?post_type=docs&p=64208

					Syntax s.parameter.term s.parameter.definition Purpose Parameter lists are sets of terms paired with their possible values. These parameters are inputs to […]


The post s.parameter.definition appeared first on Stilo.

]]>
										Syntax

s.parameter.term

s.parameter.definition


Purpose


Parameter lists are sets of terms paired with their possible values. These parameters are inputs to an object of some kind. Sometimes these appear as tables in legacy documentation, while other times they appear as plain text.


Example:


Following are the parameters that apply to the annotation conref():


key – short label used to identify the text being referenced; any String

id-for-the-library (optional) – the file ID for your conref file; any String

filename (optional) – name for your file; this file will be included in your DITA output; any String

content (optional) – the text that will replace the conref in the published document; any String

topic-type (optional) – type of topic for your library file; String for topic type


In this example, the terms and values are in the same paragraph; you can apply the annotations s.parameter.term and s.parameter.definition to the appropriate spans. You will also need the annotation p.parameter.entry on the entire paragraph to make the set of terms and values into a single parameter list.


Here is what your rule may look like.


Rules for span-level parameter list terms and values


Your output may look like this.


<parml>
  <plentry>
    <pt>key</pt>
    <pd>short label used to identify the text being referenced; any String</pd>
  </plentry>
  <plentry>
      <pt>id-for-the-library (optional)</pt>
      <pd>the file ID for your conref file; any String</pd>
  </plentry>
  <plentry>
    <pt>filename (optional)</pt>
    <pd>name for your file; this file will be included in your DITA output; any String</pd>
  </plentry>
  <plentry>
    <pt>content (optional)</pt>
    <pd>the text that will replace the conref in the published document; any String</pd>
  </plentry>
  <plentry>
    <pt>topic-type (optional)</pt>
    <pd>type of topic for your library file; String for topic type</pd>
  </plentry>
</parml>


The post s.parameter.definition appeared first on Stilo.

]]>
					
		
		
			
		
		s.parameter.term
		https://www.stilo.com/docs/migrate/programming/s-parameter-term/
		
		
		Mon, 15 Mar 2021 00:00:00 +0000
				https://www.stilo.com/?post_type=docs&p=64210

					Syntax s.parameter.term s.parameter.definition Purpose Parameter lists are sets of terms paired with their possible values. These parameters are inputs to […]


The post s.parameter.term appeared first on Stilo.

]]>
										Syntax

s.parameter.term

s.parameter.definition


Purpose


Parameter lists are sets of terms paired with their possible values. These parameters are inputs to an object of some kind. Sometimes these appear as tables in legacy documentation, while other times they appear as plain text.


Example:


Following are the parameters that apply to the annotation conref():


key – short label used to identify the text being referenced; any String

id-for-the-library (optional) – the file ID for your conref file; any String

filename (optional) – name for your file; this file will be included in your DITA output; any String

content (optional) – the text that will replace the conref in the published document; any String

topic-type (optional) – type of topic for your library file; String for topic type


In this example, the terms and values are in the same paragraph; you can apply the annotations s.parameter.term and s.parameter.definition to the appropriate spans. You will also need the annotation p.parameter.entry on the entire paragraph to make the set of terms and values into a single parameter list.


Here is what your rule may look like.


Rules for span-level parameter list terms and values


Your output may look like this.


<parml>
  <plentry>
    <pt>key</pt>
    <pd>short label used to identify the text being referenced; any String</pd>
  </plentry>
  <plentry>
      <pt>id-for-the-library (optional)</pt>
      <pd>the file ID for your conref file; any String</pd>
  </plentry>
  <plentry>
    <pt>filename (optional)</pt>
    <pd>name for your file; this file will be included in your DITA output; any String</pd>
  </plentry>
  <plentry>
    <pt>content (optional)</pt>
    <pd>the text that will replace the conref in the published document; any String</pd>
  </plentry>
  <plentry>
    <pt>topic-type (optional)</pt>
    <pd>type of topic for your library file; String for topic type</pd>
  </plentry>
</parml>


The post s.parameter.term appeared first on Stilo.

]]>
					
		
		
			
		
		s.syntax.group-choice
		https://www.stilo.com/docs/migrate/programming/s-syntax-group-choice/
		
		
		Mon, 18 Dec 2023 10:43:52 +0000
				https://www.stilo.com/?post_type=docs&p=85598

					Syntax s.syntax.group-choice   Purpose The s.syntax.group-choice annotation is used to tag a span element as being an option that the […]


The post s.syntax.group-choice appeared first on Stilo.

]]>
										Syntax

s.syntax.group-choice


 


Purpose


The s.syntax.group-choice annotation is used to tag a span element as being an option that the user can choose in a syntax diagram. A group choice can be nested within a group sequence or group composite.


 


This annotation can be applied at both the span and paragraph scopes.


Examples


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




 


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




The following is the DITA XML output for the rule:


<groupchoice>


<title>>group </title>


<repsep>,</repsep>


<kwd>OptionA</kwd>


<kwd>OptionB</kwd>


<kwd>OptionC</kwd>


</groupchoice>


The post s.syntax.group-choice appeared first on Stilo.

]]>
					
		
		
			
		
		s.syntax.delimiter
		https://www.stilo.com/docs/migrate/programming/s-syntax-delimiter/
		
		
		Mon, 18 Dec 2023 10:39:48 +0000
				https://www.stilo.com/?post_type=docs&p=85594

					Syntax s.syntax.delimiter   Purpose The s.syntax.delimiter annotation is used to tag a span element as being the character at the […]


The post s.syntax.delimiter appeared first on Stilo.

]]>
										Syntax

s.syntax.delimiter


 


Purpose


The s.syntax.delimiter annotation is used to tag a span element as being the character at the beginning or end of a syntax diagram section. Commonly used delimiters are


    

  • parentheses
    • 

  • commas
    • 

  • tabs
    • 

  • vertical bars
    • 



Examples


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




 


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




The following is the DITA XML output for the rule:


>>-<kwd>2</kwd>–<oper>*</oper>–<var>user_input</var>–<delim>=</delim>


The post s.syntax.delimiter appeared first on Stilo.

]]>
					
		
		
			
		
		p.variable-name
		https://www.stilo.com/docs/migrate/programming/p-variable-name/
		
		
		Mon, 18 Dec 2023 10:29:49 +0000
				https://www.stilo.com/?post_type=docs&p=85590

					Syntax p.variable-name   Purpose The p.variable-name annotation is used to tag an element as being the generic name of a […]


The post p.variable-name appeared first on Stilo.

]]>
										Syntax

p.variable-name


 


Purpose


The p.variable-name annotation is used to tag an element as being the generic name of a variable.


Examples


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




 


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




The following is the DITA XML output for the rule:


<p>In this document, variables will appear as follows:</p>


<varname>&lt;variable></varname>


The post p.variable-name appeared first on Stilo.

]]>