Skip to content

Commit

Permalink
Move definitions to sepearate file and page
Browse files Browse the repository at this point in the history
  • Loading branch information
moranegg committed May 20, 2024
1 parent 66021b0 commit 42870ab
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 4 deletions.
18 changes: 18 additions & 0 deletions chapters/0.Definitions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Definitions

## Metadata location
- **Intrinsic metadata** refers to information that is embedded within the content or object itself, in a metadata file that can be human readable (e.g README) or machine-actionable (e.g pom.xml, codemeta.json)
* **Extrinsic metadata** is the record describing the software externally to the source code.

### used in
- RSMD-1.1
- RSMD-1.2

## Granularity level

- **software version**: A specific version of a software refers to a distinct release or iteration of a software application or program.
- **software module**: A specific module of a larger software project refers to a self-contained unit or component within a software system.
- **software project**: A computer software project is an organized effort to develop software.

### used in
- RSMD-3.3
4 changes: 0 additions & 4 deletions chapters/1.General.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
## Objective
To ensure the collection, curation, and maintenance of research software metadata, the following general recommendations are suggested for end users, including researchers, software engineers, curators, and institution staff.

## Definitions
- **Intrinsic metadata** refers to information that is embedded within the content or object itself, in a metadata file that can be human readable (e.g README) or machine-actionable (e.g pom.xml, codemeta.json)
* **Extrinsic metadata** is the record describing the software externally to the source code.

## Recommendations
### RSMD-1.1
**Essential ☆☆☆**
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ nav:
- 'Foreword': 0.Foreword.md
- 'Introduction': 0.Introduction.md
- 'Scope': 0.Scope.md
- 'Definitions': 0.Definitions.md
- 'Aspect 1: General': 1.General.md
- 'Aspect 2: Accessibility and preservation': 2.Accessibility_preservation.md
- 'Aspect 3: Reference and identification': 3.Reference_identification.md
Expand Down

0 comments on commit 42870ab

Please sign in to comment.