Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -7,26 +7,41 @@
7	7
8	8	== How to enter software metadata manually ==
9	9
10		-Fields marked with an asterisk (*) are required. When you are done, just contact the curators by answering to your ticket email.
	10	+You will receive an email after the curator has created a space for you in the Knowledge Graph. This email contains a link to a software instance and a software version instance in your Space. These are already linked to each other (by the attribute "Has Version" of the software instance).
11	11
12		-(% id="cke_bm_36775S" style="display:none" %) (%%)To register your software, you will need to input information for the instance "Software" and for  "Software version".
	12	+**Before explaining the editing process, here are some helpful links:**
13	13
14		-After clicking the link for software sent to you, you will see an instance editor view like below, where you can add all relevant information on your software. Please note that fields marked with an asterisk (*) are mandatory.
	14	+* A description of the fields of the software and software version instances and values that these fields may take: [[https:~~/~~/humanbrainproject.github.io/openMINDS/v2/core/v3/products/softwareVersion.html>>url:https://humanbrainproject.github.io/openMINDS/v2/core/v3/products/softwareVersion.html]] and [[https:~~/~~/humanbrainproject.github.io/openMINDS/v2/core/v3/products/software.html>>url:https://humanbrainproject.github.io/openMINDS/v2/core/v3/products/software.html]]
	15	+* additional information for each attribute: [[https:~~/~~/github.com/bweyers/HBPVisCatalogue/wiki/Attribute-Descriptions>>url:https://github.com/bweyers/HBPVisCatalogue/wiki/Attribute-Descriptions]]
	16	+* a detailed description of the software features: [[https:~~/~~/github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features>>url:https://github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features]]
15	15
16		-When finished with the software view, repeat the same for the software version.
	18	+**Editing the software and software version instances:**
17	17
18		-[[image:image-20220323152326-1.png||height="1062" width="1023"]]
	20	+To register your software, you will need to input information for the instance "Software" and for  "Software version". After clicking the links in your email, you will see an instance editor view like below:
19	19
	22	+[[image:guide1.JPG]]
20	20
21		-After you have entered and information on the software, **do not forget to save your changes!**
	24	+As you can see in the screenshot above, some fields are marked with an asterisk (*). These are required. Keep in mind that this is how you present your software publicly to potential end-users or other researchers. Therefore it would be nice if as many fields as possible are filled in.
22	22
23		-**-> **[[image:image-20220323121238-10.png||height="170" width="382"]]
	26	+Some fields can be of different types, such as the field "developer" and "Full documentation". In the case of developer it is possible to enter a person or an organisation. The possible types are selectable on the right above the respective field, as shown in the following screenshots:
24	24
	28	+[[image:guideDev.JPG||height="109" width="600"]]
	29	+
	30	+[[image:guide21.JPG||height="142" width="600"]]
	31	+
	32	+If you are not sure which type to use, please refer to the descriptions linked above or contact the curator.
	33	+
	34	+After you have entered your information on the software, **do not forget to save your changes **(see screenshot below) and contact the curator.
	35	+
	36	+[[image:guide4.JPG||height="189" width="400"]]
	37	+
	38	+The curators will check the new software instances and move them to the correct space.
	39	+
25	25	=== How to update an existing Software instances ===
26	26
27	27	If you have registered a software previously, updating means adding a new instance of type "Software version". Curators will later link it to the existing instance of type "Software".
28	28
29		-To make updating easier, we have already placed a copy of your last software version instance in the KG space that belongs to this collab. You can use that copy and just change the fields that require changes. Again - if you made all changes that you consider necessary, let the curator know via the ticket assigned with this case.
	44	+To make updating easier, we have already placed a copy of your last software version instance in the KG space that was created for you. You can use that copy and just change the fields that require changes. Again - if you made all changes that you consider necessary, let the curator know via email or the ticket assigned with this case.
30	30
31	31	== How to upload software metadata programmatically ==
32	32