[11.7] [PR 34] Fix the family directory structure #35

antora.yml

@@ -3,7 +3,7 @@ title: Mobile App for iOS (iOS 11+)
 version: '11.7'
 start_page: ROOT:index.adoc
 nav:
-- modules/ROOT/nav.adoc
+- modules/ROOT/partials/nav.adoc
 
 asciidoc:
  attributes:

bin/find-orphaned-adoc-files

@@ -1,16 +1,18 @@
 #!/usr/bin/env bash
 
 #
-# This script checks which .adoc files are possibly orphaned.
+# This script checks which .adoc files are possibly orphaned
 # It can cover single and multi manual environments
 #
 # Note that filenames MUST NOT contain blanks
 
 AVAILABLE_MANUALS=( ROOT )
+# dependend of root or not, the manual name gets a postfix added, name see below
 ROOT_NAME="ROOT"
+# all main nav files from the modules have the name nav.adoc
 NAV_FILENAME="nav.adoc"
-NAV_ROOT_FILENAME="nav_root.adoc"
-PARTIALS_NAME="_partials"
+PARTIALS_NAME="partials"
+# https://docs.antora.org/antora/2.3/page/resource-id/#id-coordinates
 FAMILY='{partialsdir}'
 #FAMILY="partial$"
 MANUAL_NAME=
