summaryrefslogtreecommitdiff
path: root/source/text/shared/01/ref_epub_export.xhp
blob: 38f11f8222ca582d3976cb59cd35b2a8ff2b2a92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->

<meta>
  <topic id="textshared01ref_epub_exportxml" indexer="include">
    <title id="tit" xml-lang="en-US">Export as EPUB</title>
    <filename>/text/shared/01/ref_epub_export.xhp</filename>
  </topic>
</meta>

<body>

<section id="epub_export">
<bookmark xml-lang="en-US" branch="index" id="bm_id3149532">
  <bookmark_value>EPUB;export</bookmark_value>
  <bookmark_value>electronic publication</bookmark_value>
  <bookmark_value>exporting;to EPUB</bookmark_value>
</bookmark>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/EpubDialog" id="bm_id1033968" localize="false"/>
<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/@@nowidget@@" id="bm_@@nowidget@@" localize="false"/>

<paragraph id="hd_id3149532" role="heading" level="1" xml-lang="en-US"><variable id="ref_epub_export"><link href="text/shared/01/ref_epub_export.xhp" name="Export as EPUB">Export as EPUB</link></variable></paragraph>
<paragraph id="par_id3154044" role="paragraph" xml-lang="en-US">Export the current file to <link href="text/shared/00/00000002.xhp#epub" name="epub">EPUB</link>.</paragraph>
<paragraph role="paragraph" id="par_id701525003241759" xml-lang="en-US" localize="false"><embedvar href="text/shared/00/00000002.xhp#epubv" markup="keep"/></paragraph>
</section>

<section id="howtoget">
    <embed href="text/shared/00/00000401.xhp#epub01"/>
</section>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/generalft" id="bm_id1033966" localize="false"/>
<paragraph id="par_id19921" role="paragraph"><image id="img_id22170" src="media/screenshots/modules/swriter/ui/exportepub/EPubDialog.png" localize="true" width="664px"  height="482px"><alt id="alt_id59843">EPUB dialog box</alt></image></paragraph>

<paragraph id="hd_id3148519" role="heading" level="2" xml-lang="en-US">General</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/versionlb" id="bm_id1033967" localize="false"/>
<paragraph id="hd_id3148520" role="heading" level="3" xml-lang="en-US">Version</paragraph>
<paragraph id="par_id3154230" role="paragraph" xml-lang="en-US">Sets the version of the resulting EPUB file.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/splitlb" id="bm_id1033968" localize="false"/>
<paragraph id="hd_id3148521" role="heading" level="3" xml-lang="en-US">Split method</paragraph>
<paragraph id="par_id3154231" role="paragraph" xml-lang="en-US">Select the type of start of the next EPUB section.</paragraph>
    <list type="unordered">
        <listitem>
            <paragraph id="par_id751525007405690"  role="listitem" xml-lang="en-US"><emph>Heading</emph>: Starts the next section on headings, according to the document outline numbering.</paragraph>
        </listitem>
        <listitem>
            <paragraph id="par_id971525007425252"  role="listitem" xml-lang="en-US"><emph>Page break</emph>: Starts the new section on a page break.</paragraph>
        </listitem>
    </list>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/splitlb" id="bm_id1033969" localize="false"/>
<paragraph id="hd_id3148522" role="heading" level="3" xml-lang="en-US">Layout method</paragraph>
<paragraph id="par_id3154232" role="paragraph" xml-lang="en-US">Determines if a reflowable or a fixed layout EPUB will be generated.</paragraph>
<list type="unordered">
    <listitem>
        <paragraph id="par_id51525006930128"  role="listitem" xml-lang="en-US"><emph>Reflowable</emph>: The content flows, or reflows, to fit the screen and to fit the needs of the user. This also means that page style information (for example page size or header/footer content) is not exported.</paragraph>
    </listitem>
    <listitem>
        <paragraph id="par_id861525007152589"  role="listitem" xml-lang="en-US"><emph>Fixed</emph>: Gives greater control over presentation when a reflowable EPUB is not suitable for the content.</paragraph>
    </listitem>
