Difference between revisions of "OpenOffice.org Internship/Projects/2010/Customizable html export for Impress"
From Apache OpenOffice Wiki
(initial setup) |
|||
| Line 1: | Line 1: | ||
| + | |||
| + | __TOC__ | ||
| + | |||
| + | == Overview == | ||
| + | The current html export for OOo impress and draw application produces outdated html. The goal of this internship project is to create a new html export extension that will replace the currently available html export in impress and draw. The extension should make use of modern html elements including css and javascript and support a template system so that non coders are able to alter the results of the generated html output. | ||
| + | |||
| + | == Goals/Requirements == | ||
| + | |||
| + | * An OOo extension that exports a set of files that make the current presentation document (or draw) viewable in any current browser | ||
| + | * The extension must include a settings dialog to configure the output during export | ||
| + | * The extension must support templates, a template will define the visual style and the user interaction elements like navigation buttons or table of contents etc. | ||
| + | * Template must not be 'hard coded' in the extension so adding more templates is possible without changing and compiling source code. | ||
| + | * The extension must include 2-3 sample templates that are both "user friendly" and "visual appealing“ | ||
| + | * The extension must support the key features from the old HTML export (export of links, adding additional information like creator, email, automatic slide advances, etc) | ||
| + | * The extension must be able to also export selected text from the presentation like title, outline and subtitle text. This is mainly an accessibility feature to enable visually impaired users to read | ||
| + | the contents of the exported presentation. | ||
| + | * Export should an alternative text only view or a text overlay to support accessibility. | ||
| + | * There should be no connection to the installed OpenOffice or any extensions, the files we put in the export directory must include everything needed. | ||
| + | * The generated html file should be as simple as possible. All functionality should come from the template. Goal is to make developing, modifying templates easier for the user, not for us. | ||
| + | * Templates should not make use of any javascript library to avoid conflicts with web pages where other versions of this library are used or incompatible other libraries are used. | ||
| + | * All important configuration should be done during export. | ||
| + | * Easy integration in existing web pages | ||
| + | * The created output should provide a fall-back if javascript is disabled in the browser. | ||
| + | * The templates used by the extension should be made installable via extensions themselves so others can contribute templates too. | ||
| + | * Implement a powerful easy to use and easy to develop template system. | ||
| + | |||
| + | ==Project plan== | ||
| + | |||
| + | * Develop a prototype template -- ''In progress'' | ||
| + | * Define format of html output created by the extension -- ''In progress'' | ||
| + | * Implement the extension with basic export | ||
| + | * Implement the templates system with configuration/extension deployment support | ||
| + | * Specify configuration dialog | ||
| + | * Implement configuration dialog | ||
| + | |||
| + | ===Enhancements=== | ||
| + | |||
| + | ===Documentation=== | ||
| + | |||
| + | ==Project status== | ||
| + | *The project is accepted for the OpenOffice summer internship program 2010 | ||
| + | |||
[[Category:Marketing]][[Category:Development]] | [[Category:Marketing]][[Category:Development]] | ||
{{DISPLAYTITLE:Internship 2010: Customizable html export for Impress}} | {{DISPLAYTITLE:Internship 2010: Customizable html export for Impress}} | ||
Revision as of 10:08, 28 July 2010
Contents
Overview
The current html export for OOo impress and draw application produces outdated html. The goal of this internship project is to create a new html export extension that will replace the currently available html export in impress and draw. The extension should make use of modern html elements including css and javascript and support a template system so that non coders are able to alter the results of the generated html output.
Goals/Requirements
- An OOo extension that exports a set of files that make the current presentation document (or draw) viewable in any current browser
- The extension must include a settings dialog to configure the output during export
- The extension must support templates, a template will define the visual style and the user interaction elements like navigation buttons or table of contents etc.
- Template must not be 'hard coded' in the extension so adding more templates is possible without changing and compiling source code.
- The extension must include 2-3 sample templates that are both "user friendly" and "visual appealing“
- The extension must support the key features from the old HTML export (export of links, adding additional information like creator, email, automatic slide advances, etc)
- The extension must be able to also export selected text from the presentation like title, outline and subtitle text. This is mainly an accessibility feature to enable visually impaired users to read
the contents of the exported presentation.
- Export should an alternative text only view or a text overlay to support accessibility.
- There should be no connection to the installed OpenOffice or any extensions, the files we put in the export directory must include everything needed.
- The generated html file should be as simple as possible. All functionality should come from the template. Goal is to make developing, modifying templates easier for the user, not for us.
- Templates should not make use of any javascript library to avoid conflicts with web pages where other versions of this library are used or incompatible other libraries are used.
- All important configuration should be done during export.
- Easy integration in existing web pages
- The created output should provide a fall-back if javascript is disabled in the browser.
- The templates used by the extension should be made installable via extensions themselves so others can contribute templates too.
- Implement a powerful easy to use and easy to develop template system.
Project plan
- Develop a prototype template -- In progress
- Define format of html output created by the extension -- In progress
- Implement the extension with basic export
- Implement the templates system with configuration/extension deployment support
- Specify configuration dialog
- Implement configuration dialog
Enhancements
Documentation
Project status
- The project is accepted for the OpenOffice summer internship program 2010
