Update help

[Claudia-WE]

Within this issue todos on the HS Documentation shall be documented.

Intro:
There are some parts of the help that are outdated - others need an update. These are the pages/things affected from my point of view and those that were already collected in a different ticket. If anyone finds other parts that need to be reviewed - please don't hesitate to add them.

Documentation routine

Report as enumeration
Report IN PROGRESS [IN PROGRESS (your acronym) ] to indicate when you start with the specific doc change
Report DONE [DONE (your acronym) ] to indicate when the specific doc change has been done and comitted
For each release a new HS Doc Task issue will be created by @Claudia-WE

List of required changes on HS Documentation

1. http://help.halestudio.org/latest/topic/eu.esdihumboldt.hale.doc.user/html/reference/import/xml_schema.html?cp=0_6_2_0_2

• In the troubleshooting part, the proxy settings in hale studio are explained. As a lot of users need to set them, I would consider moving it to an own/different part where users would search for it.

2. http://help.halestudio.org/latest/topic/eu.esdihumboldt.hale.doc.user/html/reference/import/jdbc.html?cp=0_6_2_0_8

• information on how to import a schema and data using an SQL query is missing.

3. http://help.halestudio.org/latest/topic/eu.esdihumboldt.cst.doc.functions/functions/eu.esdihumboldt.hale.align.join.html?cp=0_6_3_0_7

• needs more documentation/examples according to existing Jira ticket

4. http://help.halestudio.org/latest/topic/eu.esdihumboldt.cst.doc.functions/functions/eu.esdihumboldt.cst.functions.groovy.html?cp=0_6_3_1_9 and http://help.halestudio.org/latest/topic/eu.esdihumboldt.cst.doc.functions/functions/eu.esdihumboldt.cst.functions.groovy.greedy.html?cp=0_6_3_1_10

• The parts for "Groovy Script" and "Groovy Script (greedy)" seem to be the same. I would suggest to delete the "Groovy script (greedy)" section from "Groovy Script" and only explain the differences (maybe also with an example) in "Groovy script (greedy)".
  

5. http://help.halestudio.org/latest/topic/eu.esdihumboldt.cst.doc.functions/functions/eu.esdihumboldt.hale.align.inline.html?cp=0_6_3_1_20

• Some more description on what the function does should be added

6. add a new section on the deegree configuration export (also described in

• deegree configuration export is not documented in the help deegree configuration export is not documented in the help #753 - this could be closed once the bullet point is done)

7. http://help.halestudio.org/latest/topic/eu.esdihumboldt.cst.doc.functions/functions

• The meaning of "withTransformationContext" when working with collectors does not seem to be clear to most of the users. It is needed when several operations are executed that are linked to each other in a way that they can have a negative influence on each other. E. g. if the collector is filled with A, read and changed with B and only read with C, it is important to use it to make sure, that the operations do not corrupt each other.
• The helper function to create a context ( _.context.collector()) can be used in a context without adding a parameter - in this case, transformationContext is used automatically.

INPROGRESS (fa) 31. Add function explanations for:

Create
Retype
Ordinates to Point
Calculate Length
Calculate Area
Centroid
Compute Extent
Reproject Geometry
Generate sequential ID
Date extraction
Rename
Generate Unique Id
Network expansion
Assign
Generate Unique ID
Date Extraction
XPath expression
SQL expression
Inline transformation

8. Improve description of _.geom.spatialIndexQuery function

• According to https://haleconnect.com/#/transformation/org/163/1ca2a4b1-83db-473d-b1fb-d9af9e3caa21/tasks/f99i, it is not clear to customers what it does.
• The documentation is available via the UI and does not have a dedicated page in the help if I see that correctly:
  grafik
  

9. Add information about base alignments

10. Customer feedback from EN open workshop 2021-02-12: Please add documentation / tutorial on how to create combined schemas (source and target) for use in hale studio.

11. Question in Forum: What is the difference between base alignment and alignment? Check whether this information is included in the help pages. If not, include.

12. Add documentation about the generation of .hsd files including a description of what they are and how they can be used.

13. Add documentation about the fact that autofill rules are re-executed if the files of an existing dataset are updated: https://www.wetransform.to/help/en/help-page-category-setup-haleconnect/help-page-subcategory-setup-haleconnect-thememetadata/2015/02/10/theme-edit-metadata/

14. Add part about Decimal number format pattern also to other GML writers than GML (Feature Collection). I tested it for GML (WFS Feature Collection) here and it is working for it, too, but is missing in the documentation. I assume it is functional for all GML writers.

15. After introducing the new feature "Add ability to skip-N-lines when reading CSV and XLS files" (ING-3086) the screenshot and description of the import dialog need to be updated (e.g. here).

16. Add additional information about loading XLS with multiple sheets

17. Add additional information about the GeoJson Reader

[florianesser]

@Kate-Lyndegaard Do we need to carry this forward to the next release (5.1)?

[Kate-Lyndegaard]

@florianesser Yes, I think that makes sense.

[thorsten-reitz]

Since 5.1.0 has also been released, should this ticket be closed?

[JohannaOtt]

I'd say only once the content is carried forward to a respective issue for the next release as the documentation is still missing the content mentioned.

[github-actions]

This issue has been automatically marked as stale because it has not had activity in the last 60 days. It will be closed in two weeks if no further activity occurs. Thank you for your contributions.

[JohannaOtt]

@Kate-Lyndegaard Do we need to carry this forward to the next release (5.3)?

[Kate-Lyndegaard]

@JohannaOtt Yes, I think that's a good idea.

[github-actions]

This issue has been automatically marked as stale because it has not had activity in the last 60 days. It will be closed in two weeks if no further activity occurs. Thank you for your contributions.