Rolling Out DITA by Rolling In SharePoint and DITA...
49
Rolling Out DITA by Rolling In SharePoint and DITA Exchange Sheila D’Annunzio, STMicroelectronics Steffen Frederiksen, DITA Exchange Content Strategies/DITA NA, Baltimore April 2011
Transcript of Rolling Out DITA by Rolling In SharePoint and DITA...
Rolling Out DITA by Rolling In
SharePoint and DITA Exchange
Sheila D’Annunzio, STMicroelectronics
Steffen Frederiksen, DITA Exchange
Content Strategies/DITA NA, Baltimore April 2011
About STMicroelectronics
STMicroelectronics is a global leader serving customers
across the spectrum of electronics applications with
innovative semiconductor solutions.
In 2010, the Company’s net revenues were $10.35 billion.
Further information on ST can be found at www.st.com.
2
DITA
Word SharePoint
About DITA Exchange
DITA on Microsoft SharePoint & Office
Open (use any other tool)
Key part of the Microsoft “Intelligent Content Framework”
Customers in:
Semiconductors
Pharma & Life sciences
Hi-Tech manufacturing
www.dita-exchange.com / [email protected]
4
>< DITA Exchange ApS Katrinebjerg Science Park Aabogade 15 DK-8200 Aarhus N DENMARK
>< DITA Exchange Inc. 900 E. Hamilton Campbell California 95008 USA
Contents
The business drivers
SharePoint as a CCMS with DITA Exchange
Word as an XML editor and publishing engine.
Overcoming challenges in the implementation process
Publishing process
Metadata
The future roadmap
Connecting to the corporate web site
Implementing workflows via SharePoint
Handling translation
Exchanging data with joint-venture-partners.
5
The business drivers
Introduction - DITA in ST
Ran pilot in 2008 / 2009
Used only versioning system for pilot – no CCMS
Stopped as files soon became unmanageable
Put in CCMS DITA Exchange in 2010
7
Managing the hundreds of files converted in the pilot caused a lot of pain!
Basic CCMS requirements
8
File management (file names, versions, links and metadata)
Link management (where topics are used)
Map download and upload (with all linked files)
Workflows
Integrate publication process
Integrate conditional processing
Related topics (branch/clone)
Access rights
Extra CCMS requirements
9
Within budget
IT department approval
Collaboration tool easy to
deploy to SMEs Scale up to hundreds of SMEs
How Dx met these needs
10
Cost reasonable, SharePoint already
budgeted, only buy Dx part IT deployed SharePoint, in-line with
company policy
SMEs know SharePoint
DITA Word editor easy to use for SMEs
Can easily scale up due to
reasonable cost
DITA Word editor
11
DITA Word editor
12
DITA Word editor
13
Additional benefits
No need to buy editor
Word-based output process
Can tweak output for things like page breaks
Can easily change output format (change the Word template)
Can add custom stylesheet for more complex transformations
Easy to integrate with other business systems (out-of-the-box SharePoint)
TopicPicker - allows any employee to reuse DITA content in classic Word docs
Can produce OpenXML – use as input to other processes (e.g. IP-XACT database)
We got up and running very quickly as we started with a hosted (cloud) solution
15
Overcoming challenges in the
implementation process
The publishing process
In pilot had customized the DITA-OT and
integrated it into XMetaL
Dx has choice of DITA-OT or Dx Word publisher
DITAWord (OpenXML)PDF
Was skeptical about using the Dx Word publisher
but decided to try…………………….
17
Dx Word publisher benefits
Uses a .dotm template
which is very easy to
modify without any
programming
knowledge!
18
Going through Microsoft Word gives you some “artistic license” with
the layout
For example you can force tables to start at the top of a page or
insert a page break
This avoids the criticism of ugly PDFs – a common complaint from
customers after moving to XML!
But beware – tech writers must not update the content here!!!!
Dx Word publisher benefits
19
And it worked…………………..
20
Word output PDF
Save as
DITA Exchange Word Publisher
21
DITA Exchange Word Publisher
Other “Use Cases”:
Publish from DITA to Word template, with instructional
text, optional text, standard required text, drop-down
lists, etc.
Publish hybrid DITA content: DITA topics and Word
documents mixed in a DITA map
“Word Washer” publishing: Standardize all styling
Checking for document policies/business rules
22
Metadata
Underestimated the importance
Thought could just use out-of-box metadata
23
Metadata
Dx has no folder structure
If metadata is not well defined cannot find
anything
24
Why Folders Are “Bad”
25
Topic 1
?
Why Folders Are “Bad”
26
Topic 1
Topic 1
Topic 1 !
Why Metadata are Great
27
Customized metadata
Customized the metadata without
specializing DITA
Used <data> element
28
Metadata mapping, Word editor
29
Easy to fill-in, even for SMEs who make the first draft
Metadata mapping, CCMS
30
Easy to search and filter
Dynamic Metadata Configuration
Document
Dx Document
DITA
Map Topic
Task Concept Reference
DITAVAL Publication
Office
Word Excel PowerPoint
Media
Image Video Math
31
SharePoint “Content Types”
With built-in inheritance
Dynamic Metadata Configuration
Document
Dx Document
DITA
Map Topic
Task Concept Reference
DITAVAL Publication
Office
Word Excel PowerPoint
Media
Image Video Math
32
Dynamic Metadata Configuration
Document
Dx Document
DITA
Map Topic
Task Concept Reference
DITAVAL Publication
Office
Word Excel PowerPoint
Media
Image Video Math
33
Dynamic Metadata Configuration
Document
Dx Document
DITA
Map Topic
Task Concept Reference
DITAVAL Publication
Office
Word Excel PowerPoint
Media
Image Video Math
34
Dynamic Metadata Configuration
Document
Dx Document
DITA
Map Topic
Task Concept Reference
DITAVAL Publication
Office
Word Excel PowerPoint
Media
Image Video Math
35
Metadata Mapping To DITA XML
36
Metadata Mapping To DITA XML
37
//prolog/metadata/data[@name=“DrugDosageForm”]/@value
Dynamic Metadata Configuration
1. Create a metadata field
2. Attach to a content type
3. Define XML mapping (for XML files)
4. DONE!
38
Dynamic Metadata Configuration
1. Create a metadata field
2. Attach to a content type
3. Define XML mapping (for XML files)
4. DONE!
39
And BTW, as a side effect of
this, you get “Where Used”,
“Family Tree”, and link
management for all Office files
too…
The future roadmap
Next steps
Bring tool in-house
Connect to internal tools
41
Translation memory
Product catalog
Web CMS
Connect to internal tools
42
Connect to internal tools
43
1. (Open external content (with IPXACT/SIDSC) in
Word editor)
2. Insert or edit (in Word) IPXACT/SIDSC building
blocks
3. Publish (Word Publisher) with embedded
IPXACT tagging
4. Extract IPXACT from published document
Workflows
DITA Exchange workflows = SharePoint workflows
44
Collaboration?
Collaboration!
Shared Content Collaboration Platform
Sub-contractor Sub-contractor Sub-contractor
Customer Customer
48
I
Love
DITA
49
SharePoint
Loves
Dita
THANK YOU!
50 DITA Exchange
