├── .gitignore ├── sample ├── sample.epub └── sample.org ├── ISSUE_TEMPLATE.md ├── .travis.yml ├── README.org ├── CODE_OF_CONDUCT.md ├── ox-epub.el └── COPYING /.gitignore: -------------------------------------------------------------------------------- 1 | /test.el 2 | -------------------------------------------------------------------------------- /sample/sample.epub: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ofosos/ox-epub/HEAD/sample/sample.epub -------------------------------------------------------------------------------- /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | org version: 5 | emacs version: 6 | platform: 7 | installed via: 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: generic 2 | sudo: false 3 | before_install: 4 | - curl -fsSkL https://gist.github.com/rejeep/ebcd57c3af83b049833b/raw > x.sh && source ./x.sh 5 | - evm install $EVM_EMACS --use --skip 6 | dist: trusty 7 | env: 8 | - EVM_EMACS=emacs-24.3-travis 9 | - EVM_EMACS=emacs-24.4-travis 10 | - EVM_EMACS=emacs-24.5-travis 11 | - EVM_EMACS=emacs-25.1-travis 12 | - EVM_EMACS=emacs-25.2-travis 13 | - EVM_EMACS=emacs-25.3-travis 14 | - EVM_EMACS=emacs-26.2-travis 15 | script: 16 | - git clone --depth 1 https://code.orgmode.org/bzg/org-mode.git 17 | - (cd org-mode && make autoloads) 18 | - emacs --version 19 | - emacs -q -no-site-file -no-init-file --eval "(add-to-list 'load-path \"./org-mode/lisp\")" --eval "(require 'org)" -batch -f batch-byte-compile ox-epub.el 20 | - rm ox-epub.elc 21 | -------------------------------------------------------------------------------- /sample/sample.org: -------------------------------------------------------------------------------- 1 | #+TITLE: ox-epub Sample document 2 | #+UID: http://ofosos.org/epub/sample.org 3 | #+DATE: 2017-12-02 4 | #+AUTHOR: Mark Meyer 5 | #+OPTIONS: tex:dvipng 6 | 7 | # The code snippet below requires htmlize! 8 | 9 | * Text 10 | 11 | He felt deeply sorry for getting up. Waddling in his self pity he 12 | poured coffee into the filter, then paused for the water to heat 13 | up. His eyes were half closed. He felt nothing, besides the ugly 14 | morning suffocating his consciousness. 15 | 16 | He came to his senses slowly. When he was ready to depart from his 17 | flat, he packed an umbrella and a jacket, preparing for the 18 | rain. Technically it was summer, but it had been raining every day for 19 | the last 5 weeks. The farmers wouldn't be happy about this 20 | summer. Agriculture was unpredictable and this summer would turn out 21 | in a way, that nobody would have wanted to predict anyways. 22 | 23 | He made his way to the Y-intersection, slowly moving in the direction 24 | of the subway station, that would take him to work on an ordinary 25 | day. Suffice it to say, that the day he entered the newspapers would 26 | not be an ordinary day. At least not for him. 27 | 28 | 160 words. 29 | 30 | * A Table 31 | 32 | This is a simple data table: 33 | 34 | #+CAPTION: This is a table 35 | #+NAME: fig:some-table 36 | | foo | bar | baz | quux | quix | 37 | |-----+-----+-----+------+------| 38 | | 13 | 7 | 5 | 3 | 1 | 39 | | 1 | 3 | 5 | 7 | 13 | 40 | 41 | * An Image 42 | 43 | #+CAPTION: This is the org-mode logo 44 | #+NAME: fig:unicorn 45 | [[./org-mode-unicorn-logo.png]] 46 | 47 | * Some Code 48 | 49 | # This requires htmlize 50 | 51 | #+BEGIN_SRC emacs-lisp 52 | (defun org-xor (a b) 53 | "Exclusive or." 54 | (if a (not b) b)) 55 | #+END_SRC 56 | 57 | * Some Math 58 | 59 | \begin{equation} 60 | x=\sqrt{b} 61 | \end{equation} 62 | 63 | If $a^2=b$ and \( b=2 \), then the solution must be 64 | either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \]. 65 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | [[https://travis-ci.org/ofosos/ox-epub.svg?branch=master]] 2 | [[http://stable.melpa.org/packages/ox-epub-badge.svg]] 3 | 4 | 5 | * ox-epub 6 | 7 | Generate =.epub= files directly from OrgMode. This will export EPUB 8 | version 2, which should give broad compatibility. It should also be 9 | relatiely easy to convert the resulting =.epub= to a =.mobi= (Kindle). 10 | 11 | ** Prerequisites 12 | 13 | This depends on Emacs 24.3 and OrgMode 9, it won't work on OrgMode 8 or 14 | any version of Emacs before 24.3. 15 | 16 | You will also need a working version of the =zip= utility. 17 | 18 | ** Installation 19 | 20 | If you have MELPA stable activated, it is as simple as this: 21 | 22 | =M-x package-install RET ox-epub RET= 23 | 24 | ** Usage 25 | 26 | See the =sample= directory for a sample of what ox-epub can do. 27 | 28 | Hit =C-c C-e E e= to publish the current buffer to an EPUB. 29 | 30 | There are some required export options that need to be set. These are 31 | 32 | - =UID= a unique id of the document, otherwise known as uri, may be a url 33 | - =DATE= the date of the document, for valid values see 34 | [[https://www.w3.org/TR/NOTE-datetime]] 35 | - =AUTHOR= the document author or editor, the creator in the EPUB spec 36 | - =TITLE= the document title 37 | 38 | Furthermore there are some properties which are optional: 39 | 40 | - =Subject= the subject matter of the book 41 | - =Description= a description of the book 42 | - =Publisher= the publisher of the book 43 | - =License= the rights associated with this book, the copyright 44 | notice and further rights may be included in this option. 45 | - =EPUBCOVER= the cover image to use for the export 46 | - =EPUBSTYLE= the CSS file to use for the export, this is set by default 47 | but can be set on a per document basis 48 | 49 | The only other option that is exported: 50 | 51 | - =LANGUAGE= the language of the book, this is to be interpreted 52 | according to RFC3066 or it's succeeding documents 53 | [[https://www.ietf.org/rfc/rfc3066.txt]], no other interpretations are 54 | allowed according to the EPUB spec. 55 | 56 | ** Features 57 | 58 | Currently =ox-epub= can do the following: 59 | 60 | - simple cover images 61 | - inclusion of png and jpg images 62 | - export of mathematical formulas 63 | - direct =.epub= generation 64 | - add stylesheets to your liking: Use the EPUBSTYLE property to add a 65 | list of stylesheets and customize =html-head-include-default-style= 66 | to toggle inclusion of the default stylesheet. 67 | 68 | ** Caveats 69 | 70 | - Mathematical formulas only export well if you use the =dvipng= 71 | backend. =dvipng= should be included in TeXlive. 72 | 73 | ** Coffee 74 | 75 | I very much like coffee, so if you want to contribute to my coffee fund, 76 | you can now do that :) 77 | 78 | [[https://www.buymeacoffee.com/markZb][https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png]] 79 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | education, socio-economic status, nationality, personal appearance, race, 10 | religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at mark@ofosos.org. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | -------------------------------------------------------------------------------- /ox-epub.el: -------------------------------------------------------------------------------- 1 | ;;; ox-epub.el --- Export org mode projects to EPUB -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (c) 2017-2018 - Mark Meyer 4 | 5 | ;; Author: Mark Meyer 6 | ;; Maintainer: Mark Meyer 7 | 8 | ;; URL: http://github.com/ofosos/org-epub 9 | ;; Keywords: hypermedia 10 | 11 | ;; Version: 0.1.0 12 | 13 | ;; Package-Requires: ((emacs "24.3") (org "9")) 14 | 15 | ;; This program is free software; you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | 20 | ;; This program is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with this program. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;; This is an addition to the standard org-mode exporters. The package 31 | ;; extends the (X)HTML exporter to produce EPUB files. It eliminates 32 | ;; all inline CSS and JavaScript to accomplish this. This exporter 33 | ;; will also tie the XHTML DTD to XHTML 1.1, a concrete DTD specifier 34 | ;; that was not supported by ox-html previously. 35 | 36 | ;; The main part is the generation of the table of contents in machine 37 | ;; readable form, as well as the spine, which defines the order in 38 | ;; which files are presented. A lesser part is the inclusion of 39 | ;; various metadata properties, among them authorship and rights. 40 | 41 | ;;; Code: 42 | 43 | (require 'cl-lib) 44 | (require 'ox-publish) 45 | (require 'ox-html) 46 | (require 'org-element) 47 | 48 | (org-export-define-derived-backend 'epub 'html 49 | :options-alist 50 | '((:epub-uid "UID" nil nil t) 51 | (:epub-subject "Subject" nil nil t) 52 | (:epub-description "Description" nil nil t) 53 | (:epub-publisher "Publisher" nil nil t) 54 | (:epub-rights "License" nil nil t) 55 | (:epub-style "EPUBSTYLE" nil nil t) 56 | (:epub-cover "EPUBCOVER" nil nil t) 57 | (:html-doctype "HTML_DOCTYPE" nil "xhtml" t)) 58 | 59 | :translate-alist 60 | '((template . org-epub-template) 61 | (link . org-epub-link) 62 | (latex-environment . org-epub--latex-environment) 63 | (latex-fragment . org-epub--latex-fragment)) 64 | :menu-entry 65 | '(?E "Export to Epub" 66 | ((?e "As Epub file" org-epub-export-to-epub) 67 | (?O "As Epub file and open" 68 | (lambda (a s v b) 69 | (if a (org-epub-export-to-epub t s v) 70 | (org-open-file (org-epub-export-to-epub nil s v) 'system))))))) 71 | 72 | (defvar org-epub-zip-dir nil 73 | "The temporary directory to export to") 74 | 75 | (defvar org-epub-style-default " 76 | .title { text-align: center; 77 | margin-bottom: .2em; } 78 | .subtitle { text-align: center; 79 | font-size: medium; 80 | font-weight: bold; 81 | margin-top:0; } 82 | .todo { font-family: monospace; color: red; } 83 | .done { font-family: monospace; color: green; } 84 | .priority { font-family: monospace; color: orange; } 85 | .tag { background-color: #eee; font-family: monospace; 86 | padding: 2px; font-size: 80%; font-weight: normal; } 87 | .timestamp { color: #bebebe; } 88 | .timestamp-kwd { color: #5f9ea0; } 89 | .org-right { margin-left: auto; margin-right: 0px; text-align: right; } 90 | .org-left { margin-left: 0px; margin-right: auto; text-align: left; } 91 | .org-center { margin-left: auto; margin-right: auto; text-align: center; } 92 | .underline { text-decoration: underline; } 93 | #postamble p, #preamble p { font-size: 90%; margin: .2em; } 94 | p.verse { margin-left: 3%; } 95 | pre { 96 | border: 1px solid #ccc; 97 | box-shadow: 3px 3px 3px #eee; 98 | padding: 8pt; 99 | font-family: monospace; 100 | overflow: auto; 101 | margin: 1.2em; 102 | } 103 | pre.src { 104 | position: relative; 105 | overflow: visible; 106 | padding-top: 1.2em; 107 | } 108 | 109 | table { border-collapse:collapse; } 110 | caption.t-above { caption-side: top; } 111 | caption.t-bottom { caption-side: bottom; } 112 | td, th { vertical-align:top; } 113 | th.org-right { text-align: center; } 114 | th.org-left { text-align: center; } 115 | th.org-center { text-align: center; } 116 | td.org-right { text-align: right; } 117 | td.org-left { text-align: left; } 118 | td.org-center { text-align: center; } 119 | dt { font-weight: bold; } 120 | .footpara { display: inline; } 121 | .footdef { margin-bottom: 1em; } 122 | .figure { padding: 1em; } 123 | .figure p { text-align: center; } 124 | .inlinetask { 125 | padding: 10px; 126 | border: 2px solid gray; 127 | margin: 10px; 128 | background: #ffffcc; 129 | } 130 | #org-div-home-and-up 131 | { text-align: right; font-size: 70%; white-space: nowrap; } 132 | textarea { overflow-x: auto; } 133 | .linenr { font-size: smaller } 134 | .code-highlighted { background-color: #ffff00; } 135 | .org-info-js_info-navigation { border-style: none; } 136 | #org-info-js_console-label 137 | { font-size: 10px; font-weight: bold; white-space: nowrap; } 138 | .org-info-js_search-highlight 139 | { background-color: #ffff00; color: #000000; font-weight: bold; } 140 | .org-svg { width: 90%; } 141 | 142 | " 143 | "Default style declarations for org epub") 144 | 145 | (defvar org-epub-zip-command "zip" 146 | "Command to call to create zip files.") 147 | 148 | (defvar org-epub-zip-no-compress (list "-Xu0") 149 | "Zip command option list to pass for no compression.") 150 | 151 | (defvar org-epub-zip-compress (list "-Xu9") 152 | "Zip command option list to pass for compression.") 153 | 154 | (defvar org-epub-metadata nil 155 | "EPUB export metadata") 156 | 157 | (defvar org-epub-headlines nil 158 | "EPUB headlines") 159 | 160 | (defvar org-epub-style-counter 0 161 | "EPUB style counter") 162 | 163 | ;; manifest mechanism 164 | 165 | (defvar org-epub-manifest nil 166 | "EPUB export manifest") 167 | 168 | (defun org-epub-manifest-entry (id filename type mimetype &optional source) 169 | "Create a manifest entry with the given ID, FILENAME, TYPE, MIMETYPE and optional SOUCE. 170 | 171 | FILENAME should be the new name in the epub container. TYPE 172 | should be one of `'html', `'stylesheet', `'coverimg', `'cover' or 173 | `'img'. If SOURCE is given the file name by SOUCE will be copied 174 | to FILENAME at the end of the export process. " 175 | (list :id id :filename filename :type type :mimetype mimetype :source source)) 176 | 177 | (defun org-epub-cover-p (manifest-entry) 178 | "Determine if MANIFEST-ENTRY is of type cover." 179 | (eq (plist-get manifest-entry :type) 'cover)) 180 | 181 | (defun org-epub-coverimg-p (manifest-entry) 182 | "Determine if MANIFEST-ENTRY is of type cover image." 183 | (eq (plist-get manifest-entry :type) 'coverimg)) 184 | 185 | (defun org-epub-style-p (manifest-entry) 186 | "Determine if MANIFEST-ENTRY is of type stylesheet." 187 | (eq (plist-get manifest-entry :type) 'stylesheet)) 188 | 189 | (defun org-epub-manifest-needcopy (manifest-entry) 190 | "Determine if MANIFEST-ENTRY needs to be copied. 191 | 192 | If it needs to be copied return a pair (sourcefile . targetfile)." 193 | (if (plist-get manifest-entry :source) 194 | (cons (plist-get manifest-entry :source) 195 | (plist-get manifest-entry :filename)) 196 | nil)) 197 | 198 | (defun org-epub-manifest-all (pred) 199 | "Return all manifest entries for which PRED is true." 200 | (cl-remove-if-not pred org-epub-manifest)) 201 | 202 | (cl-defun org-epub-manifest-first (pred) 203 | "Return the first manifest entry for which PRED is true." 204 | (let ((val)) 205 | (dolist (el org-epub-manifest val) 206 | (when (funcall pred el) 207 | (cl-return-from org-epub-manifest-first el))))) 208 | 209 | ;; core 210 | 211 | ;;; Latex Environment - stolen from ox-html 212 | 213 | (defun org-epub--latex-environment (latex-environment _contents info) 214 | "Transcode a LATEX-ENVIRONMENT element from Org to HTML. 215 | CONTENTS is nil. INFO is a plist holding contextual information." 216 | (let ((processing-type (plist-get info :with-latex)) 217 | (latex-frag (org-remove-indentation 218 | (org-element-property :value latex-environment))) 219 | (attributes (org-export-read-attribute :attr_html latex-environment))) 220 | (cond 221 | ((assq processing-type org-preview-latex-process-alist) 222 | (let ((formula-link 223 | (org-html-format-latex latex-frag processing-type info))) 224 | (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link)) 225 | ;; Do not provide a caption or a name to be consistent with 226 | ;; `mathjax' handling. 227 | (org-html--wrap-image 228 | (org-html--format-image 229 | (let* ((path (match-string 1 formula-link)) 230 | (ref (org-export-get-reference latex-environment info)) 231 | (mime (file-name-extension path)) 232 | (name (concat "img-" ref "." mime))) 233 | (message "Formatting Latex environment: %s" name) 234 | (push (org-epub-manifest-entry ref name 'img (concat "image/" mime) path) org-epub-manifest) 235 | name) attributes info) info)))) 236 | (t latex-frag)))) 237 | 238 | ;;;; Latex Fragment - stolen from ox-html 239 | 240 | (defun org-epub--latex-fragment (latex-fragment _contents info) 241 | "Transcode a LATEX-FRAGMENT object from Org to HTML. 242 | CONTENTS is nil. INFO is a plist holding contextual information." 243 | (let ((latex-frag (org-element-property :value latex-fragment)) 244 | (processing-type (plist-get info :with-latex))) 245 | (cond 246 | ((assq processing-type org-preview-latex-process-alist) 247 | (let ((formula-link 248 | (org-html-format-latex latex-frag processing-type info))) 249 | (when (and formula-link (string-match "file:\\([^]]*\\)" formula-link)) 250 | (let* ((path (match-string 1 formula-link)) 251 | (ref (org-export-get-reference latex-fragment info)) 252 | (mime (file-name-extension path)) 253 | (name (concat "img-" ref "." mime))) 254 | (message "Formatting Latex fragement: %s" name) 255 | (push (org-epub-manifest-entry ref name 'img (concat "image/" mime) path) org-epub-manifest) 256 | (org-html--format-image name nil info))))) 257 | (t latex-frag)))) 258 | 259 | 260 | (defun org-epub-link (link desc info) 261 | "Return the HTML required for a link descriped by LINK, DESC, and INFO. 262 | 263 | See org-html-link for more info." 264 | (when (org-export-inline-image-p link (plist-get info :html-inline-image-rules)) 265 | (let* ((path (org-link-unescape (org-element-property :path link))) 266 | (ref (org-export-get-reference link info)) 267 | (mime (file-name-extension path)) 268 | (name (concat "img-" ref "." mime))) 269 | (push (org-epub-manifest-entry ref name 'img (concat "image/" mime) path) org-epub-manifest) 270 | (org-element-put-property link :path name))) 271 | (org-html-link link desc info)) 272 | 273 | (defun org-epub-meta-put (symbols info) 274 | "Put SYMBOLS taken from INFO into the org-epub metadata cache." 275 | (mapc 276 | #'(lambda (sym) 277 | (let ((data (plist-get info sym))) 278 | (setq org-epub-metadata 279 | (plist-put org-epub-metadata sym 280 | (if (listp data) 281 | (org-export-data data info) 282 | data))))) 283 | symbols)) 284 | 285 | (defun org-epub-template (contents info) 286 | "Return complete document string after HTML conversion. 287 | CONTENTS is the transcoded contents string. INFO is a plist 288 | holding export options." 289 | (org-epub-meta-put '(:epub-uid :title :language :epub-subject :epub-description :author 290 | :epub-publisher :date :epub-rights :html-head-include-default-style :epub-cover :epub-style) info) 291 | (setq org-epub-metadata (plist-put org-epub-metadata :epub-toc-depth 2)) 292 | ;; maybe set toc-depth "2" to some dynamic value 293 | (setq org-epub-headlines 294 | (mapcar (lambda (headline) 295 | (list 296 | (org-element-property :raw-value headline) 297 | (org-element-property :level headline) 298 | (org-export-get-reference headline info))) 299 | (org-export-collect-headlines info 2))) 300 | (let ((styles (split-string (or (plist-get org-epub-metadata :epub-style) " ")))) 301 | (mapc #'(lambda (style) 302 | (let* ((stylenum (cl-incf org-epub-style-counter)) 303 | (stylename (concat "style-" (format "%d" stylenum))) 304 | (stylefile (concat stylename ".css"))) 305 | (push (org-epub-manifest-entry stylename stylefile 'stylesheet "text/css" style) org-epub-manifest))) 306 | styles)) 307 | (concat 308 | (when (and (not (org-html-html5-p info)) (org-html-xhtml-p info)) 309 | (let* ((xml-declaration (plist-get info :html-xml-declaration)) 310 | (decl (or (and (stringp xml-declaration) xml-declaration) 311 | (cdr (assoc (plist-get info :html-extension) 312 | xml-declaration)) 313 | (cdr (assoc "html" xml-declaration)) 314 | ""))) 315 | (when (not (or (not decl) (string= "" decl))) 316 | (format "%s\n" 317 | (format decl 318 | (or (and org-html-coding-system 319 | (fboundp 'coding-system-get) 320 | (coding-system-get org-html-coding-system 'mime-charset)) 321 | "iso-8859-1")))))) 322 | "" 323 | "\n" 324 | (concat "\n") 329 | 330 | "\n" 331 | (org-html--build-meta-info info) 332 | (when (plist-get info :html-head-include-default-style) 333 | "\n") 334 | (when (plist-get info :epub-style) 335 | (mapconcat 336 | #'(lambda (entry) 337 | (concat "\n")) 338 | (org-epub-manifest-all #'org-epub-style-p) "\n")) 339 | "\n" 340 | "\n" 341 | ;; Preamble. 342 | (org-html--build-pre/postamble 'preamble info) 343 | ;; Document contents. 344 | ; (let ((div (assq 'content (plist-get info :html-divs)))) 345 | ; (format "<%s id=\"%s\">\n" (nth 1 div) (nth 2 div))) 346 | "
" 347 | ;; Document title. 348 | (when (plist-get info :with-title) 349 | (let ((ftitle (plist-get info :title)) 350 | (subtitle (plist-get info :subtitle))) 351 | (when ftitle 352 | (message (org-export-data ftitle info)) 353 | (format 354 | "

