spiegel-keyman/android/build-help.sh
2019-09-26 10:56:05 +07:00

76 lines
No EOL
2.4 KiB
Bash
Executable file

#!/bin/bash
# Uses the open-source `wget` utility to create an embedding-friendly offline mirror
# equivalent of online help.
# Set to .local to run against a locally-hosted version.
# Leave empty for live runs.
LOCAL=.local
WAIT=
# When running against live servers, it's best to have a small wait between loads.
# Cloudflare may frown on not waiting, as `wget` is basically a scraper/bot.
#WAIT="--wait=2"
# Allows tracking slightly different settings for different offline-mirroring ops
# should we decide to extract the actual mirroring function into its own file.
#
# iOS uses "--no-directories" instead, at least for now.
OPTIONS="--no-host-directories"
DEVICE=android
HELP_SITE_SECTION=products/android
HELP_ROOT=KMAPro/kMAPro/src/main/assets/info
# Clear previous help file downloads (if they exist)
if [ -d "$HELP_ROOT" ]; then
rm -r "$HELP_ROOT"
fi
VERSION=`cat ../resources/VERSION.md`
# If TIER is set to "alpha", use the previous version. Help is usually only updated during
# the "beta" process.
if [ -z $TIER ]; then
# Prevents an error message on the next check. Also, manual runs will likely be during beta.
TIER=beta
fi
if [ $TIER = "alpha" ]; then
# More readable: (major).minor
[[ "$VERSION" =~ ([0-9]+)\.[0-9]+ ]]
# Construct a decremented version string with .minor set to .0
VERSION="$((${BASH_REMATCH[1]}-1)).0"
fi
do_offline_mirror() {
# $1 - the form-factor specification.
# Create local mirror of the help page subdirectory.
# We don't need /font/deploy folder resources, so they're excluded here.
# One of the .css files auto-includes them otherwise.
wget --mirror \
--convert-links \
$WAIT \
--keep-session-cookies \
--page-requisites \
--no-parent \
$OPTIONS \
--restrict-file-names=windows \
--exclude-directories /font/deploy \
--directory-prefix="$HELP_ROOT" \
--adjust-extension \
"help.keyman.com$LOCAL/$HELP_SITE_SECTION/$VERSION/index.php?embed=$DEVICE&formfactor=$1"
# Results in a flat-structured mirror of the specified folder,
# together with all needed resources within the 'site' folder.
}
do_offline_mirror "phone"
# Now for some magic... we rename the page's folder and redownload with the other setting.
mv ./$HELP_ROOT/$HELP_SITE_SECTION/$VERSION ./$HELP_ROOT/$HELP_SITE_SECTION/phone
do_offline_mirror "tablet"
mv ./$HELP_ROOT/$HELP_SITE_SECTION/$VERSION ./$HELP_ROOT/$HELP_SITE_SECTION/tablet