"XML-2-HTML" System Documentation
   Next

"XML-2-HTML" System Documentation

Website Build & Maintenance

William Reilly

william@reilly2001.info

August 21, 2003 (1.4)

Revision History
Revision 1.3March 11, 2003wr

Documentation very nearly complete. (Outstanding: Very basic DocBook documentation; more Glossary and Index terms.)

  • Concepts, Introduction: four new graphics summarizing hierarchy of all site components; DTD section; Elements section; EZA Recipes section; Advanced Concepts - Derived Content Types; Aggregation; Microsoft Index Server.

  • Improved DocBook processing to use catalogs, profiling.

Revision 1.2hJanuary 13, 2003wr

Additional subjects.

  • Seven-Level Hierarchical (Visual) "Tour" added to "Concepts"; Site Pages, Layouts; Module Types; Buildlist; "ML"s (Markup Languages); 32 additional Figures; additions to Index; beginnings of Glossary

Revision 1.2January 4 , 2003wr

Additional subjects.

  • "Content vs. Presentation" discussion; added "Make Directory" step to "Add a New Page" (client feedback); Introduction to "Concepts"; Sitemap discussion ("Key Premise"), including "Exceptions"; Navigation: Nav1, Nav2, Nav3, PgHdrs, Javascript Pre-Cache; Content Types discussion, including "Future Content Type Candidates"; "Career Video (3rd party) Popup"; 7 additional Figures; 3 additional Tables; initial exploration of Index to documentation (tbd)

Revision 1.1December 27, 2002wr

Additional subjects.

  • Running a Build; Adding Off-Site Hyperlink; Three-Letter NAV2.xml Codes (derived from new XSLT); Sitemap Levels 0 - 4 graphic; XML & XSLT "Walk-Through"; additional Popup screen captures

Revision 1.0December 20, 2002wr

Documentation first version delivered.

  • Software Required, Installation, and Page Visualizations sections completed.

  • Task-Oriented section largely completed.

  • Concepts, Advanced Concepts sections in outline format

  • Completed versions of incomplete sections forthcoming.

Table of Contents

1. Introduction
Brief Description
Content vs. Presentation
Required Software
Installation
Directory Structure
A Few Words about Version Control
2. Task-Oriented
Running a Build
Environment, Context
Steps
Press Releases
Add New Press Release
Add New Year for Press Releases
Add a New Page
Level 4 Page
Level 3 Page
Level 2 Page
Level 1 Page
Add Off-Site Hyperlink
Link Syntax
3. Concepts
Introduction
Hierarchical "Tour"
Introductory
Level 01: Nested "Non-Place-able" Elements
Level 02: "Non-Place-able" Elements
Level 03: "Place-able" Elements
Level 04: Module Type ('mt2col_top') Zones and Positions
Level 05: Page Layout Zones and Positions, and Modules
Level 06: Page Layout Zones: Header, Body, Footer; Zone-holding Zones; Module-holding Zones
Level 07: Page Layout '05'; Page Layout <table>s; CSS Margins
Sitemap
Site "Levels" (0 - 4)
Key Premise
Exceptions
Naming Conventions
Navigation
Nav1
Nav2
Nav3
PgHdr
Javascript Pre-Cache
Drilling Down Navigation
3-Letter Codes
Site Pages
Page Types
Page Layouts
Page Layout Files
Modules (Page Components, or "Fragments")
Modules
Module Types
Buildlist
Buildlist.xml = "Page Recipes"
Buildlist Visual
Version Control (Again)
Content Types
Types
CT Naming, Numbering
Further Content Type Candidates
"ML"s ("Markup Languages")
ML Overall Structure
Four MLs
DTDs (Document Type Definitions)
DTD per CT
DTD Modular Approach
DTD Maintenance
Why (X)HTML?
Elements
"Place-able" Elements
"Non-Place-able" Elements
Element-Zone Assignments (EZA)
EZA "Recipes"
XSLT Pipeline
XSLT Transformations
1st "Hop" Snippets - BML-to-SML
2nd "Hop" Snippets - SML-to-SLML
3rd "Hop" Snippets - SLML-to-SiteHTML
Final Results from "Hops" Snippets - SiteHTML
4. Page Visualizations
Representative Site Pages
Home Page ("Level 0")
Site Section Page ("Level 1")
Site Sub-Section Page ("Level 2")
Site Sub-Sub-Section Page ("Level 3")
Site Detail Page ("Level 4")
Representative Press Release Pages
Home Page ("Level 0")
"Media" Site Section Page ("Level 1")
"Recent Press Releases" Site Sub-Section Page ("Level 2")
"Year 2002 Press Releases" Site Sub-Sub-Section Page ("Level 3")
Full Press Release, Site Detail Page ("Level 4")
Page Layouts
Page Layout 01 ("Level 1" pages)
Page Layout 05 ("Level 2 + 3" (and Press Release "Level 4") pages)
Page Layout 06 ("Level 4")
Special Pages, Popups
Sitemap
"Footer-Linked" Pages (Usage Terms, etc.)
Popups
Glossary Popup
"Leaving" Popup
Video Choice Popup
Video Popup
Career Video (3rd Party) Popup
5. Advanced Concepts
Introduction
Derived Content Types
Aggregation
Automated Aggregation
Manual "Aggregation"
Presentation Types, Presentation Styles
DTD Maintenance
Microsoft Indexing Service
Search Functionality Requirements
Indexing Service: Walk-through for Two Catalogs
Query Form, Logic, Configuration, and Error Pages
A. Structure
Directory Structure
Naming Conventions
Listing of (Most) Files
B. How This Documentation Was Written (DocBook)
Very Brief Information about DocBook for this Documentation
Digitas Detailed Information About DocBook
Glossary of Terms
Index

