1 / 28

Technical Presentation: XML Single-Source Project Multiple-Output Results

Technical Presentation: XML Single-Source Project Multiple-Output Results. Cary L. Waterhouse ENGL 5387: Publications Management Dr. Craig Baehr - April 2010. Tasks. Develop strategies Adapt original document Distribute content Output to practical sources XML-based Stylesheet-driven

caelan
Télécharger la présentation

Technical Presentation: XML Single-Source Project Multiple-Output Results

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Technical Presentation:XML Single-Source ProjectMultiple-Output Results Cary L. Waterhouse ENGL 5387: Publications Management Dr. Craig Baehr - April 2010

  2. Tasks • Develop strategies • Adapt original document • Distribute content • Output to practical sources • XML-based • Stylesheet-driven • Accessibility, usefulness, suitability • Provide Deliverables

  3. Deliverables • Source document • Two single-sourced versions • Short abstract • Functional portfolio links • Present findings

  4. Project Proposal and User Analysis • Initial desire: • “to develop a bidding guidelines document, a bid checklist, a formal bid letter template and create a web page with hyperlinks to relevant resources for the bidding process.” • User Needs: • “Processes to follow and available information on how to develop project bids.” • “Information that provides management with a high confidence that bids are created accurately”

  5. History for Project • Recent Requests For Proposals (RFPs) • Show increased desire for single-source solutions • Large aircraft Original Equipment Manufacturer (OEM) transitioning to XML publishing environment • Future requirements for XML data exchange • Current unstructured FrameMaker publishing processes • Need for XML solution • Industry migration to digital publishing • STC Conference topics reflect single-source trend

  6. Initial Effort • Follow Adobe FrameMaker 7.0 XML Cookbook Tutorial • “It is easy to create XML from your Structured FrameMaker 7.0 documents. Several support files control the authoring, importing, and exporting behaviors of your project.” • “… all you need is a Structured Template. Before you save your first XML document to XML markup, you will set up your XML Application File, reference your XML DTD, and create your XML Read/Write rules.” • Configure FrameMaker files for Bid project in parallel to learning the process

  7. FrameMaker Structured Authoring

  8. Development Plan • Build Structured Application • Modify FrameMaker’s existing “structapps.fm” • Build basic EDD from basic DTD • Create “ReadWriteRules.fm” conversion file • Develop Structured Template • Read XML Instance • Output Products • Page-based, PDF bidding guidelines document • CSS-driven, HTML page

  9. Build Structured Application FrameMaker Authoring Environment Modify “structapps.fm” file to build ENGL5387FinalProject App

  10. Build EDD from DTD Defines structure for imported/exported XML data Opening through Structured Tools converts DTD to FrameMaker EDD

  11. Create ReadWriteRules file • Essentially a mapping file that equates XML Elements to a structured template’s Styles

  12. Development Plan • Build Structured Application • Modify existing structapps.fm • Build EDD from existing DTD • Create ReadWriteRules conversion file • Develop Structured Template (Caution here to those of you that might ever come across the words, “all you need”) • Read XML Instance • Output Products • Page-based, PDF bidding guidelines document • CSS-driven, HTML page

  13. Road Block

  14. Halfway Point Questions • Task Definition • Proposal • History • Initial Development

  15. Re-Directed • Abandoned FrameMaker solution • Without a Structured Template, data will not read in and display in page-based format • Considered knowledge gained from XML exercise • Began looking to CSS for possible considerations • From the CSS handout from Week 8, “CSS is a scripting language used for specifying the styles and position of markup content (in HTML, XHTML, DHTML, and XML) in Web pages” • This solution seemed to build only slightly from the XML exercise and I wanted to apply this project experience to work-related activities • Returned to FrameMaker to utilize XML Cookbook structured template sample file

  16. Possible Alternate Solution

  17. Structured ChapterTemplate.fm Sample • Analyzed Structure and layout of template • Selectively chose equivalent formatting for desired paper-based layout Note page layout and styles of sample Chapter template

  18. Success Reading XML data Established format baseline to work from Red Structure View area shows the difference between valid and well-formed XML data This resulted because the ChapterTemplate had been built with different structure rules

  19. Return to modify Development Plan • Re-work BidReadWriteRules • Align XML tags with existing template Styles • Re-work original content tagging • Clean up Headings • Consider output • Read XML Instance • Output Products • Page-based, PDF bidding guidelines document • CSS-driven, HTML page

  20. Initial FrameMaker PDF Output Note similar formatting of this PDF version

  21. Initial HTML Output • CSS-driven format exported from FrameMaker • CSS Stylesheet and HTML file generated Note formatting of this HTML version

  22. Modification of Output Results of different “In-Line” format changes directly in HTML file

  23. Modification of Output Results of change to CSS Stylesheet

  24. Additional XSLT stylesheet • Change structapps.fm to output XSL stylesheet for additional HTML version • No visible difference in style

  25. Quality • Methods • Depended on quality of original source document technical information • In-Process editing • Modified content • Modified structure • Syntax checking • Feedback from FrameMaker • Feedback from browsers • Structure/Format • Usability/Visual Rhetoric

  26. Lessons Learned • It paid to stick with original plan and find alternate solution to challenge • Need to gain experience building structured templates • Key to development phase • Could become high-demand skill set • Project has provided valuable knowledge and hands-on experience for upcoming work projects • DTD, EDD, Template, Structured authoring, and CSS • Project Management of task was secondary to development efforts • Heightened appreciation for collaborators at work • Attend as many structured authoring sessions as possible at STC Conference in May • Share knowledge of tools and processes

  27. Summary • XML Single-Source project • Presented challenges of learning unfamiliar technology • Required Project Management implementation • Paralleled current work-related projects • Deliverables of project • Source file [Bid_Process_SourceRTF.rtf] • XML conversion of source file [bid.xml] • Single-sourced versions • PDF version of Bid Process [bid_Finalpdf.pdf] • HTML version and CSS stylesheet [bid.html - bid.css] • Modified HTML files [bid_modifiedCSS.html and bid2.css] • Changed CSS file, renamed it, and updated HTML reference to it

  28. Closing • I’d like to thank all of you for your contributions to our communal knowledge sharing this semester • Dr. Baehr, this is THE most combined theoretical/practical course I’ve taken, Thanks! • Questions? Sincere Appreciation - Cary W.

More Related