Create your own $35 CMS in Structured FrameMaker

Create your own $35 CMSin Structured FrameMaker

Jang F.M. Graat

JANG Communication

Presented at tcword 2010 - © JANG Communication 2010

Who’s talking ?

Jang F.M. Graat

Studied Physics, Psychology, Philosophy

20+ years Tech Writer, Trainer, Consultant

15+ years company JANG Communication

Self-taught FM expert


Agenda

Step 1: Create reusable modules

Step 2: Create your CMS

Step 3: Enable cross-references

Step 4: Create books from your CMS


Step 1: Create reusable modules


Modular documentation


FrameMaker text insets

Import entire flows

Disadvantages

Inset source required

No search mechanism

No previewing

No check on structure


West Street Consulting

FrameMaker ACE Russ Ward

Full-time tech writer + part-time software developer

Website: www.weststreetconsulting.com

Extremely useful plug-ins for FM7, FM8, FM9

Xref Wizard ( $ 35 per seat )

FrameSLT ( $ 100 per seat )

InsetPlus ( free )

AXCM ( free )


InsetPlus

Element-level linking

Advantages

Any element in file

User-friendly interface

Search & preview

Check on validity

Updating quick & easy

Tracking of usage


InsetPlus linking method

Element attributes

Source: Unique ID

Target: conref

Inserting & updating

Insert empty element

Link to source element

Update indivual inset

Update all insets in file


InsetPlus: further options

Tracking information

Where is source used ?

Updating all references

Linking options

Editing conref attribute

No source required yet

Automated creation ofbooks in XML processor


Define your EDD

Reusable elements

id and conref attributes

Metadata attributes

Any element ?

Granularity

Manage the chaos

Use nested elements

Element (Container): Section General rule: Title, Body?, Section* Valid as the highest-level element. Attribute list 1. Name: id UniqueID Optional 2. Name: conref String Optional 3. Name: version String Required 4. Name: validity String Optional 5. Name: author String Required 6. Name: date String Required


Step 2: Create your CMS


Content Management

Keep track of stuff

Storing modules

Searching modules

Validity for publications

Review & translation

Database needed ?

No magic involved

Manage the chaos


Content Management

Finding content

Clear structure

Strict naming

Without a CMS ?

Store in repositories

Restrict modularity

Practice discipline !!!


Repository files

Reusable elements

Metadata in attributes

Enable search & checks

Printable as catalog

Bundle reuse modules

Per machine section

Per software section

Clear subdivisions


Catalog of available modules

Special formatting

If included in Repository

Show element id

Include metadata

Print full catalog

Searchable PDF

Helps author reuse


Special formatting in EDD

Element (Container): conceptGeneral rule: title, shortdesc?, context?, conbody, links?

Attribute list1. Name: id UniqueID Optional2. Name: conref String Optional3. Name: version String Optional4. Name: validity String Optional

Prefix rules1. If context is: [ id != “” ]

Prefix: concept:\tid\nversion:\t<$attribute[version]>\nvalid for:\t<$attribute[validity]>

Text format rules1. If context is: [ id != “” ]

Use paragraph format: RepHeading


Organize repository files

Division of modules

One file per assembly ?

One file per topic type ?

One file per product ?

Collect in books

Easier to manage

Language variants

Keep same structure


Organize image files

Divide into categories

Types of image files

Machine-specific images

Language variants

One dir per language

One dir for generic pics

Keep same structure


Organize publications

Always use books

Required for CMS

Easier to manage

Language variants

Same language codes

Versions

Full books in subdirs

Include all chapters


Step 3: Enable cross-references


Xrefs in FrameMaker

Enabling Xrefs

Marker attribute in allreferrable elements

CrossReference element with target attribute

Both attributes optional

Creating Xrefs

Enter CrossRef element

Link to available marker


Xrefs in FrameMaker

Element (Container): ParaGeneral rule: (<TEXT> | CrossRef )*

Element (CrossReference): CrossRefAttribute list

1. Name: XRefTarget ID Reference Optional

Element (Container): TitleGeneral rule: <TEXTONLY>Attribute list

1. Name: XRefMarker Unique ID Optional


Xrefs in FrameMaker

Xrefs to other files

Ref’d file required

Changes in ref’d file !

Prepare for Xrefs

Manually define marker

FM attribute editor

Use unique names


Xrefs in FrameMaker

Updating Xrefs

Source files required

Xref to inset text

Xref to inset source,not to inset reference

Marker available,but not recognized

Manual relinkingSee X. X

See X. X

Book


XRef Wizard

Attribute-based linking

Unique IDs targeted

No file names used

Advantages

No file-dependence

Works with text insets

Updating quick & easy

Reports with links


XRef Wizard

Updating Xrefs

Book-level process

Only files in book

Xref to inset text

Xref defined in attributeindependent of filename

Marker recognized

Automatic relinking See X. X

See X. X

Book


XRef Wizard

Book level

Resolves all Xrefs

Reports conflicts

Multiple targets

Choice of candidates

Allows jumping into

Fast and easy

Update book after this


Step 4: Create books


Preparing a publication

Create new Book

Create empty Chapters

Add to the book

Import EDD to all

Import formats to all

Set required info

Book attributes


Add reuse elements

Insert empty element

Use InsetPlus

“Edit Inset Element”

Select repository file

Valid elements are listed

Select required element

Click OK twice

Continue until done


Publishing books

Order of final steps

Select book file

Open all chapters

Update all insets

Resolve all XRefs

Update book

Save book as PDF


Keeping track

Excel workbook

Available topics

Versions, revisions

Status and planning

Available translations

Usage information

Manually in Excel

Via InsetPlus reports


Translation management

Directory structure

Language codes

Translate repositories

Translate images

Copy of book

Script to process language codes


Questions ?


More info: send e-mail to

[email protected]


Create your own $35 CMS in Structured FrameMaker

Technology

Transcript of Create your own $35 CMS in Structured FrameMaker