Download presentation
Presentation is loading. Please wait.
Published byRachael Gordon Modified over 9 years ago
1
Standardize Formatting Across Documents and DTDs with Modular FOSIs Suzanne Napoleon FOSIexpert, LLC www.FOSIexpert.com
2
Join the conversation! Event hashtag is #PTCUSER10
3
The Challenge: Standardize Formatting Organizations mandate standardized formatting in order to safeguard corporate identity branding However, documents, DTDs, and formatting specs change over time When there are multiple FOSIs, the same edits must be made to all FOSIs affected by the changes This approach is time-consuming and error-prone
4
The Solution: Modular FOSIs Common formatting is coded in FOSI modules Individual FOSIs reference the appropriate modules When a module is edited, all FOSIs that reference that module are changed This approach makes it much easier to maintain standardized formatting over time
7
The Technical Details A FOSI is an SGML document that adheres to the OutSpec DTD SGML file entities can be used in a FOSI A FOSI module is an SGML file entity
8
The Process 1. Review each FOSI and create charsubsets, pseudo- elements, and/or text entities, as appropriate, for any common code within a FOSI 2. Compare all FOSIs to determine which share common formatting
9
The Process, continued 3. Develop a naming convention for FOSIs and modules that makes their purpose obvious 4. Use.ent extension for modules to facilitate searching the file system Examples: –b–basic-charsubsets.ent –A–A4-pagesets.ent –l–list-counters.ent
10
The Process, continued 5. Code the “desc”s directly in the.fos files: –r–rsrcdesc –s–secdesc –p–pagedesc –s–styldesc –f–ftndesc
11
The Process, continued 6. Code FOSI-specific formatting directly in each.fos file For example: –C–Code warning.txt=“Warning” in Book-English.fos –C–Code warning.txt=“Warnung” in Book-German.fos
12
The Process, continued 7. Make as many file entities as needed for the following FOSI components and name them appropriately: hyphrule docdesc charfill charsubset counter envdesc stringdecl e-i-c floatloc footnote pageset ftnatt sectoken
13
Create File Entity create_file_entity (cfe ) creates a file entity with the selected content, prompts for the name of the entity and the file name or Public IC, and inserts the entity into the document
14
Declare File Entity declare_file_entity (dfe) prompts for the name of the entity and the file name or the Public ID for the entity to be created
15
File Entities Dialog
16
Entities in.fos Files
17
Entities in the Tagged FOSI Editor Insert references to the appropriate modules into each.fos file
18
The Process, continued 8. Compile each FOSI to incorporate changes –C–Changes are not reflected in the FOSIs until they are compiled
19
The Process, continued 9. Document the modules referenced by each FOSI BB e sure to update this documentation whenever you: –M–Modify a module –A–Add or delete references to a module
20
Tips Alphabetize counters, strings, e-i-c’s, charsubsets, etc., before creating FOSI modules Alphabetize counters, strings, etc., in modules Compile frequently while developing modules –D–Detect context errors sooner rather than later Format test documents regularly and look for unintended formatting changes
21
Tips, continued Keep the documentation up to date: Modular FOSIs are only as good as their documentation
22
“WYSIWYG is last-century technology!”
23
Questions?
Similar presentations
© 2024 SlidePlayer.com Inc.
All rights reserved.