/arch-wiki-docset

Script to generate pages from Arch Wiki in docset format

Primary LanguageShellGNU General Public License v3.0GPL-3.0

arch-wiki-docset

Script to generate pages from Arch Wiki in docset format (tested with zeal)

Note: Building may take a long time.

Check Installation for manual instructions.

Contents

Dependencies

  • git
  • dashing (aur link)
  • arch-wiki-docs (and its dependencies)
    • python
    • python-simplemediawiki
    • python-lxml
    • python-cssselect
    • python-requests

Running

Set run permissions

chmod +x arch-wiki-docset.sh

or run with bash command

Usage

Download build and install with

./arch-wiki-docset.sh -d -b -i

or

./arch-wiki-docset.sh --download --build --install

this can be used to update the docset as well

Commands

Download wiki

./arch-wiki-docset.sh -d

or

./arch-wiki-docset.sh --download

Downloads english version of the wiki

To download other languages, add the language code to the command

./arch-wiki-docset.sh -d [language code]

or

./arch-wiki-docset.sh --download [language code]

Example

./arch-wiki-docset.sh -d es it fr de

Build docset

./arch-wiki-docset.sh -b

or

./arch-wiki-docset.sh --build

Remove build folders

./arch-wiki-docset.sh -c

or

./arch-wiki-docset.sh --clean

Install docset

./arch-wiki-docset.sh -i

or

./arch-wiki-docset.sh --install

Uninstall docset

./arch-wiki-docset.sh -u

or

./arch-wiki-docset.sh --uninstall

Note

The script automatically fetches the docset location from zeal configuration file

Check for new files in wiki

./arch-wiki-docset.sh -c

or

./arch-wiki-docset.sh --checkFolder

Note

The wiki has to be redownloaded to check if there are new files

Redownload arch-wiki-docs

./arch-wiki-docset.sh -r

or

./arch-wiki-docset.sh --redownload

Select preferred index page language

./arch-wiki-docset.sh -p [language code]

or

./arch-wiki-docset.sh --prefLang [language code]

Note

Use this before building the docset.

The script will automatically check if the language code is correct (supports all languages supported by arch-wiki-docs)

Help

./arch-wiki-docset.sh -h

or

./arch-wiki-docset.sh --help