List of Figures

1.1. Trees Into Rectangles
2.1. MS-Word .DOC for Press Release
2.2. CT10 BusinessML (in XML Spy)
2.3. Path to recent Press Release, for use in BuildList lookup
2.4. Location in buildlist.xml of recent press release
2.5. "Root" index page Path, for use in BuildList lookup
2.6. Press Releases location in NAV2.xml
2.7. Press Releases Year 2002 (2003 commented out) (in NAV2.xml)
2.8. Press Releases Years 2002 and 2003 (in NAV2.xml)
3.1. A. Sitemap, Site Section, Page
3.2. B. Page Layout, Page Layout Zone, Position
3.3. C. Module Type (Layout), Module Zone, Position
3.4. D. Place-able Element, Non-Place-able Element, Text
3.5. Level 01 (Lowest): Nested "Non-Place-able" Elements
3.6. Level 02: "Non-Place-able" Elements
3.7. Level 03: "Place-able" Elements
3.8. Level 04: Module Type ('mt2col_top') Zones and Positions
3.9. Level 05: Page Layout Zones and Positions, and Modules
3.10. Level 06: Page Layout Zones: Header, Body, Footer; Zone-holding Zones; Module-holding Zones
3.11. Level 07: Page Layout '05'; Page Layout <table>s; CSS Margins
3.12. Sitemap, showing Site Levels (0 - 4)
3.13. Investors Stock Information Page
3.14. Job Search Page
3.15. Career Video Page
3.16. Navigation 1, 2, 3, and Page Header
3.17. Navigation (Nav2+3 and Nav4) Screenshots
3.18. Page Layout (01): Header, Body, Footer
3.19. Page Layout (01): Header: Site Header, Nav One
3.20. Page Layout (01): Header: Site Header—Module Zone
3.21. Module Zone with Multiple Module Positions
3.22. Page Layout (01): Header: Nav One—Module Zone
3.23. Page Layout (01): Body: Nav Two, "Matter"
3.24. Page Layout (01): Body: Nav Two—Module Zone
3.25. Page Layout (01): Body: "Matter": Page Header, "Content + Related"
3.26. Page Layout (01): Body: "Matter": Page Header—Module Zone
3.27. Page Layout (01): Body: "Matter": "Content + Related": Content, "Related"
3.28. Page Layout (01): Body: "Matter": "Content + Related": Content—Module Zone
3.29. Page Layout (01): Body: "Matter": "Content + Related": Related—Module Zone
3.30. Page Layout (01): Footer: Footer
3.31. Page Layout (01): Footer:—Module Zone
3.32. Page Layout (01): Header, Body, Footer:—ALL Module Zones
3.33. Module Types, Columns
3.34. Buildlist.xml Source XML, "Visual" DTD, Tree
3.35. Copy Processing
3.36. BusinessML: Source XML, "Visual" DTD, Tree
3.37. StructureML: Source XML, "Visual" DTD, Tree
3.38. StructureML showing 'eza' element with "following-sibling" 'div'
3.39. StructureLayoutML: Source XML, "Visual" DTD, Tree
3.40. StructureLayoutML showing 'td' element with content from the 'div' seen in StructureML.
3.41. SiteHTML: Source XML, Tree
3.42. Copy Processing, Transformations
4.1. Home Page screenshot
4.2. Site Section Page (R&D) screenshot
4.3. Site Sub-Section Page (R&D | Cardiovascular) screenshot
4.4. Site Sub-Sub-Section Page (R&D | Cardiovascular | Development Candidates) screenshot
4.5. Site Detail Page (R&D | Cardiovascular | Development Candidates | MLN519) screenshot
4.6. Home Page screenshot (including Home Page Highlights: links to Press Releases)
4.7. Site Section Page (Media) screenshot
4.8. "Recent Press Releases" Site Sub-Section Page (Media | Press Releases) screenshot
4.9. "Year 2002 Press Releases" Site Sub-Sub-Section Page (Media | Press Releases | 2002) screenshot ("Level 3")
4.10. Full Press Release, Site Detail Page (Media | News | 2002 | 2002-12-16-0) screenshot
4.11. Page Layout 01
4.12. Page Layout 05
4.13. Page Layout 06
4.14. Sitemap
4.15. Usage Terms
4.16. Glossary Popup
4.17. "Leaving" Popup
4.18. Video Choice Popup
4.19. Video Popup
4.20. Career Video (3rd party) Popup
5.1. Content Types CT10 (Press Release), & CT11, CT12, CT14
5.2. Indexing Service: Link to Clinicians Special Documents search
5.3. Indexing Service: Clinicians Special Documents Search Form
5.4. Indexing Service: Clinicians Special Documents Search Results
5.5. Indexing Service: Clinicians Special Documents, Open | Save document
5.6. Indexing Service: Clinicians Special Documents, Open in Wordpad
5.7. Indexing Service: Clinicians Special Documents, Open in MS-Word inside MS-IE
5.8. Indexing Service: Clinicians Special Documents, from Netscape, choose MS-Word
5.9. Indexing Service: Clinicians Special Documents, Search Error
5.10. Indexing Service: Website, Search Error
5.11. Indexing Service: Configure to Index a Web Server
5.12. Indexing Service: Computer Managment Console
5.13. Indexing Service: Query.htm as Default Document

List of Tables

1.1. Tree of (Raw) Content
1.2. Rectangle of Presentable Information
2.1. Press Release Links
2.2. Press Release Links - Revisited, After Edits
3.1. Content Type Candidate: "Resources for Patients"
   Next
   Chapter 1. Introduction