Release 4.0

.gitignore

@@ -14,7 +14,9 @@ __pycache__/
 # internal
 edoc/resources/xsl/xspec/
 .existdb.json
+edoc/rest2/v2.json
 
 # node-reladted stuff
 node_modules/
 
+.codex

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "edoc/include/xstring"]
-	path = edoc/include/xstring
-	url = https://github.com/dariok/XStringUtils
 [submodule "edoc/include/wdbmeta"]
 	path = edoc/include/wdbmeta
 	url = https://github.com/dariok/wdbmeta

README.md

@@ -6,6 +6,47 @@ This framework still lacks a good name. If you have an idea, please let me know!
 
 ## Incompatible changes
 
+### 25Q3
+
+Release 25Q3 dropped support for more unsued functions:
+- `wdb:getFilePath ( $id as xs:string )`: use the map from `wdbFiles:getFullPath` instead
+- the default layout of all `resources` collections has changed to group files by type. This also affects the main
+  project specific overrides, i.e. `project.js` and `project.css`. An XQuery is provided to move all files to their
+  appropriate new locations (TODO: add file name here).
+  This also affects `edoc/data/resources` and `edoc/resources` so you might have to change imports manually if you make
+  use of any file in these collections.
+
+Changes in standard behaviour
+- sub-projects will now make use of process inheritance; i.e., they only define empty `processes` with no `command`. A
+  `command` is then picked by traversing up through parent `wdbmeta.xml` (i.e., one that is pointed to by a
+  `struct/import`; worst case: data). This way, you can still have  different `command` defined for sub-projects (and
+  their children) but do not need to change the path for every sub-project.
+- as part of this, no XSLTs are being copied to `{$subproject}/resources` as inheritance is now the standard. This way,
+  surplus XSLTs do not have to be deleted or kept up to date. As said above, it is still possible to create a `command`
+  for this sub-project tree and create specific XSLTs (usually by including the main XSLTs)
+- standard XSLTs for a new project are now bare: they only include `/edoc/data/resources/xslt/{$currentFileName}`, and
+  `tei-common.xsl` (unless it’s common itself).
+
+### 24Q4
+
+Release 24Q4 dropped another set of functions that were unused:
+- `wdb:getEdFromFileID( $id as xs:string )`: `(wdbFiles:getFullPath($id))?projectPath` returns the base path to `wdbmeta.xml`
+- `wdb:getMetaElementFromEd ( $ed as xs:string )`: use
+  `doc( (doc("/db/apps/edoc/index/project-index.xml")/id($ed))/@path || '/wdbmeta.xml' )/id($ed)[self::meta:projectMD]` instead
+- `wdb:getMetaFile( $pathToEd )`: `(wdbFiles:getFullPath($ed))?projectPath` returns the base path to `wdbmeta.xml`
+- `wdb:getProjectPathFromId ( $ed )`:  use `(wdbFiles:getFullPath($ed))?projectPath` instead
+
+### 24Q2
+
+Release 24Q2 dropped functions `wdb:getEdPath( $ed as xs:string , $absolute as xs:boolean() )`,
+`wdb:getEdPath( $ed as xs:string )`, and `wdb:findProjectXQM( $project )`. These queries can be replaced by
+`(wdbFiles:getFullPath($id))` which returns a map with `projectPath` (the path to the project, i.e. the collection where
+`wdbmeta.xml`¹ is stored), `collectionPath` (for the subcollection where a file is actually located), `mainProject` for
+the path to the project containing `project.xqm`, and `fileName`.
+1) (24Q4): this corrects a typo as previous versions incorrectly read `project.xqm`.
+
+### 24Q1
+
 Release 24Q1 dropped support for METS-based projects. As METS files can have a number of very different ways of encoding
 information, especially when it comes to behaviours, native support is hard to achieve. At the same time, most
 installations use wdb+’s native wdbmeta system as this is what the admin functions work with.
