update current Readme for Release 2.0
peterstadler opened this issue · comments
This issue is about updating the current help pages to (only) fix/remove outdated information.
Further rework of the help pages is subject of issue #69
The individual pages to check are:
General help
- Structure and scope of MerMEId documents
- Workflow
- MerMEId basics
- Entering dates
- Using the attribute editor
- Using the code inspector
- Special characters (general problem: #193 )
- Displaying or printing all records (fixed related problem: #188 )
- Changing many or all files: Batch transform XML files in the dataase (proposal to remove this - #195 )
- Tools for generating indexes
- FAQ – Frequently asked questions
Tutorial
I tried to start with Tools for generating indexes. And I ran into several problems:
In the first example, it is still the old addressing:
http://my_server_name.org/storage/tools/title_index?c=CNW
It should be: http://my_server_name.org/modules/tools/title_index.xq?c=CNW. I have also added the .xq because it is somehow easier to understand. Then there is the question of whether all links should have the collection query built in.
And now for the bad part, none of the queries work because in at least our mermeid-instances, the old file path is still used everywhere:
declare variable $database := "/db/dcm";
but here it should be db/apps/data_repo. If I address the path correct, at least title_index.xq works, but some of the others still produce errors. Since each user can give the data repo its own name, I don't quite know how to generalize/variabilize this...
(only) fix/remove outdated information -> Indexing is an important part, it would be a pity if we had to skip the whole section/function now...
Section "Displaying or printing all records"
- when trying the linked form for the instance https://mermeid.edirom.de (https://mermeid.edirom.de/modules/merge/merge_settings.xq) I get the error:
/db/apps/mermeid/modules/merge/merge.xqexerr:ERROR Exception while transforming node: I/O error reported by XML parser processing file:/properties.xml: /properties.xml (No such file or directory) [at line 83, column 16]
Section "Changing many or all files: Batch transform XML files in the dataase"
Closing at today's community meeting since everything is done 🎉