Document Structure Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/document-structure/ experience XML in a whole new way | exceptional tools for structured content solutions Mon, 26 Apr 2021 20:13:35 +0000 en-US hourly 1 https://wordpress.org/?v=6.7.1 https://www.stilo.com/wp-content/uploads/2017/03/favicon-150x150.png Document Structure Archives - Stilo https://www.stilo.com/docs/%knowledge_base%/document-structure/ 32 32 p.no-title.custom-topic https://www.stilo.com/docs/migrate/document-structure/p-no-title-custom-topic/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64114 Syntax p.title.concept(level) p.title.glossary-group(level) p.title.reference(level) p.title.task(level) p.title.task-general(level) p.title.topic(level) p.title.troubleshooting(level) p.title.unknown-topic(level) p.title.custom-topic(elementname(level)) p.no-title.custom-topic(elementname(level)) level the nesting depth of the topic, any integer […]

The post p.no-title.custom-topic appeared first on Stilo.

]]>
Syntax

p.title.concept(level)
p.title.glossary-group(level)
p.title.reference(level)
p.title.task(level)
p.title.task-general(level)
p.title.topic(level)
p.title.troubleshooting(level)
p.title.unknown-topic(level)
p.title.custom-topic(elementname(level))
p.no-title.custom-topic(elementname(level))

level

the nesting depth of the topic, any integer

elementname

the name of the custom topic type

Purpose

Migrate will construct a DITA map which pulls together all created topics in the order in which they appear in your document. Topics may be nested, giving rise to a hierarchical DITA map. The annotation’s argument indicates the how deeply nested a topic should be in the map.

These annotations are used to identify topic boundaries and topic types. They should be placed on content elements of type paragraph which are titles in your document. Migrate will start a new DITA topic at these points, and will use the text of the annotated content element as the topic title. Larger nesting level topics will be created inside those of smaller nesting levels.

Typically, sequential depths such as 1, 2, and 3 are used with the title annotations that take arguments. However, Migrate really only looks at the relative numbering. So you could choose depths such as -14, -12, -10. These might simply be the negated font sizes of the heading styles in your document. Because -12 is larger than -14, Migrate will nest topics at depth -12 inside of those at depth -14.

The annotation p.title.unknown-topic is used to indicate the start of a new topic, but does not indicate the topic type. The annotation can be used in cases where the topic type is not easily determined based solely on the title itself. Migrate will use the existing DITA schema as well as the topic’s content to determine the best topic type for that topic. If the topic contains a numbered list that is marked up as steps, for example, that will give Migrate a strong indication that the topic is a task. If the topic contains a lot of tabular information, Migrate may decide that the topic is a reference topic.

The annotation p.title.custom-topic is used to set a title on a topic that is a specialized topic type to your document.

The annotation p.no-title.custom-topic is used to start a new topic of a type that is a specialized to your document without creating a title for that topic.

Example: Determining nesting level from font size.

p.title.topic(-\1)

when all of the following are true

style matches Heading[1-9]

  and property font-size matches ([1-9][0-9]?)

The post p.no-title.custom-topic appeared first on Stilo.

]]>
p.section https://www.stilo.com/docs/migrate/document-structure/p-section/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64116 Syntax p.section Purpose The annotation p.section creates a section without a title at whatever point is specified. This annotation once […]

The post p.section appeared first on Stilo.

]]>
Syntax

p.section

Purpose

The annotation p.section creates a section without a title at whatever point is specified. This annotation once took an argument for nesting level, so you may see older rules with an argument in parentheses. The argument is no longer used, but you don’t have to change existing rules; the level in parentheses will be ignored so long as you don’t have to edit the rule. If you do need to edit the rule, remove the parentheses and the number and save.

The section will remain open either until it encounters an element not permitted in a section, or until explicitly closed by a rule. See outside or start-anew for more information.

About QuickTrace

QuickTrace has the following features:

  • It collects trace information at clock speeds of up to 200MHz.
  • Uploading to Trace Debug Tools (TDT) uses Ethernet 10/100 baseT

To create a section at the line QuickTrace has the following features:, your rule may look like the following:

p-section-rule
Here is what your output may look like.

<title>About QuickTrace</title>
<conbody>
  <section>
    <p>QuickTrace has the following features:</p>
    <ul>
      <li>It collects trace information at clock speeds of up to 200MHz.</li>
      <li>Uploading to Trace Debug Tools (TDT) uses Ethernet 10/100 baseT</li>
    </ul>
  </section>