@@ -64,9 +105,11 @@ into `/db/apps/edoc` and want to put your projects into `/db/apps/edoc/data/your
         <files>
             <file path="pathTo.xml" xml:id="xml-id" />
         </files>
-        <process target="html">
-            <command type="xsl">/db/apps/edoc/resources/xsl/tei-transcript.xsl</command>
-        </process>
+        <processes>
+            <process target="html">
+                <command type="xsl">/db/apps/edoc/resources/xsl/tei-transcript.xsl</command>
+            </process>
+        </processes>
         <struct label="1722" order="1722">
             <view file="xml-id" label="Title of File" />
         </struct>
@@ -89,12 +132,15 @@ See the Wiki for details!
 
 * HAB Wolfenbüttel
   * Editionsprojekt Karlstadt
-* ACDH Wien
-  * Wien[n]erisches Diarium Digital
-  * Repertotium frühneuzeitlicher Rechtsquellen
-  * Protokolle der Sitzungen der Gesamtakadmie
 * Akademie der Wissenschaften, Heidelberg
   * Theologenbriefwechsel
 * ULB Darmstadt
+  * TUEditions
+  * WDM
 
 If you use wdbplus for your editions, please drop me a message so I can add you to this list.
+
+## Sponsoring
+
+Development of wdb+ is chiefly done in projects funded by DFG and the German BMBF.
+Additionally, we would like to say thank you to BrowserStack for giving us sponsored access!

build.xml

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project>
-  <xmlproperty file="edoc/expath-pkg.xml"/>
-
-  <target name="clean">
-    <delete dir="edoc/build/" />
-    <delete dir="build" />
-  </target>
-
-  <target name="compile" depends="clean">
-    <ant dir="edoc" antfile="build.xml" />
-    <move file="edoc/build" tofile="build" />
-  </target>
-
-  <target name="docker" depends="compile">
-    <copy file="build/${package(abbrev)}-${package(version)}.xar" tofile="docker/wdb.xar" />
-    <exec executable="docker" dir="docker">
-      <arg value="build" />
-      <arg value="--tag=wdbplus" />
-      <arg value="." />
-    </exec>
-  </target>
+   <xmlproperty file="edoc/expath-pkg.xml"/>
+   <property name="project.version" value="${package(version)}"/>
+   <property name="project.app" value="wdb"/>
+   <property name="build.dir" value="build"/>
+
+   <target name="clean">
+      <delete dir="build" />
+   </target>
+
+   <target name="compile" depends="clean">
+      <ant dir="edoc" antfile="build.xml" />
+      <move file="edoc/build" tofile="build" />
+   </target>
+
+   <target name="docker" depends="compile">
+      <copy file="build/${package(abbrev)}-${package(version)}.xar" tofile="docker/wdb.xar" />
+      <exec executable="docker" dir="docker">
+         <arg value="build" />
+         <arg value="--tag=wdbplus" />
+         <arg value="." />
+      </exec>
+   </target>
 </project>

edoc/admin/admin.xqm

@@ -2,73 +2,61 @@ xquery version "3.1";
 
 module namespace wdbAdmin = "https://github.com/dariok/wdbplus/Admin";
 
-import module namespace console   = "http://exist-db.org/xquery/console"       at "java:org.exist.console.xquery.ConsoleModule";
-import module namespace templates = "http://exist-db.org/xquery/html-templating";
-import module namespace wdb       = "https://github.com/dariok/wdbplus/wdb"    at "/db/apps/edoc/modules/app.xqm";
-import module namespace wdbErr    = "https://github.com/dariok/wdbplus/errors" at "/db/apps/edoc/modules/error.xqm";
+import module namespace config   = "https://github.com/dariok/wdbplus/config" at "../modules/wdb-config.xqm";
+import module namespace wdbErr   = "https://github.com/dariok/wdbplus/errors" at "../modules/error.xqm";
+import module namespace wdbm     = "https://github.com/dariok/wdbplus/model"  at "../modules/model.xqm";
 
-declare namespace meta = "https://github.com/dariok/wdbplus/wdbmeta";
-declare namespace sm   = "http://exist-db.org/xquery/securitymanager";
+declare namespace meta      = "https://github.com/dariok/wdbplus/wdbmeta";
+declare namespace sm        = "http://exist-db.org/xquery/securitymanager";
+declare namespace templates = "http://exist-db.org/xquery/html-templating";
+declare namespace wdb       = "https://github.com/dariok/wdbplus/wdb";
 
 (:~
- : populate the model for functions pages (similar but not identical to wdb:populateModel)
+ : populate the model for admin pages
  : 
  : @param $ed The ID of a _project_
  : @return    The model
  :)
 declare
-    %templates:default("ed", "")
-function wdbAdmin:start ( $node as node(), $model as map(*), $ed as xs:string ) {
-  try {
-    let $pathToEd := if ( $ed = "" )
-      then $wdb:data
-      else wdb:getEdPath($ed, true())
-
-    (: The meta data are taken from wdbmeta.xml :)
-    let $infoFileLoc := wdb:getMetaFile($pathToEd)
-      , $title := normalize-space((doc($infoFileLoc)//meta:title)[1])
-
-    return map {
-      "ed":          if ( $pathToEd = $wdb:data ) then "data" else $ed,
-      "infoFileLoc": $infoFileLoc,
-      "page":        substring-after(request:get-uri(), "admin/"),
-      "pathToEd":    $pathToEd,
-      "title":       $title,
-      "auth":        sm:id()/sm:id
-    }
-  } catch * {
-    util:log("error", "No collection found for project ID " || $ed),
-    map {
-      "ed": ""
-    }
-  }
+    %templates:default("ed", "data")
+function wdbAdmin:start ( $node as node(), $model as map(*), $ed as xs:string ) as item()* {
+  wdbm:populateModel((), $ed, "", "", "")
 };
 
-declare function wdbAdmin:getEd ( $node as node(), $model as map(*) ) as element(meta) {
-  <meta name="ed" content="{ $model?ed }" />
-};
+declare function wdbAdmin:getEd ( $node as node(), $model as map(*) ) as item()+ {(
+  comment { "Created in admin.xqm for "|| $node/@data-template },
+  <meta name="ed" content="{ $model?ed }" />,
+  <meta name="path" content="{ $model?pathToEd }" />
+)};
 
-declare function wdbAdmin:heading ($node as node(), $model as map(*)) {
+declare function wdbAdmin:heading ( $node as node(), $model as map(*) ) as element()+ {
   let $opts := if (request:get-parameter('job', '') != '')
     then <span class="dispOpts"><a href="global.html">globale Optionen</a></span>
     else ()
 
   return (
+
     <h1>{
-      if ($model?page = 'admin.html')
-      then "Admin-Seite"
-      else if ($model?page = 'global.html')
-      then "Globale Einstellungen"
-      else if ($model?ed = '')
-      then "Projekte"
-      else ("Projekt ", <i>{$model?title}</i>, " (" || $model?ed || ")")
+      comment { "Created in admin.xqm for "|| $node/@data-template },
+      if ($model?page = 'admin.html') then
+        "Admin-Seite"
+      else if ($model?page = 'global.html') then
+        "Globale Einstellungen"
+      else if ($model?ed = '') then
+        "Projekte"
+      else (
+        "Projekt ",
+        <i>{$model?title}</i>,
+        " (" || $model?ed || ")"
+      )
     }</h1>,
     $opts
   )
 };
 
-declare function wdbAdmin:getAside ($node as node(), $model as map(*)) as element() {
+declare function wdbAdmin:getAside ( $node as node(), $model as map(*) ) as element() {
   <aside>
+    comment { "Created in admin.xqm for "|| $node/@data-template }
     <h3>Funktionen</h3>
     {
       switch ($model?page)
@@ -88,11 +76,12 @@ declare function wdbAdmin:getAside ($node as node(), $model as map(*)) as elemen
   </aside>
 };
 
-declare function wdbAdmin:css ( $node as node(), $model as map(*) ) as element()* {
-  if ( unparsed-text-available($wdb:data || "/resources/wdb.css") )
-    then <link rel="stylesheet" type="text/css" href="../data/resources/wdb.css" />
+declare function wdbAdmin:css ( $node as node(), $model as map(*) ) as item()* {
+  comment { "Created in admin.xqm for "|| $node/@data-template },
+  if ( unparsed-text-available($config:data || "/resources/css/wdb.css") )
+    then <link rel="stylesheet" type="text/css" href="$global/css/wdb.css" />
     else (),
-  if ( unparsed-text-available($wdb:data || "/resources/admin.css") )
-    then <link rel="stylesheet" type="text/css" href="../data/resources/admin.css" />
+  if ( unparsed-text-available($config:data || "/resources/css/admin.css") )
+    then <link rel="stylesheet" type="text/css" href="$global/css/admin.css" />
     else ()
 };

edoc/admin/directoryForm.html

@@ -1,29 +1,27 @@
 <div data-template="templates:surround" data-template-with="templates/admin.html" data-template-at="container">
-  <h1>Funktion</h1>
-  <form action="#" method="post">
-    <fieldset id="selectTask">
-      <input type="radio" name="task" id="do">Verzeichnis ohne Eintragen in wdbmeta</input><br/>
-      <input type="radio" name="task" id="dm">Verzeichnis mit Eintragen in wdbmeta</input><br/>
-      <input type="radio" name="task" id="fo">Datei(en) ohne Eintragen in wdbmeta</input><br/>
-      <input type="radio" name="task" id="fi" checked="checked">Datei(en) mit Eintragen in wdbmeta</input><br/>
+   <h1>Funktion</h1>
+   <form action="#" method="post">
+      <fieldset id="selectTask">
+         <input type="radio" name="task" id="dm">Verzeichnis(se) (relative Pfade)</input><br/>
+         <input type="radio" name="task" id="fi" checked="checked">Datei(en)</input>
     </fieldset>
-    <fieldset id="selectTarget">
-      <label>Collection: </label>
-      <pre/>
-      <br/>
-      <label>Zielcollection auswählen: </label>
-      <select name="target">
-        <option/>
-      </select>
-    </fieldset>
-    <fieldset id="selectInputDir">
-      <label>Datei auswählen: </label>
-      <input type="file" id="picker" name="fileList" multiple="multiple" />
-    </fieldset>
-    <input type="submit" disabled="disabled"/>
-  </form>
-  <p>
-    <img src="../resources/FhHRx.gif" style="display: none;" alt="loading"/>
-  </p>
-  <table id="results"/>
+      <fieldset id="selectTarget">
+         <label>Collection: </label>
+         <pre/>
+         <br/>
+         <label>Zielcollection auswählen: </label>
+         <select name="target">
+            <option/>
+         </select>
+      </fieldset>
+      <fieldset id="selectInputDir">
+         <label>Datei auswählen: </label>
+         <input type="file" id="picker" name="fileList" multiple="multiple" />
+      </fieldset>
+      <input type="submit" disabled="disabled"/>
+   </form>
+   <p>
+      <img src="$shared/images/FhHRx.gif" style="display: none;" alt="loading"/>
+   </p>
+   <table id="results"/>
 </div>