Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update current Readme for Release 2.0 #181

Closed
peterstadler opened this issue Nov 16, 2023 · 5 comments
Closed

update current Readme for Release 2.0 #181

peterstadler opened this issue Nov 16, 2023 · 5 comments
Assignees
Milestone

Comments

@peterstadler
Copy link
Member

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

@peterstadler peterstadler added this to the Release 2.0 milestone Nov 16, 2023
@peterstadler
Copy link
Member Author

peterstadler commented Nov 23, 2023

The individual pages to check are:

General help

Tutorial

@gucl-mu
Copy link
Collaborator

gucl-mu commented Nov 23, 2023

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...

@daniel-jettka
Copy link

Section "Displaying or printing all records"

@daniel-jettka
Copy link

Section "Changing many or all files: Batch transform XML files in the dataase"

peterstadler added a commit that referenced this issue Jan 18, 2024
Minor fixes and additions in manual pages; updated footers for manual pages (part of #181)
@peterstadler
Copy link
Member Author

Closing at today's community meeting since everything is done 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants