Platform Profiling

You can use the platform attribute to make content reusable and to publish customized deliverables.

Use Cases

Consider profiling your content with the platform attribute in the following scenarios:

  • A product has steps or considerations specific to different operating systems. For example, the installation procedure of the product is different for macOS® or Windows.
  • A product operates differently on specific hardware platforms.

Platform Profiling Example

You include or exclude profiled content by applying a DITAVAL during publication.
Remember: By default, all content is included in published deliverables, unless you have applied conditional profiling.
Figure 1. Platform-Specific Sections.

This example shows a concept topic that contains sections specific to different operating systems. This way, documentation for Windows users excludes macOS®-specific content and documentation for macOS® users excludes Windows-specific content.

Section with Windows platform highlighted in DITA topic
Figure 2. Platform-Specific Topic. This example shows a reference topic specific for Windows users. This way, the topic is a part of the documentation for Windows users. For macOS® users, the topic is not visible.
DITA task profiled to Windows platform
Figure 3. DITAVAL for Windows-specific Documentation.

This example shows a DITAVAL that includes Windows-specific content and excludes macOS®-specific content.

DITAVAL excluding MacOS content and including Windows content