mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-15 05:09:25 +00:00
637cc064da
Fixes #3979. Instead of loading help.keyman.com in the support frame, we now load a local copy of the help. External links within the help will open in the user's browser. This avoids issues of navigation to keyboard download and other sites which won't work well. Also, adds Back, Forward and Home buttons to the window so the user can navigate more easily with mouse. Finally, this means that the local help will always be synchronised with the app version and brings the macOS help in line with the other platforms.
108 lines
2.1 KiB
Bash
Executable file
108 lines
2.1 KiB
Bash
Executable file
#!/bin/bash
|
|
|
|
# Set sensible script defaults:
|
|
# set -e: Terminate script if a command returns an error
|
|
set -e
|
|
# set -u: Terminate script if an unset variable is used
|
|
set -u
|
|
|
|
## START STANDARD BUILD SCRIPT INCLUDE
|
|
# adjust relative paths as necessary
|
|
THIS_SCRIPT="$(greadlink -f "${BASH_SOURCE[0]}" 2>/dev/null || readlink -f "${BASH_SOURCE[0]}")"
|
|
. "$(dirname "$THIS_SCRIPT")/../resources/build/build-utils.sh"
|
|
## END STANDARD BUILD SCRIPT INCLUDE
|
|
|
|
QUIET=0
|
|
|
|
. "$KEYMAN_ROOT/resources/shellHelperFunctions.sh"
|
|
|
|
THIS_DIR="$(dirname "$THIS_SCRIPT")"
|
|
|
|
display_usage() {
|
|
echo "build.sh [--no-clean] target [...target]"
|
|
echo "Builds help documentation for Keyman for macOS"
|
|
echo "Targets:"
|
|
echo " * htm or html: convert documentation to html using pandoc"
|
|
echo
|
|
echo " --no-clean: don't clean target folder before building"
|
|
}
|
|
|
|
DO_HTM=false
|
|
DO_CLEAN=true
|
|
|
|
# Debug flags
|
|
DO_HTM_CONVERSION=true
|
|
|
|
#
|
|
# Parse args
|
|
#
|
|
|
|
shopt -s nocasematch
|
|
|
|
while [[ $# -gt 0 ]] ; do
|
|
key="$1"
|
|
case $key in
|
|
htm | html)
|
|
DO_HTM=true
|
|
;;
|
|
--no-clean)
|
|
DO_CLEAN=false
|
|
;;
|
|
*)
|
|
display_usage
|
|
exit 1
|
|
esac
|
|
shift # past argument
|
|
done
|
|
|
|
if ! $DO_HTM ; then
|
|
display_usage
|
|
exit 1
|
|
fi
|
|
|
|
displayInfo "" \
|
|
"DO_HTM: $DO_HTM" \
|
|
"DO_CLEAN: $DO_CLEAN" \
|
|
""
|
|
|
|
#
|
|
# Compile all .md to .html
|
|
#
|
|
|
|
cd $KEYMAN_ROOT/mac/help
|
|
|
|
MDLUA="$KEYMAN_ROOT/resources/build/html-link.lua"
|
|
MD=`find . -name "*.md"`
|
|
DESTHTM="$THIS_DIR/Keyman4MacIM/Keyman4MacIM/Help"
|
|
|
|
if $DO_HTM; then
|
|
#
|
|
# Clean existing folder
|
|
#
|
|
|
|
if $DO_CLEAN; then
|
|
rm -rf "$DESTHTM" || true # We don't want to die when we clean an empty folder
|
|
fi
|
|
mkdir -p "$DESTHTM"
|
|
|
|
#
|
|
# Generate HTML files from Markdown
|
|
#
|
|
|
|
if $DO_HTM_CONVERSION; then
|
|
for INFILE in $MD; do
|
|
OUTFILE="$DESTHTM/${INFILE%.md}.html"
|
|
echo "Processing $INFILE to $(basename "$OUTFILE")"
|
|
mkdir -p "$(dirname "$OUTFILE")"
|
|
pandoc -s --lua-filter="$MDLUA" -t html -o "$OUTFILE" $INFILE
|
|
done
|
|
fi
|
|
|
|
#
|
|
# Copy Images
|
|
#
|
|
cd $KEYMAN_ROOT/mac/help/
|
|
mkdir -p "$DESTHTM/mac_images"
|
|
cp mac_images/* "$DESTHTM/mac_images/"
|
|
|
|
fi
|