Exporting
From BasKetUsabilityWiki
| Feature Summary | |
|---|---|
| Name: | Exporting |
| Priority: | important |
| Planned for version: | |
| Mentioned in: | Outlining (future scenario) |
| Short summary: | Export the contents of a basket to a file |
| Implementation difficulty: | |
| Notes: | |
The export function is currently used in the outlining future scenario for exporting a ready outline of a longer text to an ODF text document.
Additionally, many users have requested a number of export formats, including ODF, PDF, RTF, Flash, XML, TeX, KDissert.
Some aspects of an export function for BasKet follow. These aspects follow specific needs derived from the scenarios as well as general requirements for an export function.
Contents |
[edit] Definition of export
'Export', as opposed to 'Save', means a lossy transfer of the information contained in a basket into a file of a specific format.
It is lossy because, by definition, the exported file does not exactly correspond to the original data in contents, structure and/or layout.
There can be an option to re-import a document. It can be possible that the structure is recreated when re-importing.
[edit] Partial export of baskets
For each export format, it must be possible to export
- the whole basket, including its sections and pages,
- a whole section of a basket, including its pages,
- a single page in a basket, or
- a single note (e. g., for outlines.
For formats which support a dynamic change of view (like HTML with Javascript), this can be used.
For formats which only support static views, "sections" and "pages" should be transferred accordingly, in a linear way (e. g., for OpenOffice, section titles and pages should be inserted).
The appropriate export function should be available via the respective context menu, for a whole basket in the basket hierarchy, for a section in the section bar, for a page in the page bar or in the empty space of the page, for a single in the note.
[edit] Notes for specific export formats
[edit] ODF text export
For ODF (Open Document Format) text document export, the following aspects are important:
- export document structure: when exporting a basket, sections and pages should be transferred as such; when exporting a section, pages should be transferred as such; and so on.
- no extra layout: as mentioned in the outlining scenario, ODF exported baskets can be used to form the basis for a text. It must be possible to export a basket such that the exported document does not contain any extra layout, but only structural information (like headers, ...).
[edit] HTML export
Two alternatives for export could be supported:
- a dynamic view of the basket, section, page or note using Javascript. Buttons for folding notes and paragraphs, and for switching between baskets, sections and pages should be provided.
- a static view of the basket, section, page or note. Pages in the basket are shown in linear order, like they are structured in the basket.
In both cases, it should be possible to choose a form with minimal layout information, such that it can be included in an existing website using CSS layout.
Structure information (sections, pages, headers) should be exported as far as possible.
[edit] PDF export
Pages in the basket should be shown in linear order, like they are structured in the basket.
URLs should be exported as PDF links, too.
A layout could be choosable, e. g. 'fancy' or 'clean'.
