Power to the People: Supporting PCA-driven content creation through custom development

Size: px

Start display at page:

Download "Power to the People: Supporting PCA-driven content creation through custom development"

Loreen Rice
6 years ago
Views:

1 Power to the People: Supporting PCA-driven content creation through custom development Anna Hartman, SAP April 5, 2016 Public

4 UA at SAP UA Design and Customer Experience Cloud-enabled User Analysis Embedded UA Videos, Contextual Help Integrated API Documentation People and Processes Enablement 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 4

DITA CMS User Environment DITA CMS Production Environment DITA Project Map Editor Production Center Builds Translation Dashboard Build Dashboard Container Management/Cloning IXIASOFT DITA CMS Eclipse

5 DITA CMS User Environment DITA CMS Production Environment DITA Project Map Editor Production Center Builds Translation Dashboard Build Dashboard Container Management/Cloning IXIASOFT DITA CMS Eclipse Plug-in oxygen Editor Eclipse Plug-in Remote Access Infrastructure (RDP) DITA Build System Core TT Custom TT Custom TT DITA OT Framework DITA OT Antenna House Build Infrastructure DITA CMS back-end environment IXIASOFT TextML Application Server TextML Infrastructure (cluster, failover) 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 5

6 Versioning: Container Model A container contains objects that belong together on a content level, e.g., all maps, topics, and images used to document a software component for a given release is an inventory list of the IDs of the objects that are contained in it defines for each ID which physical object is used by pointing to the file name references object using <keydef> 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 6

7 What is PCA? People Centric Approach Who are our people? Internal and external users with disparate backgrounds and unique needs Different systems/backgrounds/companies Some DITA, some not Branding Delivery channels Release Cycles What does it mean to us? Develop custom, creative, flexible solutions that enhance and simplify the overall UA infrastructure SAP SE or an SAP affiliate company. All rights reserved. Public 7

9 Structured FM DocBook/CC Bleeding Edge Sybase FM + SGML Archaic Project DITA IXIASOFT title DITA CMS Scheduled dates Team DB 2 DITA membersmigration Project title Scheduled dates Team members 70+ Users Training User Guide Metamap SAP IXIASOFT DITA CMS* Migration Regression Moving Forward 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 9

10 Problem Statement and Requirements Simplify project and output management within DITA CMS with more flexible build process. Started with output maps that included metadata for delivery. Project referenced output maps, which referenced buildable maps. No easy way to apply global settings, manage collections in a build manifest Have flexible Build process (e.g. support of multiple Build schedules based on various time zones, disabling some outputs in the projects). With this would come the added benefit of build optimization and better use of resources SAP SE or an SAP affiliate company. All rights reserved. Public 10

Solution Project Map DITA Project Map Editor 2016 SAP SE

12 What is a Project Map? The project map is a specialized map in the DITA CMS used to contain project, output, and publishing information for a project. Users create a project map in the root container of the dependency tree. This is the highestlevel container in the dependency tree. The project map versions with the container. The project map defines the list of the outputs that are built for the project. In this way, the project map replaces all the output maps in the project. Users create projects in the same way in the DITA CMS. However, now they only need to associate one project map with the project (instead of an output map for every output). The project map defines the list of languages used in the build process at the project level. By default this list is inherited at the output level, with the possibility to disable some languages, if needed. Users edit the project map using the Project Map Editor SAP SE or an SAP affiliate company. All rights reserved. Public 12

13 Advantages of Project Maps Simplifies project management for projects with many outputs. Doc Leads define output properties (rendering, profiling, delivery channels) at the project level that can be inherited by groups of outputs. Users can edit certain properties on a group of outputs. Easily enable/disable the build for groups of outputs. Helps the Production Team optimize build resources. Includes milestones and output languages at the project level SAP SE or an SAP affiliate company. All rights reserved. Public 13

