Changes for page Attribute descriptions

Last modified by adavison on 2024/11/08 17:15

From version 2.1
edited by jan
on 2022/11/22 14:42
Change comment: There is no comment for this version
To version 3.1
edited by jan
on 2022/11/22 14:46
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,9 +1,8 @@
1 -=== SOFTWARE ===
1 += SOFTWARE {{id name="software"/}} =
2 2  
3 3  * **Full Name:** Whole, non-abbreviated and descriptive name (title) for this software.
4 4  * **Short Name:** Shortened or fully abbreviated name (alias) for this software (max. 30 characters; no space).
5 -* **Description:** Longer statement or account (abstract) giving the characteristics for this software (max. 2000 characters, incl. spaces; no references).
6 -//**NOTE:** This is how you present your software publicly to potential end-users or other researchers. Keep in mind that it is important to clarify the purpose of the software as well as its use cases and a brief overlook of the methods used if applicable. A one-sentence description that barely reveals more information than the title does is insufficient, thus will not be accepted.//
5 +* **Description:** Longer statement or account (abstract) giving the characteristics for this software (max. 2000 characters, incl. spaces; no references). **NOTE:** This is how you present your software publicly to potential end-users or other researchers. Keep in mind that it is important to clarify the purpose of the software as well as its use cases and a brief overlook of the methods used if applicable. A one-sentence description that barely reveals more information than the title does is insufficient, thus will not be accepted.
7 7  * **Developer:** Add one or several developers (person or organization) that contributed to the code implementation of this software (as a whole, not a specific version).
8 8  * **HasVersion:** Add one or several versions of this software tool. (This is up to the Curators)
9 9  * **Custodian:** Add one or several custodians (person or organization) that are responsible for this research product. Note that this custodian will be responsible for all attached research product versions.
... ... @@ -11,7 +11,7 @@
11 11  * **Homepage:** Link to the main website of this software.
12 12  * **Has Version:** Reference to one or several versions of this software.
13 13  
14 -=== SOFTWARE VERSION ===
13 += SOFTWARE VERSION {{id name="software-version"/}} =
15 15  
16 16  * **Full Name:** Whole, non-abbreviated and descriptive name (title) for this software version.
17 17  * **Short Name:** Shortened or fully abbreviated name (alias) for this software version (max. 30 characters; no space).
... ... @@ -43,20 +43,20 @@
43 43  ** Unix
44 44  ** Android
45 45  ** platform independent
46 -* **Requirement:** Software requirements for installing & using this software version. Only for development/building if there are no precompiled binaries. Furthermore no dependencies should be listed (e.g. "C++ Compiler" but no "zlib"). Content of the requirements.txt of python project *must not* be included.
45 +* **Requirement:** Software requirements for installing & using this software version. Only for development/building if there are no precompiled binaries. Furthermore no dependencies should be listed (e.g. "C++ Compiler" but no "zlib"). Content of the requirements.txt of python project //must not// be included.
47 47  * **Full Documentation:** Globally unique and persistent digital identifier of a full documentation of this software version.
48 48  * **Repository:** Link to the file repository of this software version.
49 49  * **Application Category:** Distinct class that groups software programs which perform a similar task or set of tasks.
50 -** [Application](https://www.wikidata.org/wiki/Q166142)
51 -** [Library](https://www.wikidata.org/wiki/Q188860)
52 -** [Plugin](https://www.wikidata.org/wiki/Q184148)
53 -** [Module](https://www.wikidata.org/wiki/Q11883090)
54 -** [Notebook](https://www.wikidata.org/wiki/Q28405706)
55 -** [Middleware](https://www.wikidata.org/wiki/Q146768)
56 -* **Feature:** List of [distinguishing characteristics](https://github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features) of this software version.
49 +** [[Application>>https://www.wikidata.org/wiki/Q166142]]
50 +** [[Library>>https://www.wikidata.org/wiki/Q188860]]
51 +** [[Plugin>>https://www.wikidata.org/wiki/Q184148]]
52 +** [[Module>>https://www.wikidata.org/wiki/Q11883090]]
53 +** [[Notebook>>https://www.wikidata.org/wiki/Q28405706]]
54 +** [[Middleware>>https://www.wikidata.org/wiki/Q146768]]
55 +* **Feature:** List of [[distinguishing characteristics>>doc:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.Software Features.WebHome]] of this software version.
57 57  * **Input Format:** Please provide the name of the file format and its usual ending (e.g. NeuroML(XML)).
58 58  * **Output Format:** Please provide the name of the file format and its usual ending (e.g. NeuroML(XML)).
59 -* **Programming Language:** The programming language(s) in which the software is written.
58 +* **Programming Language:** The programming language(s) in which the software is written.
60 60  * **Language:** Languages supported by this software version.
61 61  * **Has Component:** Software versions that supplement this software version.
62 62  * **Is Alternative Version Of:** Software versions that can be used alternatively to this software version.
... ... @@ -69,3 +69,59 @@
69 69  * **Keyword:** Significant word or concept that are representative of this software version.
70 70  * **Related Publication:** Further publications besides the documentation (e.g. an original research article) providing the original context for the production of this software version.
71 71  * **Other Contribution:** Contributions for each involved person or organization going beyond being an author, custodian or developer of this software version.
71 +
72 +----
73 +
74 +== DEPRECATED SCHEMA {{id name="deprecated-schema"/}} ==
75 +
76 +* **Name:** The official name of the software.
77 +* **Summary:** A short (e.g one sentence) description of the software.
78 +* **Description:** This is how you present your software publicly to potential end-users or other researchers. Keep in mind that it is important to clarify the purpose of the software as well as its use cases and a brief overlook of the methods used if applicable. A one-sentence description that barely reveals more information than the title does is insufficient, thus will not be accepted. If another version of your software already exists, please only fill out if there's a change in the description of your software. These changes will be appended to the description of your previous version on the card in the KG.
79 +* **Created at:** Creation date or release date of this version.
80 +* **Application Category:** Type of the Software
81 +** Application
82 +** Library
83 +** Plugin
84 +** Module
85 +** Notebook
86 +** Middleware
87 +* **Operating Systems**
88 +** windows
89 +** linux
90 +** macOS
91 +** iOS
92 +** solaris
93 +** unix
94 +** android
95 +** platform independent
96 +* **Software Requirements:** Softwarerequirements for installing & using the Software. Only for development/building if there are no precompiled binaries. Furthermore no dependencies should be listed (e.g. "C++ Compiler" but no "zlib"). Content of the requirements.txt of python project //must not// be included.
97 +* **Homepage:** Link to the homepage of this software.
98 +* **License:** A license document that applies to this content, typically indicated by URL or a commonly known license title (e.g. GPLv3).
99 +* **Funder:** An organization that supports (sponsors) the software through some kind of financial contribution.
100 +* **Keywords:** Keywords or tags used to describe this content.
101 +* **Version:** The version of the software.
102 +* **Language:** The Language of the software's user interface.
103 +* **Unique Identifier:** Unique digital identifier that links to this software directly (e.g. DOI). Can either be requested to be registered by EBRAINS or filled in with already existing identifier.
104 +* **DOI Requested:** This field is to be ticked, if the developer explicitly wishes a new DOI to be registered by the EBRAINS knowledge graph.
105 +* **Citations:** Please only provide DOIs or similar URIs that link to a publication (i.e. a Journal Paper or similar) where this software is described.
106 +* **Release Notes:** As plaintext or link (eg. Github).
107 +* **Screenshot(s):** Links to screenshot images of the software.
108 +* **Authors:** Only persons with name and email addresses.
109 +* **Copyright Holders:** Please enter Person (Name + Email) or Organisation.
110 +* **Copyright Year:** The year during which the copyright was first asserted.
111 +* **Documentation:** Link to the documentation of this software.
112 +* **Help:** Email or URL to obtain support in using the software.
113 +* **Source Code:** Link to the source code (e.g. Git Repository) of the software.
114 +* **Programming Language:** The programming language(s) in which the software is written.
115 +* **Components:** Subcomponents of this software (which must be identified, as well).
116 +* **Is Accessible For Free:** A flag to signal if the software is accessible for free or not.
117 +* **Icon:** Link to an icon of this software.
118 +* **Devices:**
119 +** Desktop
120 +** Mobile
121 +** Web
122 +** Server
123 +** HPC
124 +** Embedded System
125 +* **Features:** List of [[features>>https://github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features]] that this software comes with.
126 +* **Input/Output Formats**: Please provide the name of the File-Format and its usual ending (e.g. NeuroML(XML)).