Here are some notes on how to prepare your materials and use `zimwriterfs`. The notes are incomplete as they're based on my limited experience using the tool in the prebuilt Docker Image.
Some considerations can help you prepare your materials
- Can it be read and navigated in a mainstream web browser e.g. using
file://localhost/mycontent(replace mycontent with the correct URL)
- Would you like to use the classic ZIM file internal structures? e.g.
./-/for CSS and
./A/for articles (in HTML format), etc.? If so, there's no need to use the
--uniqueNamespacecommand-line option. Otherwise please use it.
- Have you identified your welcome page and got a suitable icon?
- Have you created a shared location available to the running Docker image to make the content easier to access by zimwriterfs?
- 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.
zimwriterfs --uniqueNamespace -w index.html -f icon.png -l EN -t "Testing Heuristics" -d "Early cut of the testing heuristics material." -c "Julian Harty" -p "Commercetest Ltd." /Volumes/shared/dist/ /Volumes/shared/th-ln.zim
Test the ZIM locally
Ue at least one reader e.g. a Kiwix app or server to test the ZIM file contains the expected contents. The Welcome page is displayed, CSS is applied, Images appear, etc.