{"id":20079557,"url":"https://github.com/transpect/epubtools-frontend","last_synced_at":"2025-07-24T20:04:03.408Z","repository":{"id":93859523,"uuid":"46122638","full_name":"transpect/epubtools-frontend","owner":"transpect","description":"Converts XHTML to EPUB2/3","archived":false,"fork":false,"pushed_at":"2024-05-27T17:34:51.000Z","size":19,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-28T02:45:08.157Z","etag":null,"topics":["epub","epub2","epub3","xhtml"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/transpect.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-13T13:10:26.000Z","updated_at":"2024-05-27T17:34:54.000Z","dependencies_parsed_at":"2024-01-02T16:53:43.437Z","dependency_job_id":null,"html_url":"https://github.com/transpect/epubtools-frontend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Fepubtools-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Fepubtools-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Fepubtools-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transpect%2Fepubtools-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transpect","download_url":"https://codeload.github.com/transpect/epubtools-frontend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224472439,"owners_count":17316989,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["epub","epub2","epub3","xhtml"],"created_at":"2024-11-13T15:23:25.830Z","updated_at":"2024-11-13T15:23:26.647Z","avatar_url":"https://github.com/transpect.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# epubtools-frontend\nConverts EPUB 2 and 3 (fixed/reflowable) from XHTML\n\nThis project provides a convenient frontend to convert EPUBs with the transpect epubtools library.\nThe epubtools library takes an XHTML file as input and generates an EPUB. Referenced resources such as CSS, \nJavaScript and images are automatically stored in the EPUB file. Layout, format and other parameters are \nconfigured in an XML file. \n\n## Requirements\n\nJava 1.7+\n\n## Download\n\nYou can either download this repository as Zip file or use Git or SVN.\n\n### Clone with Git\n```\n$ git clone git@github.com:transpect/epubtools-frontend.git --recursive\n```\n### Checkout with SVN\n\n```\n$ svn co https://github.com/transpect/epubtools-frontend/trunk\n```\n\n## Invocation\n\n### MacOS/Linux\n\nYou can choose whether to invoke epubtools XProc pipeline with an Bash script or XML Calabash. \n\n#### Bash script\n\n```\n./epubconvert [options ...] myInputFile.html\n```\n\nOption  | Description\n------  | -------------\n -o     | path to custom output directory\n -c     | path to custom configuration file\n -d     | debug mode\n\n#### XML Calabash\n\n```\n ./calabash/calabash.sh \\\n    -i source=myInputFile.html \\\n    -i meta=myConfiguration.xml \\\n    $DIR/xpl/epubtools-frontend.xpl\n```\n\n### Windows\n\n```\n ./calabash/calabash.bat \\\n    -i source=myInputFile.html \\\n    -i meta=myConfiguration.xml \\\n    $DIR/xpl/epubtools-frontend.xpl\n```\n\n## Configuration\n\nHere is an example for a basic configuration. If you open the oXygen project file, the file is \nautomatically validated (RelaxNG and Schematron). You can also find a commented version of this\nfile [here](https://github.com/transpect/epubtools/blob/13f250dd3dac3de7b72416cace4d14d56d255b1a/sample/epub-config.xml)\n\nMajor parameters are configured with the `epub-config` attributes:\n\nLocation                                          | Description\n----------------------------------------------    | -------------\n `epub-config/@format`                            | EPUB2 \\| EPUB3 \\| KF8\n `epub-config/@layout`                            | reflowable \\| fixed\n `epub-config/@css-handling`                      | regenerated-per-split\\|regenerated-per-split remove-comments\\|unchanged (default: regenerated-per-split)\n `epub-config/@html-subdir-name`                  | name of html subdirectory\n `epub-config/@indent`                            | true|false|selective (If indent=\"selective\", p:store will store non-indented, and the indent before paragraphs etc)\n \n The element `metadata` includes additional metadata information which is later stored in the OPF file.\n \n The `hierarchy` element is used to configure how the HTML is split into chunks.\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e   \n\u003c?xml-model href=\"http://transpect.io/epubtools/schema/metadata-conf/metadata-conf.rng\" schematypens=\"http://relaxng.org/ns/structure/1.0\"?\u003e\n\u003c?xml-model href=\"http://transpect.io/epubtools/schema/metadata-conf/metadata-conf.rng\" schematypens=\"http://purl.oclc.org/dsdl/schematron\"?\u003e\n\u003cepub-config xmlns:tr=\"http://transpect.io\" \n  format=\"EPUB3\" \n  layout=\"reflowable\" \n  css-handling=\"regenerated-per-split\"\n  html-subdir-name=\"text\" \n  indent=\"selective\"\u003e\n\t\n  \u003ccover href=\"images/cover.png\" svg=\"true\"/\u003e\n\t\n  \u003cmetadata xmlns:dc=\"http://purl.org/dc/elements/1.1/\"\u003e\n    \u003cdc:identifier format=\"EPUB3\"\u003e89392383923\u003c/dc:identifier\u003e\n    \u003cdc:identifier format=\"KF8\"\u003e89392383923\u003c/dc:identifier\u003e\n    \u003cdc:title\u003eMustertitel\u003c/dc:title\u003e\n    \u003cdc:creator\u003eAutoren\u003c/dc:creator\u003e\n    \u003cdc:publisher\u003eVerlag\u003c/dc:publisher\u003e\n  \t\u003cdc:language\u003ede\u003c/dc:language\u003e\n  \u003c/metadata\u003e\n\n  \u003chierarchy media-type=\"application/xhtml+xml\" max-population=\"40\" max-text-length=\"200000\" generated-frontmatter-title=\"\"\u003e\n    \u003cunconditional-split elt=\"div\" attr=\"class\" attval=\"white\"/\u003e\n    \u003cunconditional-split elt=\"h1\"/\u003e\n    \u003cheading elt=\"h1\"/\u003e\n    \u003cunconditional-split attr=\"epub:type\" attval=\"cover\"/\u003e\n  \u003c/hierarchy\u003e\n  \n\u003c/epub-config\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftranspect%2Fepubtools-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftranspect%2Fepubtools-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftranspect%2Fepubtools-frontend/lists"}