BaseX-functions

Experimental tools to assist creating machine readable assets from the BaseX documentation particularly the wiki at https://docs.basex.org/

Raw wiki pages are XML using a mixture of HTML and custom elements. The content is often markdown which may contain HTML.

Features

• login and download raw wiki pages
• create a module index by scraping the Functions page
• create stub files from downloaded raw wiki pages

Requires

Required environment-variables in the table below are set.

Name	Required	Description	Default
BASEXDOCS_USER	Y		(none)
BASEXDOCS_PASSWORD	Y		(none)
BASEXDOCS_VER	N		(empty)
BASEXDOCS_SITE	N		https://docs.basex.org/

To assist in setting up these copy .env.sample to .env and then customize the .env file.

Load and check unix

set -a; source .env; set +a
env | grep -E "BASEXDOCS"  # Filter to see your vars