wicentowski - xml for the rest of us
TRANSCRIPT
![Page 1: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/1.jpg)
The Office of the Historian’s Move to an
Open Source XML Platform
for Digital Publishing
Joseph Wicentowski, [email protected]
![Page 2: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/2.jpg)
The Office of the Historian is…
An Office in the U.S. Department of State’s Bureau of Public Affairs
Dates back to the administration of Abraham Lincoln
Staffed by 40+ professional historians, based in Washington, D.C.
![Page 3: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/3.jpg)
Foreign Relations of the United States (FRUS)
![Page 4: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/4.jpg)
Before: Our Online Publications, 1996-2009
![Page 5: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/5.jpg)
Initial Core Goals
1. Break through the barriers that our existing content management system placed on getting our publications online
2. Improve the user experience, including a better search engine
![Page 6: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/6.jpg)
Revised Goals (To really do it right, let’s…)
1. Make the right decisions now to minimize cost of change in the future
2. Avoid proprietary technologies and device-specific formats. Go for open and archivally sound.
3. Remain tolerant of idiosyncracies, while embracing standards
4. Build on the best editorial traditions to deliver better reading and research
![Page 7: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/7.jpg)
Enhance glossaries
![Page 8: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/8.jpg)
Document Body: Shows relevant glossary entries
![Page 9: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/9.jpg)
Mouse over a name to expand glossary entry
![Page 10: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/10.jpg)
Improve the online footnoteFootnotes in
Footnotes online
![Page 11: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/11.jpg)
Hover over footnote reference to view inline
Footnotes in Print
Footnotes online
![Page 12: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/12.jpg)
Building on traditions…
5. Enhance body content with reference content, such as glossaries
6. Improve the online footnote
7. Respect the integrity of the print publication even while delivering a great web experience
8. Commit to consistent URLs
9. Provide complete citations on every view
10.Data visualization? – dynamic timelines and maps?
![Page 13: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/13.jpg)
Data visualization – dynamic timelines, maps
![Page 14: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/14.jpg)
Ambitious Goals!What format would allow us to achieve
them?1. Break through the barriers that our existing content management
system placed on getting our publications online
2. Improve the user experience, including a better search engine
3. Make the right decisions now to minimize cost of change in the future
4. Avoid proprietary technologies and device-specific formats. Go for open and archivally sound.
5. Remain tolerant of idiosyncrasies, while embracing standards
6. Build on the best editorial traditions to deliver better reading and research
7. Enhance body content with reference content, such as glossaries
8. Improve the online footnote
9. Respect the integrity of the print publication even while delivering a great web experience
10.Commit to consistent URLs
11.Provide complete citations on every view
12.Data visualization? – dynamic timelines and maps?
![Page 15: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/15.jpg)
XML!
![Page 16: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/16.jpg)
XML!(umm… now
what?)
![Page 17: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/17.jpg)
We decided we needed to go XML… What next?
1. Decide: which kind of XML?
2. How to get content into XML?
3. Software/platforms for XML solution?
… we researched flavors of XML… we reviewed our own content … we prototyped… we developed encoding guidelines… we found conversion/encoding vendors… we researched XML platforms… we programmed, tested
![Page 18: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/18.jpg)
history.state.gov (b. 2009)
![Page 19: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/19.jpg)
We knew we needed XML… Our own answers
1. Which kind of XML?… TEI (Text Encoding Initiative)
2. How to get content into XML?
… Outsource to encoding vendor… Our very paper-based source
material led us to minimize impact on existing editorial workflow for new publications
… Work with compositor to deliver XML
… Gradually move into comprehensive XML-based editorial workflow
3. Software/platforms for XML solution?
![Page 20: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/20.jpg)
An Open Platform for XML Publishing
1. eXist … free, open source native XML
database… fast fulltext search engine + web
server… active community… runs on Macs, PCs, Linux
2. oXygen… commercial XML editor… swiss army knife of XML
development
3. XQuery… programming language for querying
and manipulating XML… some prefer XSLT for transforming
XML, but XQuery does it all
![Page 21: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/21.jpg)
Agility with XML: Adapting to Unforeseen Requirements
1. E-Readers and new formats like ePub… evolving formats
2. Open Government Directive and data.gov
… native XML databases as a strength in an era of government transparency
3. Need to let our staff edit and annotate their TEI content in the browser
… Making use of XForms and CKEditor
![Page 22: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/22.jpg)
E-Readers and the ePub format
• Digital Books (ePub)
• Print, Print on Demand
From a single digital master file (an XML file) we can publish in many formats…
• tomorrow’s format?
• Online search & browsing
![Page 23: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/23.jpg)
data.gov and the Open Government Initiative
Wired Magazine, May 19, 2010 , http://www.wired.com/epicenter/2010/05/sneak-peek-the-obama-administrations-redesigned-datagov/
![Page 24: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/24.jpg)
TEI Annotator: Editing XML in the Browser
![Page 25: Wicentowski - XML for the Rest of Us](https://reader036.vdocuments.mx/reader036/viewer/2022081404/5584c457d8b42af1138b469c/html5/thumbnails/25.jpg)
Win-Wins of an Open Platform
1. Open standards
2. Open source
3. Active, responsive, generous community
4. Contribute back to the community: patches, enhancements, and articles