View Categories

s.file-path

< 1 min read

Table of Contents

Syntax #

s.file-path

 

Purpose #

The s.file-path annotation is used to tag a span element as being the name of a file or system directory. This is typically applied to snippets of a file path or a full file path contained within a sentence.

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 the previous example, <filepath>/user/</filepath> will be replaced by the name of the user in question. <filepath>C:</filepath> may be replaced if the user has installed GOS to a hard drive other than their <filepath>C:</filepath> drive.</p>