Merge branch 'release/4.1'

* release/4.1: (144 commits) Add info on XDITA grammar update Remove `mark` highlighting from release summary Add missing list item $depth to variable IDs Sync related links changes from build to projects Remove strict processing mode from docs builds Adjust ToC indentation Fix whitespace in link text Sort links to updated docs topics Add details on 4.1 issues tagged “bug” Add details on 4.1 issues tagged “enhancement” Update release summary & spec references Wrap plug-in development features in section Add details on DITA 2.0 support Rearrange Markdown updates section Clarify differences in Markdown map formats Push changes from reference/markdown to wiki subrepo Implement review feedback on plug-in version Push changes from reference/markdown to wiki subrepo Use present tense consistently in syntax reference Add details on Markdown processing updates ...
dita-ot · Jun 22, 2023 · a292571 · a292571
2 parents 7bd2882 + e89e27b
commit a292571
Show file tree

Hide file tree

Showing 72 changed files with 2,827 additions and 1,286 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -18,3 +18,7 @@ trim_trailing_whitespace = true
 
 [*.md, *.mdown, *.markdown]
 trim_trailing_whitespace = false
+
+[.git/config]
+# Prevent mixed indentation in Git config (Git commands insert tabs)
+indent_style = tab
diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml
@@ -23,7 +23,7 @@ jobs:
           ref: ${{ github.ref }}
 
       - name: Prettify code
