Skip to content

Commit

Permalink
Documentation: extend update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfgangmm committed Oct 11, 2024
1 parent eda837f commit f7362ae
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions data/doc/documentation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4483,8 +4483,16 @@ declare function config:collection-config($collection as xs:string?, $docUri as
<procedure>
<step><para>Replace <filename>modules/lib</filename></para></step>
<step><para>Check <filename>expath-pkg.xml</filename> for changed dependencies</para></step>
<step>
<para>Have a look at the other XQuery files in <filename>modules</filename>: new releases
may introduce new files here, which should be copied. Also check if any of the other files
here were updated, e.g. <filename>facets.xql</filename>, <filename>nlp-config</filename>
etc. Make sure to keep your own changes.</para>
</step>
<step><para>Build your app and try to install it. This may result in errors to fix (e.g. variables/functions missing in <filename>modules/config.xqm</filename>.</para></step>
<step><para>Once the app starts and is functionally working, you can look into replacing other files, e.g. the global CSS file in <filename>resources/css/theme.css</filename></para></step>
<step><para>Once the app starts and is functionally working, you can look into replacing other files, e.g.
the global CSS file in <filename>resources/css/theme.css</filename> or the javascript
utility files in <filename>resources/scripts</filename>.</para></step>
</procedure>

<para>For apps created with TEI Publisher 6 updating to 7 or 8 requires only small modifications.
Expand All @@ -4497,10 +4505,13 @@ declare function config:collection-config($collection as xs:string?, $docUri as
configuration module (<filename>modules/config.xqm</filename>). While this is unproblematic in most environments, it causes a silent failure in windows
when compiling an ODD. The underlying reason is that <filename>config.xqm</filename> itself imports a large number of other modules, leading to
recursive imports, which eXist-db is currently unable to resolve properly on Windows. </para>
<para>In general, importing all of <filename>config.xqm</filename> into the ODD generated code is usually unnecessary as most of the settings are not needed and creates an
overhead. Version 4.0.1 of <emphasis>tei-publisher-lib</emphasis> therefore no longer imports <filename>config.xqm</filename> by default. Instead, you can configure the modules to be made
available via <filename>odd/configuration.xml</filename> (or <filename>resources/odd/configuration.xml</filename>). By default, TEI Publisher 9.1 imports the dedicated
<filename>modules/odd-global.xqm</filename>.</para>
<para>In general, importing all of <filename>config.xqm</filename> into the ODD generated code
is usually unnecessary as most of the settings are not needed. This creates an overhead.
Version 4.0.1 of <emphasis>tei-publisher-lib</emphasis> therefore no longer imports
<filename>config.xqm</filename> by default. Instead, you can configure the modules to be
made available via <filename>odd/configuration.xml</filename> (or
<filename>resources/odd/configuration.xml</filename>). By default, TEI Publisher 9.1
imports the dedicated <filename>modules/odd-global.xqm</filename>.</para>
<para>To update follow the generic instructions above.</para>
<orderedlist>
<listitem>
Expand Down

0 comments on commit f7362ae

Please sign in to comment.