standardize formatting across documents and dtds with modular fosis
DESCRIPTION
Standardize Formatting Across Documents and DTDs with Modular FOSIs. Suzanne Napoleon FOSIexpert, LLC www.FOSIexpert.com. Event hashtag is #PTCUSER10. Join the conversation!. The Challenge: Standardize Formatting. - PowerPoint PPT PresentationTRANSCRIPT
![Page 1: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/1.jpg)
Standardize Formatting Across Documents and DTDs with Modular FOSIsSuzanne NapoleonFOSIexpert, LLC
www.FOSIexpert.com
![Page 2: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/2.jpg)
Join the conversation!
Event hashtag is #PTCUSER10
![Page 3: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/3.jpg)
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
![Page 4: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/4.jpg)
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
![Page 5: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/5.jpg)
![Page 6: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/6.jpg)
![Page 7: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/7.jpg)
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
![Page 8: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/8.jpg)
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
![Page 9: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/9.jpg)
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:
– basic-charsubsets.ent
– A4-pagesets.ent
– list-counters.ent
![Page 10: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/10.jpg)
The Process, continued
5. Code the “desc”s directly in the .fos files:
– rsrcdesc
– secdesc
– pagedesc
– styldesc
– ftndesc
![Page 11: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/11.jpg)
The Process, continued
6. Code FOSI-specific formatting directly in each .fos file
For example:
– Code warning.txt=“Warning” in Book-English.fos
– Code warning.txt=“Warnung” in Book-German.fos
![Page 12: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/12.jpg)
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
![Page 13: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/13.jpg)
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
![Page 14: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/14.jpg)
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
![Page 15: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/15.jpg)
File Entities Dialog
![Page 16: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/16.jpg)
Entities in .fos Files
<!ENTITY std-charfills SYSTEM "std-charfills.ent"><!ENTITY std-counters SYSTEM "std-counters.ent"><!ENTITY std-stringdecls SYSTEM "std-stringdecls.ent"><!ENTITY std-pagesets SYSTEM "std-pagesets.ent"><!ENTITY std-charsubsets SYSTEM "std-charsubsets.ent"><!ENTITY seriesA-charsubsets SYSTEM "seriesA-charsubsets.ent">
<!ENTITY seriesA-docdesc SYSTEM "seriesA-docdesc.ent"><!ENTITY std-eics SYSTEM "std-eics.ent"><!ENTITY seriesA-eics SYSTEM "seriesA-eics.ent"><!ENTITY std-footnote SYSTEM "std-footnote.ent"><!ENTITY std-ftnatts SYSTEM "std-ftnatts.ent">
![Page 17: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/17.jpg)
Entities in the Tagged FOSI Editor
• Insert references to the appropriate modules into each .fos file
![Page 18: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/18.jpg)
The Process, continued
8. Compile each FOSI to incorporate changes
– Changes are not reflected in the FOSIs until they are compiled
![Page 19: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/19.jpg)
The Process, continued
9. Document the modules referenced by each FOSI
Be sure to update this documentation whenever you:
– Modify a module
– Add or delete references to a module
![Page 20: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/20.jpg)
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
– Detect context errors sooner rather than later
• Format test documents regularly and look for unintended formatting changes
![Page 21: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/21.jpg)
Tips, continued
• Keep the documentation up to date: Modular FOSIs are only as good as their documentation
![Page 22: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/22.jpg)
“WYSIWYG is last-century technology!”
![Page 23: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/23.jpg)
Questions?
![Page 24: Standardize Formatting Across Documents and DTDs with Modular FOSIs](https://reader035.vdocument.in/reader035/viewer/2022062217/56812bb1550346895d8fec0b/html5/thumbnails/24.jpg)