14 Information in a Project Map General: This information applies to the whole project: Project title and description List of publishing languages Milestones Global Settings: Create a setting to define a set of properties that can be applied to one or many outputs: Rendering setting: defines all Open Toolkit properties required for a trans-type. Profiling setting: defines profiling settings (strategy, mode, conditions with attributes/values). Delivery channel setting: defines information for a given delivery channel (for example, Nexus) Outputs: An output is publishing configuration for a deliverable. For each output, users configure: The title, buildable map loio, and trans-type. The rendering and profiling settings to inherit, if any. The list of languages to build and an output file name. The delivery channel for each language SAP SE or an SAP affiliate company. All rights reserved. Public 14

Creating a Project Map Before creating the project map, create or clone a project. In the new project, replace the former project map with the latest version. 1 Select Create Map.

15 Creating a Project Map Before creating the project map, create or clone a project. In the new project, replace the former project map with the latest version. 1 Select Create Map. 2 3 Enter a Map Title. Use the name of the project without the version information. Select project-map.ditamap, Open map in DITA Map view. Click Select to select the root container SAP SE or an SAP affiliate company. All rights reserved. Public 15

Creating a Project Map 4 5 Click Create. Release the map.

Drag the project map from the Search Results view (or Documents view or DITA

17 Adding the Project Map to the Project 1 2 Open the project in the Project Management view. Drag the project map from the Search Results view (or Documents view or DITA Map view) to the Deliverables tab in the Project Management view SAP SE or an SAP affiliate company. All rights reserved. Public 17

18 Project Map Editor Project map title and description. You can edit both fields Set the languages for your project here. Add settings for delivery channels, rendering, and profiling Add outputs to your project map SAP SE or an SAP affiliate company. All rights reserved. Public 18

19 General Tab General Information The title is automatically added upon creation of the project map. Users can change the name in the Title field. Add an optional description for the project map SAP SE or an SAP affiliate company. All rights reserved. Public 19

General Tab - Languages Click to add additional languages to the project.

General Tab Global Settings Click to add delivery channel, profiling, and rendering

22 Global settings Delivery channels Click to add a delivery channel to the project. Highlight a row and click to edit a setting or click to delete a setting. The following delivery channels appear by default: 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 22

24 Global settings- Profiling 2 In the Strategy field, select Include or Exclude. This is a general setting. Users choose the following profiling strategies: Include: profiled content for all conditions maintained in the project map is also included in the document. Non-profiled (generic) content is always included in the document. Exclude: profiled content is removed from the document. Non-profiled (generic) content is always included in the document SAP SE or an SAP affiliate company. All rights reserved. Public 24

25 Global settings- Profiling 3 In the Mode field, users can choose the following profiling modes for your PDF deliverables: Standard: default mode where no flagging shall be used for preparing the delivery. Flag: Adds a flag in the topic showing the profile that was used on a particular element in the topic. TICM: custom option for certain SAP guides. Standard shows or hides the profiled content. With flagging, profiled content is highlighted using a flag or the text is wrapped in a green bar SAP SE or an SAP affiliate company. All rights reserved. Public 25

Global settings- Profiling 4 Select one or more profiling conditions in the Profiling

Global settings- Rendering 2 Select the trans-type from the drop-down

Global settings- Rendering 3 Click to add a rendering property to your

30 Global settings- Rendering 4 Select the relevant rendering property and value. Click Add. 5 Add as many properties as needed, and click Add SAP SE or an SAP affiliate company. All rights reserved. Public 30

32 Milestones tab Click to add a new milestone to your project. Highlight a row and click to add the due date and status to a setting or click to delete a milestone SAP SE or an SAP affiliate company. All rights reserved. Public 32

33 Adding output entries After users define output languages and settings (rendering, profiling, delivery channels), users add reference to buildable maps (deliverables) and globally apply settings. 1 Lock the project map and open it in the DITA Project Map editor. 2 Click the Outputs tab. Any existing outputs are listed. 3 Click the Add Output icon SAP SE or an SAP affiliate company. All rights reserved. Public 33

5 6 7 In the Outputs page of the Project Map editor, enter a Title for the output (this can be the same as

34 Adding output entries 4 Right-click the buildable map (for example in the Search Results) and select Copy > Copy ID In the Outputs page of the Project Map editor, enter a Title for the output (this can be the same as the buildable map) Select the Type (this is the trans-type). Right-click the Buildable map field and paste the ID copied earlier SAP SE or an SAP affiliate company. All rights reserved. Public 34

35 Adding output entries 8 Enter an Owner. This name appears in the Build Dashboard, another plug-in used by teams to manage nightly builds. 9 In the Rendering and Profiling dropdown lists, select the rendering and profiling settings (if any) to apply to this output (these were defined earlier in the General tab) SAP SE or an SAP affiliate company. All rights reserved. Public 35

To enter an output for a given language, name, select the line and click the Edit

36 Adding Output Filenames In the Languages box, a line appears for each output language defined in global settings. To enter an output for a given language, name, select the line and click the Edit language icon. Enter the output file name for the language SAP SE or an SAP affiliate company. All rights reserved. Public 36

37 Configuring Build Cycles Optionally, users can select a Build cycle. Each output and each language can have a separate cycles (either Daily or Weekly). *Soon Doc Leads can specify the time of day for the builds (00:00 CET or 13:00 CET), at the project level SAP SE or an SAP affiliate company. All rights reserved. Public 37

38 Configuring Build Mode Optionally, users select a Build mode. A Draft build renders: the unique identifier of every topic in the topic title draft comments the security level to Internal The Production-Draft status builds both production and draft versions of the build SAP SE or an SAP affiliate company. All rights reserved. Public 38

39 Enabling Builds To enable or disable the build for a specific language, set the Status. Users can also do this from the Languages box with the enable and disable build icons: 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 39

40 Adding Delivery Channels To add a delivery channel for a language, select Add delivery channel icon. Select the Language and the Setting from the dropdown lists, which are populated with data from Global Settings. For Perforce, enter the language path. To enable or disable the push to the delivery change for a specific language, set the Status. Users can also do this from the Languages box with the enable and disable push icons: 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 40

41 Saving Output Entries When all the output properties, languages, and delivery channels are configured, click to apply the changes. The output editor closes and the output entry appears in the list on the Outputs tab. Save and release the project map SAP SE or an SAP affiliate company. All rights reserved. Public 41

Manage the output list (Output tab) Combined search used to filter the Output list Actions Select all outputs Unselect all outputs Edit selected outputs Duplicate selected output Add output Remove

42 Manage the output list (Output tab) Combined search used to filter the Output list Actions Select all outputs Unselect all outputs Edit selected outputs Duplicate selected output Add output Remove selected output Enable the Build for selected outputs Disable the Build for selected outputs Export all output information in a TSV file (available in a later release) 2016 SAP SE or an SAP affiliate company. All rights reserved. Public 42

Editing Multiple Outputs In the Output list, select multiple outputs to which the changes apply,

45 Editing Multiple Outputs If a field has different values among the selected outputs, <MULTIPLE-VALUES> is displayed. The information entered for these or any other fields are applied to all outputs in the selection SAP SE or an SAP affiliate company. All rights reserved. Public 45

46 It s All About People Project Map and DITA Project Map Editor = just one example of a PCA-driven solution. Global Evolution Model Future Innovation Every Team IS Exceptional, but keep it simple You can please some of the people some of the time, all of the people some of the time, some of the people all of the time but you can never please all of the people all of the time SAP SE or an SAP affiliate company. All rights reserved. Public 46

47 Thank you Contact information: Anna Hartman Development Expert SAP North America

DITA CMS Release : Detailed Release Notes

DITA CMS Release : Detailed Release Notes DITA CMS Release 4.2.31: Detailed Release Notes WWW.IXIASOFT.COM / DITACMS v. 4.2, Build 4.2.31 / Copyright 2016 IXIASOFT Technologies. All rights reserved. Last revised: April 07, 2016 2 DITA CMS Release