Skip to content

Commit

Permalink
Merge #2991 Update tags section of spec
Browse files Browse the repository at this point in the history
  • Loading branch information
HebaruSan committed Feb 7, 2020
2 parents 6ce2192 + efcba4c commit d1d2c51
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ All notable changes to this project will be documented in this file.
### Internal

- [Build] Update Cake to 0.37.0 (#2985 by: DasSkelett; reviewed: HebaruSan)
- [Spec] Update tags section of spec (#2991 by: HebaruSan; reviewed: DasSkelett)

## v1.26.10 (Alcubierre)

Expand Down
35 changes: 18 additions & 17 deletions Spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,31 +390,32 @@ checking.

##### tags

(**v<TBA>**) The `tags` field describes keywords that a user or program may
use to classify or filter the mod in a list, but which are not required.
These may include general tags which define how the mod interacts with or
alters KSP or specific tags defining what has been added or changed from
stock gameplay. Tags may contain lowercase alphanumeric characters or
hyphens.
(**v1.27**) The `tags` field describes keywords that a user or program may
use to classify or filter the mod in a list. These may include general tags
which define how the mod interacts with or alters KSP or specific tags
defining what has been added or changed from stock gameplay. Tags may
contain lowercase alphanumeric characters or hyphens.

All mods should have tags, but it is technically allowed to omit them to
allow historical metadata to remain valid.

A mod's tags are shown in the mod info section of the client, and the mod
list may be filtered to find all mods with a given tag.

Example tags:

"tags" : [
```json
"tags": [
"config",
"physics",
"parts",
"oceanic",
"thermal",
"science",
"my-1-custom-tag"
"science"
]
```

The first defined keyword listed in the tag field which matches one of a
predefined set of 'standard' tags should be considered the most important
and used to populate a sortable column in online indices, though it is
intended that all included tags will be indexed and searchable.
Currently recommended tags are listed here:

Tags have not yet been implemented in the client. They can be added to
.ckan/.netkan files, but will not be displayed in the client yet.
https://github.com/KSP-CKAN/CKAN/wiki/Suggested-Tags

##### localizations

Expand Down

0 comments on commit d1d2c51

Please sign in to comment.