%s

%s\n" 355 | (org-export-data ftitle info) 356 | (if subtitle 357 | (format 358 | "

%s

\n" 359 | (org-export-data subtitle info)) 360 | ""))))) 361 | contents 362 | "
" 363 | ; (format "\n" (nth 1 (assq 'content (plist-get info :html-divs)))) 364 | ;; Postamble. 365 | (org-html--build-pre/postamble 'postamble info) 366 | ;; Closing document. 367 | "\n")) 368 | 369 | ;; see ox-odt 370 | 371 | (defmacro org-epub--export-wrapper (outfile &rest body) 372 | "Export an Epub with BODY generating the main html file and OUTFILE as target file." 373 | `(let* ((outfile ,outfile) 374 | (org-epub-manifest nil) 375 | (org-epub-metadata nil) 376 | (org-epub-style-counter 0) 377 | (out-file-type (file-name-extension outfile)) 378 | (org-epub-zip-dir (file-name-as-directory 379 | (make-temp-file (format "%s-" out-file-type) t))) 380 | (body ,@body)) 381 | (condition-case err 382 | (progn 383 | (when (plist-get org-epub-metadata :html-head-include-default-style) 384 | (with-current-buffer (find-file (concat org-epub-zip-dir "style.css")) 385 | (insert org-epub-style-default) 386 | (save-buffer 0) 387 | (kill-buffer) 388 | (push (org-epub-manifest-entry "default-style" "style.css" 'stylesheet "text/css") org-epub-manifest))) 389 | (when (org-string-nw-p (plist-get org-epub-metadata :epub-cover)) 390 | (let* ((cover-path (plist-get org-epub-metadata :epub-cover)) 391 | (cover-type (file-name-extension cover-path)) 392 | (cover-img (create-image (expand-file-name cover-path))) 393 | (cover-width (car (image-size cover-img t))) 394 | (cover-height (cdr (image-size cover-img t))) 395 | (cover-name (concat "cover." cover-type))) 396 | (with-current-buffer (find-file (concat org-epub-zip-dir "cover.html")) 397 | (erase-buffer) 398 | (insert 399 | (org-epub-template-cover cover-name cover-width cover-height)) 400 | (save-buffer 0) 401 | (kill-buffer) 402 | (let ((men (org-epub-manifest-entry "cover" "cover.html" 'cover "application/xhtml+xml"))) 403 | (push men org-epub-manifest)) 404 | (let ((men (org-epub-manifest-entry "cover-image" cover-name 'coverimg (concat "image/" cover-type) cover-path))) 405 | (push men org-epub-manifest))))) 406 | (unless (file-directory-p (expand-file-name "META-INF" org-epub-zip-dir)) 407 | (make-directory (file-name-as-directory (expand-file-name "META-INF" org-epub-zip-dir)))) 408 | (with-current-buffer (find-file (expand-file-name "META-INF/container.xml" org-epub-zip-dir)) 409 | (erase-buffer) 410 | (insert (org-epub-template-container)) 411 | (save-buffer 0) 412 | (kill-buffer)) 413 | (with-current-buffer (find-file (concat org-epub-zip-dir "mimetype")) 414 | (erase-buffer) 415 | (insert (org-epub-template-mimetype)) 416 | (save-buffer 0) 417 | (kill-buffer)) 418 | (with-current-buffer (find-file (concat org-epub-zip-dir "body.html")) 419 | (erase-buffer) 420 | (insert body) 421 | (save-buffer 0) 422 | (kill-buffer) 423 | (nconc org-epub-manifest (list (org-epub-manifest-entry "body-html" "body.html" 'html "application/xhtml+xml")))) 424 | (with-current-buffer (find-file (concat org-epub-zip-dir "toc.ncx")) 425 | (erase-buffer) 426 | (insert 427 | (org-epub-template-toc-ncx 428 | (plist-get org-epub-metadata :epub-uid) 429 | (plist-get org-epub-metadata :epub-toc-depth) 430 | (plist-get org-epub-metadata :title) 431 | (org-epub-generate-toc-single org-epub-headlines "body.html"))) 432 | (save-buffer 0) 433 | (kill-buffer)) 434 | (with-current-buffer (find-file (concat org-epub-zip-dir "content.opf")) 435 | (erase-buffer) 436 | (insert (org-epub-template-content-opf 437 | org-epub-metadata 438 | (org-epub-gen-manifest org-epub-manifest) 439 | (org-epub-gen-spine '(("body-html" . "body.html"))))) 440 | (save-buffer 0) 441 | (kill-buffer)) 442 | (org-epub-zip-it-up outfile org-epub-manifest org-epub-zip-dir) 443 | (delete-directory org-epub-zip-dir t) 444 | (message (with-output-to-string (print org-epub-manifest))) 445 | (message "Generated %s" outfile) 446 | (expand-file-name outfile)) 447 | (error (delete-directory org-epub-zip-dir t) 448 | (message "ox-epub eport error: %s" err))))) 449 | 450 | ;;compare org-export-options-alist 451 | ;;;###autoload 452 | (defun org-epub-export-to-epub (&optional async subtreep visible-only ext-plist) 453 | "Export the current buffer to an EPUB file. 454 | 455 | ASYNC defines wether this process should run in the background, 456 | SUBTREEP supports narrowing of the document, VISIBLE-ONLY allows 457 | you to export only visible parts of the document, EXT-PLIST is 458 | the property list for the export process." 459 | (interactive) 460 | (let* ((outfile (org-export-output-file-name ".epub" subtreep))) 461 | (message "Output to:") 462 | (message outfile) 463 | (if async 464 | (org-export-async-start (lambda (f) (org-export-add-to-stack f 'odt)) 465 | (org-epub--export-wrapper 466 | outfile 467 | (org-export-as 'epub subtreep visible-only nil ext-plist))) 468 | (org-epub--export-wrapper 469 | outfile 470 | (org-export-as 'epub subtreep visible-only nil ext-plist))))) 471 | 472 | (defun org-epub-template-toc-ncx (uid toc-depth title toc-nav) 473 | "Create the toc.ncx file. 474 | 475 | UID is the uid/url of the file. TOC-DEPTH is the depth of the toc 476 | that should be shown to the readers. TITLE is the title of the 477 | ebook and TOC-NAV being the raw contents enclosed in navMap." 478 | (concat 479 | " 480 | 482 | 483 | 484 | 485 | 486 | 489 | 492 | 493 | 494 | 495 | 496 | 497 | " 498 | title 499 | " 500 | 501 | 502 | " 503 | toc-nav 504 | " 505 | ")) 506 | 507 | (defun org-epub-template-content-opf (meta manifest spine) 508 | "Create the content.opf file. 509 | 510 | META is a metadata PLIST. 511 | 512 | The following arguments are XML strings: MANIFEST is the content 513 | inside the manifest tags, this should include all user generated 514 | html files but not things like the cover page, SPINE is an XML 515 | string with the list of html files in reading order." 516 | (concat 517 | " 518 | 519 | 521 | 522 | 526 | " (plist-get meta :title) " 527 | " (plist-get meta :language) " 528 | " 529 | (plist-get meta :epub-uid) 530 | " 531 | " (plist-get meta :epub-subject) 532 | " 533 | " (plist-get meta :epub-description) 534 | 535 | " 536 | " (plist-get meta :author) " 537 | " (plist-get meta :epub-publisher) " 538 | " (plist-get meta :date) " 539 | " (plist-get meta :epub-rights) "" 540 | (let ((cimg (org-epub-manifest-first #'org-epub-coverimg-p))) 541 | (when cimg 542 | (concat ""))) 543 | " 544 | 545 | 546 | \n 547 | " 549 | 550 | manifest 551 | 552 | " 553 | 554 | " 555 | (let ((chtml (org-epub-manifest-first #'org-epub-cover-p))) 556 | (when chtml 557 | (concat ""))) 558 | 559 | spine 560 | 561 | " 562 | 563 | " 564 | (let ((chtml (org-epub-manifest-first #'org-epub-cover-p))) 565 | (when chtml 566 | (concat " "))) 567 | " 568 | 569 | 570 | ")) 571 | 572 | (defun org-epub-gen-manifest (files) 573 | "Generate the manifest XML string. 574 | 575 | FILES is the list of files to be included in the manifest xml string." 576 | (mapconcat 577 | (lambda (file) 578 | (concat "\n")) 580 | files "")) 581 | 582 | (defun org-epub-gen-spine (files) 583 | "Generate the spine XML string. 584 | 585 | FILES is the list of files to be included in the spine, these 586 | must be in reading order." 587 | (mapconcat 588 | (lambda (file) 589 | (concat "\n")) 590 | files "")) 591 | 592 | (defun org-epub-template-container () 593 | "Generate the container.xml file, the root of any EPUB." 594 | " 595 | 596 | 597 | 599 | 600 | ") 601 | 602 | (defun org-epub-template-cover (cover-file width height) 603 | "Generate a HTML template for the cover page. 604 | 605 | COVER-FILE is the filename of a jpeg file, while WIDTH and HEIGHT are 606 | properties of the image." 607 | (concat " 608 | 609 | 610 | 611 | 612 | 613 | 614 | 615 | 616 | 618 | 619 | 620 | 621 | ")) 622 | 623 | (defun org-epub-template-mimetype () 624 | "Generate the mimetype file for the epub." 625 | "application/epub+zip") 626 | 627 | (defun org-epub-zip-it-up (epub-file files target-dir) 628 | "Create the .epub file by zipping up the contents. 629 | 630 | EPUB-FILE is the target filename, FILES is the list of source 631 | files to process, while TARGET-DIR is the directory where 632 | exported HTML files live. This function will copy any files into 633 | their proper place." 634 | (mapc #'(lambda (entry) 635 | (let ((copy (org-epub-manifest-needcopy entry))) 636 | (when copy 637 | (copy-file (car copy) (concat target-dir (cdr copy)) t)))) 638 | files) 639 | (let ((default-directory target-dir) 640 | (meta-files '("META-INF/container.xml" "content.opf" "toc.ncx"))) 641 | (apply 'call-process 642 | (append (list org-epub-zip-command nil '(:file "zip.log") nil) 643 | org-epub-zip-no-compress 644 | (list epub-file 645 | "mimetype"))) 646 | (apply 'call-process org-epub-zip-command nil '(:file "zip.log") nil 647 | (append org-epub-zip-compress 648 | (list epub-file) 649 | (append meta-files (mapcar #'(lambda (el) (plist-get el :filename)) files))))) 650 | (copy-file (concat target-dir epub-file) default-directory t)) 651 | 652 | (defun org-epub-generate-toc-single (headlines filename) 653 | "Generate a single file TOC. 654 | 655 | HEADLINES is a list containing the abbreviated headline 656 | information. The name of the target file is given by FILENAME." 657 | (let ((toc-id 0) 658 | (current-level 0)) 659 | (with-output-to-string 660 | (mapc 661 | (lambda (headline) 662 | (let* ((title (nth 0 headline)) 663 | (level (nth 1 headline)) 664 | (ref (nth 2 headline))) 665 | (cl-incf toc-id) 666 | (cond 667 | ((< current-level level) 668 | (cl-incf current-level)) 669 | ((> current-level level) 670 | (princ "") 671 | (while (> current-level level) 672 | (cl-decf current-level) 673 | (princ ""))) 674 | ((eq current-level level) 675 | (princ ""))) 676 | (princ 677 | (concat (format "\n" current-level filename toc-id) 678 | (format "%s\n" (org-html-encode-plain-text title)) 679 | (format "" filename ref))))) 680 | headlines) 681 | (while (> current-level 0) 682 | (princ "") 683 | (cl-decf current-level))))) 684 | 685 | (provide 'ox-epub) 686 | 687 | ;;; ox-epub.el ends here 688 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------