</list>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/coverpath" id="bm_id1033970" localize="false"/>
<paragraph id="hd_id3148523" role="heading" level="3" xml-lang="en-US">Custom cover image</paragraph>
<paragraph id="par_id3154233" role="paragraph" xml-lang="en-US">Enter the full path of the custom cover image file.  If the entry is empty, the exporter takes the cover image in the media directory (see below) when the name is one of the following: <item type="literal">cover.gif</item>, <item type="literal">cover.jpg</item>, <item type="literal">cover.png</item> or <item type="literal">cover.svg</item>.</paragraph>
<paragraph xml-lang="en-US" id="par_id601525022680859" role="note">The custom cover image is embedded in the EPUB file.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/mediadir" id="bm_id1033971" localize="false"/>
<paragraph id="hd_id3148524" role="heading" level="3" xml-lang="en-US">Custom media directory</paragraph>

<paragraph id="par_id3154234" role="paragraph" xml-lang="en-US">Enter the custom media directory for the EPUB file. The media directory may contain a cover image as seen above, custom metadata and image links.</paragraph>

<paragraph role="paragraph" id="par_id651525022578455" xml-lang="en-US">By default, the exporter looks for custom media and custom metadata in the current document directory inside a folder with the same name of the document file name. For example, if the document name is <item type="literal">MyText.odt</item>, the default media folder for cover and metadata is <item type="literal">MyText</item> in the current directory. </paragraph>

<paragraph role="paragraph" id="par_id971525023515891" xml-lang="en-US">For custom metadata, you must provide a file with same name as the original filename and with extension as ".xmp". The provided metadata will override the the internal document metadata. In the example above, the custom metadata must exist in the MyText directory as <item type="literal">MyText.xmp</item>.</paragraph>

<paragraph role="paragraph" id="par_id901525027635882" xml-lang="en-US">Image links mean that if you create relative links on images or text and they link an image that's available in the media directory, then this media will be available in the EPUB export result as a popup.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/metadataft" id="bm_id1033972" localize="false"/>
<paragraph id="hd_id3148525" role="heading" level="2" xml-lang="en-US">Metadata</paragraph>
<paragraph id="par_id3154236" role="paragraph" xml-lang="en-US">Enter the custom metadata to override the document default metadata. These text fields can be left empty.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/identifier" id="bm_id1033973" localize="false"/>
<paragraph id="hd_id3148526" role="heading" level="3" xml-lang="en-US">Identifier</paragraph>
<paragraph id="par_id3154237" role="paragraph" xml-lang="en-US">Enter an unique identifier for the publication.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/title" id="bm_id1033974" localize="false"/>
<paragraph id="hd_id3148527" role="heading" level="3" xml-lang="en-US">Title</paragraph>
<paragraph id="par_id3154238" role="paragraph" xml-lang="en-US">Enter the title of the publication.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/author" id="bm_id1033975" localize="false"/>
<paragraph id="hd_id3148528" role="heading" level="3" xml-lang="en-US">Author</paragraph>
<paragraph id="par_id3154239" role="paragraph" xml-lang="en-US">Enter the Author of the publication.</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/language" id="bm_id1033976" localize="false"/>
<paragraph id="hd_id3148529" role="heading" level="3" xml-lang="en-US">Language</paragraph>
<paragraph id="par_id3154240" role="paragraph" xml-lang="en-US">Language of the publication (see RFC4646 and ISO 639 for possible values).</paragraph>

<bookmark xml-lang="en-US" branch="hid/writerperfect/ui/exportepub/date" id="bm_id1033977" localize="false"/>
<paragraph id="hd_id3148530" role="heading" level="3" xml-lang="en-US">Date</paragraph>
<paragraph id="par_id3154241" role="paragraph" xml-lang="en-US">Last modification date for the publication. The value of this property must be an XML Schema dateTime conformant date in the form: CCYY-MM-DDThh:mm:ssZ. Default is the date and time when the export dialog opened.</paragraph>

</body>
</helpdocument>