</conbody>

The post p.section appeared first on Stilo.

]]>
p.title.concept https://www.stilo.com/docs/migrate/document-structure/p-title-concept/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64118 Syntax p.title.concept(level) p.title.glossary-group(level) p.title.reference(level) p.title.task(level) p.title.task-general(level) p.title.topic(level) p.title.troubleshooting(level) p.title.unknown-topic(level) p.title.custom-topic(elementname(level)) p.no-title.custom-topic(elementname(level)) level the nesting depth of the topic, any integer […]

The post p.title.concept appeared first on Stilo.

]]>
Syntax

p.title.concept(level)
p.title.glossary-group(level)
p.title.reference(level)
p.title.task(level)
p.title.task-general(level)
p.title.topic(level)
p.title.troubleshooting(level)
p.title.unknown-topic(level)
p.title.custom-topic(elementname(level))
p.no-title.custom-topic(elementname(level))

level

the nesting depth of the topic, any integer

elementname

the name of the custom topic type

Purpose

Migrate will construct a DITA map which pulls together all created topics in the order in which they appear in your document. Topics may be nested, giving rise to a hierarchical DITA map. The annotation’s argument indicates the how deeply nested a topic should be in the map.

These annotations are used to identify topic boundaries and topic types. They should be placed on content elements of type paragraph which are titles in your document. Migrate will start a new DITA topic at these points, and will use the text of the annotated content element as the topic title. Larger nesting level topics will be created inside those of smaller nesting levels.

Typically, sequential depths such as 1, 2, and 3 are used with the title annotations that take arguments. However, Migrate really only looks at the relative numbering. So you could choose depths such as -14, -12, -10. These might simply be the negated font sizes of the heading styles in your document. Because -12 is larger than -14, Migrate will nest topics at depth -12 inside of those at depth -14.

The annotation p.title.unknown-topic is used to indicate the start of a new topic, but does not indicate the topic type. The annotation can be used in cases where the topic type is not easily determined based solely on the title itself. Migrate will use the existing DITA schema as well as the topic’s content to determine the best topic type for that topic. If the topic contains a numbered list that is marked up as steps, for example, that will give Migrate a strong indication that the topic is a task. If the topic contains a lot of tabular information, Migrate may decide that the topic is a reference topic.

The annotation p.title.custom-topic is used to set a title on a topic that is a specialized topic type to your document.

The annotation p.no-title.custom-topic is used to start a new topic of a type that is a specialized to your document without creating a title for that topic.

Example: Determining nesting level from font size.

p.title.topic(-\1)

when all of the following are true

style matches Heading[1-9]

  and property font-size matches ([1-9][0-9]?)

The post p.title.concept appeared first on Stilo.

]]>
p.title.custom-topic https://www.stilo.com/docs/migrate/document-structure/p-title-custom-topic/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64120 Syntax p.title.concept(level) p.title.glossary-group(level) p.title.reference(level) p.title.task(level) p.title.task-general(level) p.title.topic(level) p.title.troubleshooting(level) p.title.unknown-topic(level) p.title.custom-topic(elementname(level)) p.no-title.custom-topic(elementname(level)) level the nesting depth of the topic, any integer […]

The post p.title.custom-topic appeared first on Stilo.

]]>
Syntax

p.title.concept(level)
p.title.glossary-group(level)
p.title.reference(level)
p.title.task(level)
p.title.task-general(level)
p.title.topic(level)
p.title.troubleshooting(level)
p.title.unknown-topic(level)
p.title.custom-topic(elementname(level))
p.no-title.custom-topic(elementname(level))

level

the nesting depth of the topic, any integer

elementname

the name of the custom topic type

Purpose

Migrate will construct a DITA map which pulls together all created topics in the order in which they appear in your document. Topics may be nested, giving rise to a hierarchical DITA map. The annotation’s argument indicates the how deeply nested a topic should be in the map.

These annotations are used to identify topic boundaries and topic types. They should be placed on content elements of type paragraph which are titles in your document. Migrate will start a new DITA topic at these points, and will use the text of the annotated content element as the topic title. Larger nesting level topics will be created inside those of smaller nesting levels.

Typically, sequential depths such as 1, 2, and 3 are used with the title annotations that take arguments. However, Migrate really only looks at the relative numbering. So you could choose depths such as -14, -12, -10. These might simply be the negated font sizes of the heading styles in your document. Because -12 is larger than -14, Migrate will nest topics at depth -12 inside of those at depth -14.