-        uses: creyD/prettier_action@v4.2
+        uses: creyD/prettier_action@v4.3
         with:
           # This part is also where you can pass other options, for example:
           prettier_options: --write **/*.{css,dita*,json,md,scss,xml,yaml,yml}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -11,6 +11,8 @@ on:
       docs-tag:
         description: 'Docs tag'
         required: true
+  repository_dispatch:
+    types: [release]
 
 jobs:
   deploy:
@@ -19,18 +21,29 @@ jobs:
       WEBSITE_PLUGIN_BRANCH: 'master'
       DITA_OT_VERSION: '4.0.1'
     steps:
+      - name: Parse arguments
+        run: |
+          if [[ -n "${{ github.event.client_payload.dita_ot_version }}" ]]; then
+            readonly TOKENS=($(echo "${{ github.event.client_payload.dita_ot_version }}" | tr '.' ' '))
+          else
+            readonly TOKENS=($(echo "${{ github.event.inputs.dita-ot-version }}" | tr '.' ' '))
+          fi
+          echo "RELEASE=${TOKENS[0]}.${TOKENS[1]}" >> $GITHUB_ENV
+          if [[ -n "${{ github.event.client_payload.docs_tag }}" ]]; then
+            echo "TAG=${{ github.event.client_payload.docs_tag }}" >> $GITHUB_ENV
+          else
+            echo "TAG=${{ github.event.inputs.docs-tag }}" >> $GITHUB_ENV
+          fi
+
       - name: Check out docs
         uses: actions/checkout@v3
         with:
-          ref: ${{ github.event.inputs.docs-tag }}
-      - name: Get variables
+          ref: ${{ env.TAG }}
+
+      - name: Set variables
         run: |
-          TOKENS=($(echo $VERSION | tr '.' ' '))
-          echo "RELEASE=${TOKENS[0]}.${TOKENS[1]}" >> $GITHUB_ENV
           echo "GITHUB_SHA_SHORT=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
 
-        env:
-          VERSION: ${{ github.event.inputs.dita-ot-version }}
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
@@ -85,7 +98,7 @@ jobs:
           RELEASE_DITA_OT: ${{ github.workspace }}/src-dita-ot/dita-ot-${{ github.event.inputs.dita-ot-version }}
 
       - name: Create release PR
-        uses: peter-evans/create-pull-request@v4
+        uses: peter-evans/create-pull-request@v5
         with:
           branch: release/${{ github.event.inputs.dita-ot-version }}
           title: 'Update site for ${{ github.event.inputs.dita-ot-version }}'

diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 # This file specifies intentionally untracked files that Git should ignore
 
 ## Directories generated during builds
+.gradle/
 build/
 logs/
 node_modules/

diff --git a/README.md b/README.md
@@ -125,7 +125,7 @@ If you'd like to check whether your changes are formatted correctly, or format t
 [4]: https://www.dita-ot.org
 [5]: https://github.com/dita-ot/dita-ot
 [6]: https://s3-eu-west-1.amazonaws.com/dita-ot/dita-ot-develop.zip
-[7]: https://github.com/dita-ot/dita-ot/blob/develop/build.gradle#L181-L191
+[7]: https://github.com/dita-ot/dita-ot/blob/develop/build.gradle#L181-L192
 [8]: .github/CONTRIBUTING.md
 [9]: https://github.com/dita-ot/docs/wiki/Coding-guidelines
 [10]: https://github.com/dita-ot/docs/wiki/Git-workflow#best-practices

diff --git a/build.gradle b/build.gradle
@@ -103,7 +103,6 @@ task pdf(type: DitaOtTask, dependsOn: autoGenerate) {
         property(name: 'args.gen.task.lbl', value: 'YES')
         property(name: 'include.rellinks', value: '#default external')
         property(name: 'outputFile.base', value: 'userguide')
-        property(name: 'processing-mode', value: 'strict')
         property(name: 'theme', value: "${projectDir}/samples/themes/dita-ot-docs-theme.yaml")
     }
 }
@@ -124,7 +123,6 @@ task html(type: DitaOtTask, dependsOn: autoGenerate) {
         property(name: 'args.rellinks', value: 'noparent')
         property(name: 'html5.toc.generate', value: 'no')
         property(name: 'nav-toc', value: 'partial')
-        property(name: 'processing-mode', value: 'strict')
     }
 }
 
@@ -140,7 +138,6 @@ task htmlhelp(type: DitaOtTask, dependsOn: autoGenerate) {
         property(name: 'args.csspath', value: 'css')
         property(name: 'args.cssroot', value: "${projectDir}/resources/")
         property(name: 'args.gen.task.lbl', value: 'YES')
-        property(name: 'processing-mode', value: 'strict')
     }
 
     doLast {

diff --git a/extension-points/plugin-extension-points-general.dita b/extension-points/plugin-extension-points-general.dita
@@ -93,7 +93,7 @@
             conaction="pushreplace"
             conref="extension-points-in-org.dita.base.dita#org.dita.base-ext/dita.transtype.print.desc"
           >Defines a
-            transformation as a print type.<draft-comment author="Kristen Eberlein" time="31 March 2013">What does this
+            transformation as a print type. <draft-comment author="Kristen Eberlein" time="2013-03-31">What does this
               actually do? Does this interact with using the deprecated <xmlatt>print</xmlatt>
               attribute?</draft-comment></dd>
         </dlentry>

diff --git a/extension-points/plugin-extension-points.dita b/extension-points/plugin-extension-points.dita
@@ -23,4 +23,37 @@
       </keywords>
     </metadata>
   </prolog>
+  <refbody>
+    <section>
+      <p>Depending on which extension points you use, your custom code will either run whenever output is generated,
+        before or after certain processing stages, or only with certain transformation types.</p>
+    </section>
+    <example>
+      <title>Extension points govern when code runs</title>
+      <ul>
+        <li>To run a custom Ant target after the pre-processing stage regardless of transformation type, use
+            <parmname>depend.preprocess.post</parmname></li>
+        <li>To run an Ant target before the <codeph>copy-html</codeph> step when generating HTML output, use
+            <parmname>depend.preprocess.copy-html.pre</parmname></li>
+      </ul>
+    </example>
+    <example>
+      <title>Checking the transformation type</title>
+      <p>If you want to isolate your custom code so it only runs when output is generated for a particular
+        transformation type, you can define a condition that checks the transtype before running the custom code.</p>
+      <codeblock
+        outputclass="language-xml normalize-space show-line-numbers show-whitespace"
+      >&lt;!-- Add a condition that checks the transtype -->
+&lt;condition property="isYourTranstype">
+  &lt;matches pattern="your.transtype" string="${transtype}"/>
+&lt;/condition></codeblock>
+      <p>You can then check this condition before running your custom code:</p>
+      <codeblock
+        outputclass="language-xml normalize-space show-line-numbers show-whitespace"
+      >&lt;!-- Check the condition before running your target -->
+&lt;target name="your-target" if="${isYourTranstype}">
+  ⋮
+&lt;/target></codeblock>
+    </example>
+  </refbody>
 </reference>
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -205,6 +209,12 @@ set -- \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.

diff --git a/gradlew.bat b/gradlew.bat
@@ -14,7 +14,7 @@
 @rem limitations under the License.
 @rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +25,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,7 +41,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
 
 :fail
 rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
 rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
 
 :mainEnd
 if "%OS%"=="Windows_NT" endlocal

diff --git a/index.dita b/index.dita
@@ -36,7 +36,8 @@
           along with information on publishing DITA content from a containerized environment.</li>
         <li outputclass="list-group-item list-group-item-action">
           <xref keyref="input-formats" outputclass="stretched-link"/> provides information on supported input formats,
-          including standard DITA XML, Markdown and the Lightweight DITA formats (XDITA, MDITA and HDITA).</li>
+          including standard DITA XML, Markdown and the Lightweight DITA formats (<term>XDITA</term>, <term>MDITA</term>
+          and <term>HDITA</term>).</li>
         <li outputclass="list-group-item list-group-item-action">
           <xref keyref="output-formats" outputclass="stretched-link">Output formats</xref> describes the core
           transformations that convert DITA to other formats.</li>