@@ -70,8 +72,13 @@ function usage()
 
 function find_orphans()
 {
+ local search_pattern=
+
  validate_manual "$MANUAL_NAME"
 
+ # escape the dollar sign in the search pattern if exists
+ search_pattern="include::${FAMILY//$/\\$}"
+
  # define the global variables
  # the base directory name depends if there is a single or are multiple manuals available
  if [[ ${MANUAL_NAME} = ${ROOT_NAME} ]]; then
@@ -81,25 +88,12 @@ function find_orphans()
  fi
  #
  PAGES_DIR="${BASE_DIR}/pages"
- #
- # the nav file name and location depends if there are single or multiple manuals available
- # and if the ROOT manual has been selected or not
- #
- # single manual
- NAV_FILE="${BASE_DIR}/${NAV_FILENAME}"
- #
- # multi manual (overwrites the variable)
- if [[ ${#AVAILABLE_MANUALS[@]} -gt 1 ]]; then
- if [[ ${MANUAL_NAME} = ${ROOT_NAME} ]]; then
- # ROOT selected
- NAV_FILE="${BASE_DIR}/${NAV_ROOT_FILENAME}"
- else
- # another module selected
- NAV_FILE="${PAGES_DIR}/${PARTIALS_NAME}/${NAV_FILENAME}"
- fi
- fi
+
+ # define the navigation file
+ NAV_FILE="${BASE_DIR}/${PARTIALS_NAME}/${NAV_FILENAME}"
+
  # --> important: the partials dir may change to base_dir/partials_name
- PARTIALS_DIR="${PAGES_DIR}/${PARTIALS_NAME}"
+ PARTIALS_DIR="${BASE_DIR}/${PARTIALS_NAME}"
 
  # get content for all partials but exclude the nav file, however we call it
  # partials directory may not be present
@@ -221,7 +215,7 @@ function find_orphans_for_manual()
  # now check if there are orphaned partials files
 
  # get all files which have an include + family statement
- include_list=($(cat "${PAGES_FILES[@]/#/${PAGES_DIR}/}" | grep "include::${FAMILY}" | sort | uniq))
+ include_list=($(cat "${PAGES_FILES[@]/#/${PAGES_DIR}/}" | grep "${search_pattern}" | sort | uniq))
  #echo ${include_list[@]} | tr ' ' '\n'
  #exit
 

bin/find-orphaned-base

@@ -13,6 +13,9 @@
  exit
  fi
 
+# escape the dollar sign in the search pattern if exists
+SEARCH_PATTERN="${SEARCH_PATTERN//$/\\$}"
+
 function start_scan()
 {
  local list
@@ -92,8 +95,9 @@ function start_scan()
  fi
 
  # create an array diff and print to output
+ # the output contains the full relative path
  not_linked=($(echo ${found_find[@]} ${found_grep[@]} | tr ' ' '\n' | sort | uniq -u))
- echo ${not_linked[@]} | tr ' ' '\n'
+ echo "${not_linked[@]/#/${BASE_DIR}/${TARGET_DIR}/}" | tr ' ' '\n'
 
  # count the number of occurrences
  count_not_linked=$(( $count_not_linked + ${#not_linked[@]} ))

bin/find-orphaned-example-files

@@ -15,7 +15,9 @@ TASK="EXAMPLE"
 TARGET_DIR="examples"
 # depending on the target, there may be a trailing slash necessary or not
 # check how the file is included
+# https://docs.antora.org/antora/2.3/page/resource-id/#id-coordinates
 SEARCH_PATTERN='include::{examplesdir}'
+#SEARCH_PATTERN='include::example$'
 
 # get the full path the the directory the script runs
 DIR="$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")"

bin/find-orphaned-image-files

@@ -11,9 +11,10 @@ AVAILABLE_MANUALS=( ROOT )
 ROOT_NAME="ROOT"
 BASE_DIR=""
 MANUAL_POSTFIX="_manual"
-TARGET_DIR="assets/images"
+TARGET_DIR="images"
 # depending on the target, there may be a trailing slash necessary or not
 # check how the file is included
+# https://docs.antora.org/antora/2.3/page/resource-id/#id-coordinates
 SEARCH_PATTERN='image:'
 
 # get the full path the the directory the script runs

bin/makepdf

@@ -35,6 +35,9 @@ ACTUAL_BRANCH_NAME=
 DEFAULT_NAME="next"
 MASTER_BRANCH="master"
 
+# the name of the partials directory
+PARTIALS_NAME="partials"
+
 DRY_RUN=false
 
 # get the todays date
@@ -125,7 +128,7 @@ function clean_build_dir()
 # the nav file is handed over as parameter used as stream
 function convert_antora_nav_to_asciidoc_list()
 {
-
+ local level_offset=
  local nav_filename="$1"
 
  # have a blank line between the template content end and the beginning of the inserts
@@ -140,7 +143,10 @@ function convert_antora_nav_to_asciidoc_list()
  # on single manual repos, the level offset is corrected with 1 (NF-1)
  level_offset=$(echo "$line" | awk -F"*" '{print NF-1}')
  fi
- revised_line=$(echo "$line" | sed 's/xref:/include::{module_base_path}/' | sed 's/\[.*\]//g' | sed -r 's/^\*{1,} //')
+ # when having multi manual repos, the last sed in the line below is to remove
+ # the manual component (:manual_name:) from the string
+ # this is because we have moved the nav.adoc file into partials and therefore need to add the module
+ revised_line=$(echo "$line" | sed 's/xref:/include::{module_base_path}/' | sed 's/\[.*\]//g' | sed -r 's/^\*{1,} //' | sed -e 's/\(module_base_path}\)\(.*:\)/\1/')
  echo "${revised_line}[leveloffset=+${level_offset}]"
  echo
  fi
@@ -211,7 +217,7 @@ function build_pdf_manual()
  local book_file="${BOOKS_DIRECTORY}/ownCloud_${manual_infix}_Manual.adoc"
 
  # the navigation file for the manual to be built
- local nav_file="modules/${source_root}/nav.adoc"
+ local nav_file="modules/${source_root}/${PARTIALS_NAME}/nav.adoc"
 
  # Get the dynamic list of attributes from yml files
  # The output after sed is a string like -a key=value -a key=value ...
@@ -261,7 +267,7 @@ function build_pdf_manual()
  param+='-a format="pdf" '
 # param+='-a experimental="" ' # experimental already set in site.yml
  param+='-a examplesdir='$(pwd)/modules/${source_root}/examples/' '
- param+='-a imagesdir='$(pwd)/modules/${source_root}/assets/images/' '
+ param+='-a imagesdir='$(pwd)/modules/${source_root}/images/' '
  param+='-a partialsdir='$(pwd)/modules/${source_root}/pages/_partials/' '
  param+='-a revnumber='${branch}' '
  param+='-a revdate="'${release_date}'" '