VideosColors and Styles for Profiled Content

Overview

This video highlights the features that improve the existing profiling support. You will learn how you can customize the Author editing mode to mark profiled content so that you can instantly spot different variants of the output.

Transcript

00:00:09This video highlights the features that improve the existing profiling support.
00:00:14You will learn how you can customize the Author editing area to mark profiled content so you
00:00:19can instantly spot different variants of the output.
00:00:28The sample we use in our demonstration is a lawnmowing manual with
00:00:32instructions about mowing techniques and equipment maintenance.
00:00:37Our DitaMap guide contains topics that address different levels of user skills and different
00:00:43types of equipment.
00:00:44This required a profiling based on the intended audience and mower type.
00:00:49All defined profiling conditions are kept in the application settings.
00:00:54We'll use a shortcut to get there quickly.
00:00:58We have previously defined two profiling attributes:
00:01:01- "product", having as values three types of lawn mowers: electric, gas-powered and
00:01:08manual
00:01:08and...
00:01:10- "audience" having the values Expert and Novice
00:01:17Our documents are already profiled and we choose to display the profiling markers.
00:01:26As you can see, the Maintenance topic contains information addressed to all audiences and
00:01:30mower types.
00:01:32The text contains a lot of profiling and this makes difficult the editing in a specific
00:01:37context.
00:01:39To help us identify quickly the sections of document intended to specific product or audience,
00:01:45we can apply styling to profiled content.
00:01:47Back to Profiling Settings... Colors and Styles page...
00:01:53Note that the styles table already contains an empty style for each profiling value
00:01:58defined in the conditional text options page.
00:02:01This helps us quickly associate profiling styles.
00:02:05You can individually style each profiling value or
00:02:08let oXygen do this for you by choosing the Automatic Styling option.
00:02:13To manually set styling for a profiling value, double click its corresponding entry in the
00:02:19profiling styles table.
00:02:21Here we can set a foreground color,
00:02:24a background color, apply text decoration and text styling.
00:02:30There are predefined color samples, but you can also pick any custom color you would like.
00:02:37Choosing the right style for a specific profiling attribute is a matter of personal taste, but
00:02:42remember to:
00:02:44- avoid excessive profiling.
00:02:46If the same block of text is profiled with two or more profiling attributes, their associated
00:02:52styles combine.
00:02:53Depending on the styling, this might result in an excessively styled content that may
00:02:58prove difficult to read or work with;
00:03:02- profile only differences.
00:03:03There is no need to profile common content, since excessive profiling can visually pollute
00:03:08the document;
00:03:10- use mnemonics.
00:03:11A mnemonic associated with a style will help you spot instantly different types of content.
00:03:18For example, in our case, we can choose different foreground colors for the "product" attribute.
00:03:24Thus, we associate blue with electricity,
00:03:27red with gasoline,
00:03:28and green with eco-friendly manual reel mower.
00:03:34So, we set a blue foreground color for electric...
00:03:40red for gas-powered ...
00:03:47and green for manual.
00:03:52For the Expert profiling we choose a light red background
00:03:54and an underline italic text.
00:04:00For Novice we choose only a light green background.
00:04:04Now... going back to the document...
00:04:08we enable the "Show Profiling Colors and Styles" option.
00:04:12Note that the styling is now applied in the Author editor,
00:04:16the Outline view and Dita Maps Manager view.
00:04:21Also, to help you identify more easily the needed profiling in the current context,
00:04:27the styling is applied in the "Edit Profiling Attributes" dialog and
00:04:32in the inline form control that allows you to quickly set the profiling attributes.
00:04:37Now we can easily spot the content written for specific output.
00:04:42For example, after a quick look at the DITA Maps Manager view, we can see that there are
00:04:46two topics specially written for gas-powered mower's documentation.
00:04:50All the other topics will go into the manuals of all types of mowers.
00:04:55More, after a quick look over the Maintenance topic, we see that it contains sections designed
00:05:01for each type of mower:
00:05:03electric... gas-powered... manual...
00:05:07Also, one of the maintenance task - cleaning the mower's underside for debris - combines
00:05:13two profiling styles
00:05:14(red and blue foregrounds) meaning that it is designed for both Gas-powered (red) and
00:05:19Electric (blue) mowers.
00:05:22These colors are combined, resulting a purple foreground.
00:05:26If you feel that the document is overcolored you can also customize the profiling markers.
00:05:32For example, you can choose a different color for the marker's border in the 'Attributes
00:05:37Rendering' options page.
00:05:39You can also set the attribute names and values foreground and background colors, and the
00:05:45displayed profiling information, more specifically, if the name of the attribute should be included
00:05:50in the profiling marker.
00:05:54You can also remove the profiling marker completely by turning off the "Show Profiling Attributes"
00:06:03option.
00:06:06Now that we are happy with the result, we want to share the profiling settings
00:06:10with other members of the team.
00:06:13Thus, we'll save all profiling options at project level.
00:06:17Using a source control system we can share the project with the rest of the team.
00:06:21We'll choose to overwrite already existing profiling settings.
00:06:26Now, for the colors and styles page...and for the attributes rendering page.
00:06:37If any of the team members wants to further customize the styling, for example, he or
00:06:42she can go back to global options and adjust them as needed.
00:06:54Another feature designed to help you focus on the current profiling context is the ability
00:06:59to hide content filtered out by the currently applied condition set.
00:07:04Let's apply one of the defined condition sets.
00:07:07When "Show Excluded Content" option is on, the content filtered out by the applied condition
00:07:13set fades out.
00:07:15If you prefer to hide it completely to allow you to focus on a specific type of content,
00:07:21turn this option off.
00:07:23Now, let's see how the output will look like if the gas-powered condition set is applied.
00:07:31And now, for the Manual condition set.
00:07:36To remind you that document content is hidden, oXygen displays labels showing the currently
00:07:41applied condition set.
00:07:44These labels are displayed in the Author editing area, the Outline View and DITA Maps Manager
00:07:51view.
00:07:53To switch back to the full content display, you can use the shortcut action, from the
00:07:56label's contextual menu.
00:08:02And this concludes our demonstration.
00:08:04For more information, you can also watch the related video demonstrations.