EPUB meta data editor 3rd draft (initial help content)

git-svn-id: svn://svn.code.sf.net/p/writer2latex/code/trunk@93 f0f2a975-2e09-46c8-9428-3b39399b9f3c
This commit is contained in:
henrikjust 2011-02-23 13:38:05 +00:00
parent 3dd2833a4e
commit 4fc6052426
4 changed files with 120 additions and 86 deletions

View file

@ -62,7 +62,7 @@
<dlg:textfield dlg:id="Rights" dlg:tab-index="28" dlg:left="245" dlg:top="166" dlg:width="105" dlg:height="12"/>
<dlg:button dlg:id="OKButton" dlg:tab-index="36" dlg:left="10" dlg:top="195" dlg:width="50" dlg:height="12" dlg:value="OK" dlg:button-type="ok"/>
<dlg:button dlg:id="CancelButton" dlg:tab-index="37" dlg:left="65" dlg:top="195" dlg:width="50" dlg:height="12" dlg:value="Cancel" dlg:button-type="cancel"/>
<dlg:button dlg:id="HelpButton" dlg:tab-index="38" dlg:left="300" dlg:top="195" dlg:width="50" dlg:height="12" dlg:value="Help"/>
<dlg:button dlg:id="HelpButton" dlg:tab-index="38" dlg:left="300" dlg:top="195" dlg:width="50" dlg:height="12" dlg:help-url="org.openoffice.da.writer2xhtml.oxt:EpubMetadata" dlg:value="Help" dlg:button-type="help"/>
<dlg:fixedline dlg:id="FixedLine1" dlg:tab-index="39" dlg:left="180" dlg:top="9" dlg:width="1" dlg:height="170" dlg:align="vertical"/>
<dlg:text dlg:id="TitleLabel" dlg:tab-index="40" dlg:left="190" dlg:top="8" dlg:width="50" dlg:height="12" dlg:value="Title"/>
<dlg:textfield dlg:id="Title" dlg:tab-index="18" dlg:left="245" dlg:top="6" dlg:width="105" dlg:height="12"/>

View file

@ -5,6 +5,7 @@
<topic id="writer2xhtml/org.openoffice.da.writer2xhtml.oxt/export.xhp">XHTML Export (Writer)</topic>
<topic id="writer2xhtml/org.openoffice.da.writer2xhtml.oxt/export_calc.xhp">XHTML Export (Calc)</topic>
<topic id="writer2xhtml/org.openoffice.da.writer2xhtml.oxt/epub_export.xhp">EPUB Export (Writer)</topic>
<topic id="writer2xhtml/org.openoffice.da.writer2xhtml.oxt/epub_metadata.xhp">EPUB document properties (Writer)</topic>
<node id="w2l0x_configuration" title="Custom style">
<topic id="writer2latex/org.openoffice.da.writer2xhtml.oxt/Configuration/Introduction.xhp">Introduction</topic>
<topic id="writer2latex/org.openoffice.da.writer2xhtml.oxt/Configuration/General.xhp">General</topic>

View file

@ -193,91 +193,6 @@
<paragraph role="paragraph" xml-lang="en-US">Your document may also include a normal table of contents.
Check this if you want to include this table of contents in addition to the navigation table.</paragraph>
<paragraph role="heading" level="2" id="custommetadata" xml-lang="en-US">EPUB meta data</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The EPUB standard specifies a number of meta data elements not supported by ODF.
Writer2xhtml supports these elements using user-defined meta data. To add user-defined meta data choose
<emph>File-Properties</emph>, <emph>User-defined properties</emph>. The following properties are supported:</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Identifier</emph>: Each EPUB document must have a unique ID.
Normally Writer2xhtml generates a Universal Unique ID (UUID) for this purpose, but you may override this with
your own ID.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">To do this add a new property, enter <emph>Identifier</emph>
(case is not important) as name and the ID as value.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">An identifier may follow a specific identification scheme, e.g. ISBN.
To specify an identification scheme, append this to the name separated by a period, e.g. <emph>Identifier.ISBN</emph>.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">It is possible to have several identifiers, in this case append a number
to the name, e.g. <emph>Identifier1.ISBN</emph> and <emph>Identifier2</emph>. The first identifier is used as the unique ID.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Creator</emph>: A primary creator or author of the publication.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Enter <emph>Creator</emph> as name and the creator's name as value.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">A creator may have a special role, you can specify this with a three
letter code after the word creator, e.g. <emph>creator.aut</emph> for the author or <emph>creator.ill</emph>
for the illustrator. For the complete list of three letter codes see the
<link href="http://www.idpf.org/2007/opf/OPF_2.0_final_spec.html" name="Link to the EPUB specification">EPUB specification</link>.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You can define several creators, in this case add a number to the word creator,
e.g. <emph>creator1.aut</emph> and <emph>creator2</emph>. The creators will be sorted according to the numbers.
Note that some readers may only present the first creator.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Contributor</emph>: A party whose contribution to the publication is secondary
to those named in creator elements. Otherwise it is handled like Creator, and the same rules apply.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Date</emph>: Date of publication. The date must be in the format YYYY-MM-DD
(year-month-date) or more generally in the format specified in
<link href="http://www.w3.org/TR/NOTE-datetime" name="Link to datetime specification">http://www.w3.org/TR/NOTE-datetime</link>.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">A date may be associated with a special event such as creation,
publication or modification. To define this, add the event after the word date, e.g. <emph>date.publication</emph>.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You can give several dates, in this case add a number to the word date,
e.g. <emph>date1.creation</emph>, <emph>date2.modification</emph>.
</paragraph>
</listitem>
</list>
<paragraph role="paragraph" xml-lang="en-US">You can only have one instance of the remaining properties,
hence they cannot be numbered. Also no additional data can be appended to the name.
</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Publisher</emph>: The publisher of the document.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Type</emph>: Terms describing general categories, functions, genres, or aggregation levels for content.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Format</emph>: The media type or dimensions of the resource.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Source</emph>: Information regarding a prior resource from which the publication was derived.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Relation</emph>: An identifier of an auxiliary resource and its relationship to the publication.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Coverage</emph>: The extent or scope of the publications content.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Rights</emph>: A statement about rights, or a reference to one.
</paragraph>
</listitem>
</list>
</body>
</helpdocument>

