38
edits
Difference between revisions of "Zimwriterfs instructions"
Jump to navigation
Jump to search
Adapations for move to zim-tools + less "warnings" + more precise docker usage
(Adapations for move to zim-tools + less "warnings" + more precise docker usage) |
|||
| Line 1: | Line 1: | ||
= zimwriterfs instructions = | = zimwriterfs instructions = | ||
Here are some notes on how to prepare your materials and use `zimwriterfs`. | Here are some notes on how to prepare your materials and use `zimwriterfs`. | ||
These instructions are a community contribution, provided as-is by users of the tool. | |||
== Preparations == | == Preparations == | ||
Some considerations can help you prepare your materials | |||
`zimwriterfs` is a tool which will pack all files (HTML/JS/CSS/JPEG/WEBM/...) belonging to a directory in a ZIM file. | |||
Before using this tool, you must hence ensure you have a self-sufficient directory of all content you want to pack. | |||
Some considerations can help you prepare your materials: | |||
# Can it be read and navigated in a mainstream web browser e.g. using <code>file://localhost/mycontent</code> (replace mycontent with the correct URL) | # Can it be read and navigated in a mainstream web browser e.g. using <code>file://localhost/mycontent</code> (replace mycontent with the correct URL) | ||
# Would you like to use the recommended ZIM file internal structures? e.g. <code>./-/</code> for CSS and <code>./A/</code> for articles (in HTML format), etc.? If so, there's no need to use the <code>--uniqueNamespace</code> command-line option. Otherwise | # Would you like to use the recommended ZIM file internal structures? e.g. <code>./-/</code> for CSS and <code>./A/</code> for articles (in HTML format), etc.? If so, there's no need to use the <code>--uniqueNamespace</code> command-line option. Otherwise you should use it. | ||
# Have you identified your welcome page and got a suitable icon? | # Have you identified your welcome page and got a suitable icon? | ||
# Would you like to distribute to a large base of users who may use a variety of machines and storage options? If so, it will be important to split the ZIM file into no more than 2GB chunks. | # Would you like to distribute to a large base of users who may use a variety of machines and storage options? If so, it will be important to split the ZIM file into no more than 2GB chunks. | ||
=== Running zimwritefs with Docker === | |||
The simplest setup to run `zimwriterfs` on a variety of configuration is to use Docker since it will ensure a smooth operation no matter which OS your machine is running. | |||
As `zimwriterfs` is now part of `zim-tools`, you have to use the `openzim/zim-tools` image. And of course you need a functional installation of Docker (including a proper subscription, adapted to new Docker licencing model - it is free if you use it for personal use) | |||
For simplicity, we will share a directory with the Docker container: | |||
- create a root folder for your generated zim file + content | |||
- put every content in the `dist` subfolder | |||
- move into the root folder you created | |||
- you can now start zimwriterfs with a command like the following one. With this command, the shared folder is at <code>/data</code> in the running Docker image. | |||
<code> | <code> | ||
docker run -it -v $(pwd):/ | docker run -it -v $(pwd):/data/dist openzim/zimwriterfs zimwriterfs ... | ||
</code> | </code> | ||
== Examples of using zimwriterfs == | == Examples of using zimwriterfs == | ||
<code> | <code> | ||
zimwriterfs | docker run -it -v $(pwd):/data openzim/zimwriterfs zimwriterfs --uniqueNamespace -w index.html -f icon.png -l eng -t "Testing Heuristics" -d "Early cut of the testing heuristics material." -c "Julian Harty" -p "Commercetest Ltd." /data/dist /data/th-ln.zim | ||
zimwriterfs -w index.html -f tess.png -l | docker run -it -v $(pwd):/data openzim/zimwriterfs zimwriterfs -w index.html -f tess.png -l eng -t "Visions for Teaching and Learning" -d "Sample TESS content: Week 1" -c "Open University" -p "Julian Harty" /data/dist /data/week1.zim | ||
</code> | </code> | ||