The annotation p.title.unknown-topic is used to indicate the start of a new topic, but does not indicate the topic type. The annotation can be used in cases where the topic type is not easily determined based solely on the title itself. Migrate will use the existing DITA schema as well as the topic’s content to determine the best topic type for that topic. If the topic contains a numbered list that is marked up as steps, for example, that will give Migrate a strong indication that the topic is a task. If the topic contains a lot of tabular information, Migrate may decide that the topic is a reference topic.

The annotation p.title.custom-topic is used to set a title on a topic that is a specialized topic type to your document.

The annotation p.no-title.custom-topic is used to start a new topic of a type that is a specialized to your document without creating a title for that topic.

Example: Determining nesting level from font size.

p.title.topic(-\1)

when all of the following are true

style matches Heading[1-9]

  and property font-size matches ([1-9][0-9]?)

The post p.title.custom-topic appeared first on Stilo.

]]>
p.title.for-following-content https://www.stilo.com/docs/migrate/document-structure/p-title-for-following-content/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64122 Syntax p.title.for-following-content p.title.for-preceding-content Purpose The annotations p.title.for-following-content and p.title.for-preceding-content apply to section and figure, as well as anything that extends […]

The post p.title.for-following-content appeared first on Stilo.

]]>
Syntax

p.title.for-following-content
p.title.for-preceding-content

Purpose

The annotations p.title.for-following-content and p.title.for-preceding-content apply to section and figure, as well as anything that extends them. For example, syntaxdiagram extends figure, so these annotations would apply to syntaxdiagram. The items that extend section are as follows:

  • example
  • lcAudience
  • lcChallenge
  • lcDuration
  • lcGapAnalysis
  • lcInstruction
  • lcInteraction
  • lcIntervention
  • lcIntro
  • lcNeedsAnalysis
  • lcNextSteps
  • lcObjectives
  • lcPrereqs
  • lcProject
  • lcResources
  • lcReview
  • lcSummary
  • lcTechnical

The items that extend figure are as follows:

  • lcSingleSelect
  • lcMatching
  • lcMultipleSelect
  • lcTrueFalse

The annotation p.title.for-following-content can also be applied to a table when the title precedes the table and is outside of the table itself.

The post p.title.for-following-content appeared first on Stilo.

]]>
p.title.for-preceding-content https://www.stilo.com/docs/migrate/document-structure/p-title-for-preceding-content/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64124 Syntax p.title.for-following-content p.title.for-preceding-content Purpose The annotations p.title.for-following-content and p.title.for-preceding-content apply to section and figure, as well as anything that extends […]

The post p.title.for-preceding-content appeared first on Stilo.

]]>
Syntax

p.title.for-following-content
p.title.for-preceding-content

Purpose

The annotations p.title.for-following-content and p.title.for-preceding-content apply to section and figure, as well as anything that extends them. For example, syntaxdiagram extends figure, so these annotations would apply to syntaxdiagram. The items that extend section are as follows:

  • example
  • lcAudience
  • lcChallenge
  • lcDuration
  • lcGapAnalysis
  • lcInstruction
  • lcInteraction
  • lcIntervention
  • lcIntro
  • lcNeedsAnalysis
  • lcNextSteps
  • lcObjectives
  • lcPrereqs
  • lcProject
  • lcResources
  • lcReview
  • lcSummary
  • lcTechnical

The items that extend figure are as follows:

  • lcSingleSelect
  • lcMatching
  • lcMultipleSelect
  • lcTrueFalse

The annotation p.title.for-following-content can also be applied to a table when the title precedes the table and is outside of the table itself.

The post p.title.for-preceding-content appeared first on Stilo.

]]>
p.title.glossary-group https://www.stilo.com/docs/migrate/document-structure/p-title-glossary-group/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64126 Syntax p.title.concept(level) p.title.glossary-group(level) p.title.reference(level) p.title.task(level) p.title.task-general(level) p.title.topic(level) p.title.troubleshooting(level) p.title.unknown-topic(level) p.title.custom-topic(elementname(level)) p.no-title.custom-topic(elementname(level)) level the nesting depth of the topic, any integer […]

The post p.title.glossary-group appeared first on Stilo.

]]>
Syntax

p.title.concept(level)
p.title.glossary-group(level)
p.title.reference(level)
p.title.task(level)
p.title.task-general(level)
p.title.topic(level)
p.title.troubleshooting(level)
p.title.unknown-topic(level)
p.title.custom-topic(elementname(level))
p.no-title.custom-topic(elementname(level))