View file

@ -0,0 +1,118 @@
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<meta>
<topic id="writer2xhtml-epub-metadata" indexer="include">
<title xml-lang="en-US">EPUB document properties (Writer)</title>
<filename>org.openoffice.da.writer2xhtml.oxt/epub_metadata.xhp</filename>
</topic>
</meta>
<body>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2xhtml.oxt:EpubMetadata" id="bm_metadata"/>
<paragraph role="heading" level="1" xml-lang="en-US">EPUB document properties (Writer)</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Edit the document properties for an EPUB document.</paragraph>
<section id="howtoget" xml-lang="en-US">
Choose <emph>File - Export - EPUB, Click Edit in the dialog</emph>
</section>
<paragraph role="paragraph" xml-lang="en-US">The EPUB standard specifies a large number of document properties.
Not all of these are supported by the OpenDocument standard.
Writer2xhtml supports the additional properties using user defined document properties.
This dialog provides a convenient interface to edit all EPUB document properties, but you can also access all properties
using the standard interface in %PRODUCTNAME Writer, that is <emph>File - Properties</emph>.
Properties that are not required can be left blank. In this case they will not be included in the EPUB document (except the
title which is always included).</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Custom identifier</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Each EPUB document must have a unique identifier.
Normally Writer2xhtml generates a Universal Unique ID (UUID) for this purpose, but you may override this with
your own identifier.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Use custom identifier</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Check this if you want to provide your own identifier</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Identifier</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Enter the identifier to use. Remember that it must be unique amongst all
EPUB documents.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Identifier type</paragraph>
<paragraph role="paragraph" xml-lang="en-US">An identifier may follow a specific identification scheme, e.g. ISBN.
Select or enter an identification scheme in this field.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Authors</paragraph>
<paragraph role="paragraph" xml-lang="en-US">An EPUB document can have several authors, which you can list here.
An author can be either a <emph>creator</emph>, that is a primary author of the publication, or a <emph>contributor</emph>,
that is a party whose contribution to the publication is secondary to the creator(s).
Furthermore an author may have a special role, e.g. <emph>illustrator</emph>. Both properties are specified when you add
a new authort to the list.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Note that some EPUB readers may only present the first creator, hence
the order may be important</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Add...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to add new author to the list.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Modify...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to modify the currently selected author.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Delete...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to delete the currently selected author from the list.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Up</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to move the currently selected author up one position in the list.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Down</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to move the currently selected author down one position in the list.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Dates</paragraph>
<paragraph role="paragraph" xml-lang="en-US">An EPUB document can specify one or more dates relating to the publication.
Each date can be associated with a special event such as creation, publication or modification.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Add...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to add new date to the list.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Modify...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to modify the currently selected date.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Delete...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Click this to delete the currently selected date from the list.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Title</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The title of the document. This will always be included in the EPUB document,
even if you have not selected <emph>Export optional document properties.</emph></paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Subject</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The subject of the document</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Keywords</paragraph>
<paragraph role="paragraph" xml-lang="en-US">A comma separated list of keywords</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Description</paragraph>
<paragraph role="paragraph" xml-lang="en-US">A description of the document</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Publisher</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The publisher of the document.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Type</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Terms describing general categories, functions, genres, or aggregation levels
for content.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Format</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The media type or dimensions of the resource.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Source</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Information regarding a prior resource from which the publication was derived.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Relation</paragraph>
<paragraph role="paragraph" xml-lang="en-US">An identifier of an auxiliary resource and its relationship to the publication.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Coverage</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The extent or scope of the publications content.</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Rights</paragraph>
<paragraph role="paragraph" xml-lang="en-US">A statement about rights, or a reference to one.</paragraph>
</body>
</helpdocument>