Skip to content

Tickets Lifecycle (Mwoffliner)

Jump to bottom
RavanJAltaie edited this page Mar 8, 2023 · 2 revisions

To create a new recipe for mediawiki files

It’s recommended to clone an existing mwoffliner recipe.

  • Create the recipe name as per the naming conventions here.
  • In the Language space, choose the language of the website you are creating the recipe for.
  • From Category space, choose the proper category related to your website (eg. Wikipedia, Wikivoyage, …etc)
  • From warehouse path space, choose (/.hidden/.dev) always as a first time in order to test the resulted file, if the file is tested and all is correct * then you update the recipe with the proper path (eg. Wikipedia, Wikihow, …etc)
  • Make sure the Status is set to Enabled
  • You can choose Periodicity to be monthly or quarterly.
  • In Offliner space choose: mwoffliner.
  • In platform space choose Wikimedia.
  • Keep the rest the same with no change.

In mwoffliner command flags:

  • Replace Wiki URL: https://xxx with the URL for the website you want to submit, e.g. https://www.ar.wikipedia.org/ .
  • Keep the admin email as it is: contact@kiwix.org
  • In Article List: put the required list if your file is specific to certain articles or pages, otherwise, leave it empty. The file will be a tab- separated list (.tsv) stored elsewhere (e.g. drive.farm.openzim.org) so you need to add the full URL for it (e.g. https://drive.farm.openzim.org/wikipedia/cooking.tsv)
  • In Main Page: place the main page link, if left empty it will automatically choose the homepage of the URL you placed above.
  • In Zim Title: type the name you want your output file to be titled.
  • In Zim Description: type a short description of your required zim file.
  • Leave ZIM Long Description empty.
  • In Zim favicon: Place the link of the required logo of your zim file.
  • Leave Optimisation Cache URL as it is (cloned from old recipe).
  • Leave the rest of the fields empty.
  • Finally, click in the bottom on (Update offliner details).
  • Review all your entries once again, then go back to the top of the page and click on (Request).

After about an hour

  • check the recipe if it failed or succeeded (or the next day if the source website is large).
  • If successful, go to this link (dev.library.kiwix.org) and check your created file, check the size and check if the file is working properly. If the file does not appear wait a bit as updates are made every 15 minutes.
  • If the file looks good and complete, go back to your recipe, In warehouse path space, change(/.hidden/.dev) to the proper category related to your file content (Wikipedia, Wikihow, … etc).
  • Click on Update offliner details and then click on Request again.
  • Finally, check the file in (https://library.kiwix.org/ ). If all is good, do not forget to go back to the initial ticket (most likely at zim-requests) and put the link of the output file and close the ticket.
Clone this wiki locally