level

the nesting depth of the topic, any integer

elementname

the name of the custom topic type

Purpose

Migrate will construct a DITA map which pulls together all created topics in the order in which they appear in your document. Topics may be nested, giving rise to a hierarchical DITA map. The annotation’s argument indicates the how deeply nested a topic should be in the map.

These annotations are used to identify topic boundaries and topic types. They should be placed on content elements of type paragraph which are titles in your document. Migrate will start a new DITA topic at these points, and will use the text of the annotated content element as the topic title. Larger nesting level topics will be created inside those of smaller nesting levels.

Typically, sequential depths such as 1, 2, and 3 are used with the title annotations that take arguments. However, Migrate really only looks at the relative numbering. So you could choose depths such as -14, -12, -10. These might simply be the negated font sizes of the heading styles in your document. Because -12 is larger than -14, Migrate will nest topics at depth -12 inside of those at depth -14.

The annotation p.title.unknown-topic is used to indicate the start of a new topic, but does not indicate the topic type. The annotation can be used in cases where the topic type is not easily determined based solely on the title itself. Migrate will use the existing DITA schema as well as the topic’s content to determine the best topic type for that topic. If the topic contains a numbered list that is marked up as steps, for example, that will give Migrate a strong indication that the topic is a task. If the topic contains a lot of tabular information, Migrate may decide that the topic is a reference topic.

The annotation p.title.custom-topic is used to set a title on a topic that is a specialized topic type to your document.

The annotation p.no-title.custom-topic is used to start a new topic of a type that is a specialized to your document without creating a title for that topic.

Example: Determining nesting level from font size.

p.title.topic(-\1)

when all of the following are true

style matches Heading[1-9]

  and property font-size matches ([1-9][0-9]?)

The post p.title.glossary-group appeared first on Stilo.

]]>
p.title.reference https://www.stilo.com/docs/migrate/document-structure/p-title-reference/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64128 Syntax p.title.concept(level) p.title.glossary-group(level) p.title.reference(level) p.title.task(level) p.title.task-general(level) p.title.topic(level) p.title.troubleshooting(level) p.title.unknown-topic(level) p.title.custom-topic(elementname(level)) p.no-title.custom-topic(elementname(level)) level the nesting depth of the topic, any integer […]

The post p.title.reference appeared first on Stilo.

]]>
Syntax

p.title.concept(level)
p.title.glossary-group(level)
p.title.reference(level)
p.title.task(level)
p.title.task-general(level)
p.title.topic(level)
p.title.troubleshooting(level)
p.title.unknown-topic(level)
p.title.custom-topic(elementname(level))
p.no-title.custom-topic(elementname(level))

level

the nesting depth of the topic, any integer

elementname

the name of the custom topic type

Purpose

Migrate will construct a DITA map which pulls together all created topics in the order in which they appear in your document. Topics may be nested, giving rise to a hierarchical DITA map. The annotation’s argument indicates the how deeply nested a topic should be in the map.

These annotations are used to identify topic boundaries and topic types. They should be placed on content elements of type paragraph which are titles in your document. Migrate will start a new DITA topic at these points, and will use the text of the annotated content element as the topic title. Larger nesting level topics will be created inside those of smaller nesting levels.

Typically, sequential depths such as 1, 2, and 3 are used with the title annotations that take arguments. However, Migrate really only looks at the relative numbering. So you could choose depths such as -14, -12, -10. These might simply be the negated font sizes of the heading styles in your document. Because -12 is larger than -14, Migrate will nest topics at depth -12 inside of those at depth -14.

The annotation p.title.unknown-topic is used to indicate the start of a new topic, but does not indicate the topic type. The annotation can be used in cases where the topic type is not easily determined based solely on the title itself. Migrate will use the existing DITA schema as well as the topic’s content to determine the best topic type for that topic. If the topic contains a numbered list that is marked up as steps, for example, that will give Migrate a strong indication that the topic is a task. If the topic contains a lot of tabular information, Migrate may decide that the topic is a reference topic.

The annotation p.title.custom-topic is used to set a title on a topic that is a specialized topic type to your document.

The annotation p.no-title.custom-topic is used to start a new topic of a type that is a specialized to your document without creating a title for that topic.

Example: Determining nesting level from font size.

p.title.topic(-\1)

when all of the following are true

style matches Heading[1-9]

  and property font-size matches ([1-9][0-9]?)

The post p.title.reference appeared first on Stilo.

]]>
p.title.section https://www.stilo.com/docs/migrate/document-structure/p-title-section/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64130 Syntax p.title.section Purpose This annotation creates a new section with a title. This annotation once took an argument for nesting […]

The post p.title.section appeared first on Stilo.

]]>
Syntax

p.title.section

Purpose

This annotation creates a new section with a title. This annotation once took an argument for nesting level, so you may see older rules with an argument in parentheses. The argument is no longer used, but you don’t have to change existing rules; the level in parentheses will be ignored so long as you don’t have to edit the rule. If you do need to edit the rule, remove the parentheses and the number and save.

You may have a short topic like the following:

Preface

This preface introduces the Quick User Guide. It explains the structure of the User Guide and
lists other sources of information that relate to QuickTrace, BirdsEye Debugging Tools and
ICE+. It has the following sections:

•               About this document

•              Further reading.

About this document
This document describes version 1.0 of QuickTrace, BirdsEye Port Analyzer for trace capable microdevices.

You could have a rule that may look like this:

This would give you output that may look like the following:

p-title-section-rule

<title>Preface</title>
<conbody>
  <p>This preface introduces the Quick User Guide.
     It explains the structure of the User Guide and lists other sources of
     information that relate to QuickTrace, BirdsEye Debugging Tools and ICE+. It has the following sections:
  </p>
  <ul>
    <li><xref href="#ID-6252-000001db/ID-6252-000001ea">About this document</xref></li>
    <li><xref href="further_reading.dita">Further reading</xref>.</li></ul>
  <section>
    <title>About this document</title>
    <p>This document describes version 1.0 of QuickTrace, BirdsEye Port Analyzer
       for trace capable microdevices.
    </p>
  </section>
</conbody>

The post p.title.section appeared first on Stilo.

]]>
p.title.task https://www.stilo.com/docs/migrate/document-structure/p-title-task/ Mon, 15 Mar 2021 00:00:00 +0000 https://www.stilo.com/?post_type=docs&p=64132 Syntax p.title.concept(level) p.title.glossary-group(level) p.title.reference(level) p.title.task(level) p.title.task-general(level) p.title.topic(level) p.title.troubleshooting(level) p.title.unknown-topic(level) p.title.custom-topic(elementname(level)) p.no-title.custom-topic(elementname(level)) level the nesting depth of the topic, any integer […]

The post p.title.task appeared first on Stilo.

]]>
Syntax

p.title.concept(level)
p.title.glossary-group(level)
p.title.reference(level)
p.title.task(level)
p.title.task-general(level)
p.title.topic(level)
p.title.troubleshooting(level)
p.title.unknown-topic(level)
p.title.custom-topic(elementname(level))
p.no-title.custom-topic(elementname(level))

level

the nesting depth of the topic, any integer

elementname

the name of the custom topic type

Purpose

Migrate will construct a DITA map which pulls together all created topics in the order in which they appear in your document. Topics may be nested, giving rise to a hierarchical DITA map. The annotation’s argument indicates the how deeply nested a topic should be in the map.

These annotations are used to identify topic boundaries and topic types. They should be placed on content elements of type paragraph which are titles in your document. Migrate will start a new DITA topic at these points, and will use the text of the annotated content element as the topic title. Larger nesting level topics will be created inside those of smaller nesting levels.

Typically, sequential depths such as 1, 2, and 3 are used with the title annotations that take arguments. However, Migrate really only looks at the relative numbering. So you could choose depths such as -14, -12, -10. These might simply be the negated font sizes of the heading styles in your document. Because -12 is larger than -14, Migrate will nest topics at depth -12 inside of those at depth -14.

The annotation p.title.unknown-topic is used to indicate the start of a new topic, but does not indicate the topic type. The annotation can be used in cases where the topic type is not easily determined based solely on the title itself. Migrate will use the existing DITA schema as well as the topic’s content to determine the best topic type for that topic. If the topic contains a numbered list that is marked up as steps, for example, that will give Migrate a strong indication that the topic is a task. If the topic contains a lot of tabular information, Migrate may decide that the topic is a reference topic.

The annotation p.title.custom-topic is used to set a title on a topic that is a specialized topic type to your document.

The annotation p.no-title.custom-topic is used to start a new topic of a type that is a specialized to your document without creating a title for that topic.

Example: Determining nesting level from font size.

p.title.topic(-\1)

when all of the following are true

style matches Heading[1-9]

  and property font-size matches ([1-9][0-9]?)

The post p.title.task appeared first on Stilo.

]]>