diff options
| author | Boris Kolpackov <boris@codesynthesis.com> | 2019-06-03 14:41:42 +0200 |
|---|---|---|
| committer | Boris Kolpackov <boris@codesynthesis.com> | 2019-06-03 14:41:42 +0200 |
| commit | b8746737629da7adcb9249962c642eceeb3a832f (patch) | |
| tree | 61153cc424d5708262fb12e049ac510d50cb39be /doc | |
| parent | 2b13fce423c8def90a3e0873c3ab8dbd86c97264 (diff) | |
Replace tags with keywords, add topics package manifest values in manual
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.cli | 39 |
1 files changed, 23 insertions, 16 deletions
diff --git a/doc/manual.cli b/doc/manual.cli index 8bedcb1..7f0f3f9 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -526,7 +526,8 @@ license: <licenses> [; <comment>] \ \ -[tags]: <tags> +[topics]: <topics> +[keywords]: <keywords> [description]: <text> [description-file]: <path> [; <comment>] [description-type]: <text-type> @@ -684,29 +685,35 @@ Note that just \c{BSD} is ambiguous and should be avoided. \N|An example of automated processing would be filtering for non-copyleft licensed packages.| -\h2#manifest-package-tags|\c{tags}| +\h2#manifest-package-topics|\c{topics}| + +\ +[topics]: <topics> + +<topics> = <topic> [, <topic>]* \ -[tags]: <tags> -<tags> = <tag> [, <tag>]* +The package topics (optional). The format is a comma-separated list of up to +five potentially multi-word concepts that describe this package. For example: + \ +topics: xml parser, xml serializer +\ + -The package tags (optional). The format is a comma-separated list of words -that describe this package. +\h2#manifest-package-keywords|\c{keywords}| -\N|Originally, support for multi-word tags were considered, however this -quickly degenerated into quite a complex functionality. In particular, in such -a case we should probably treat multi-word tags as if the single word as well -as shorter, multi-word derivations were also mentioned. That is, \"xml pull -parser\" should be equivalent to \"xml pull parser, xml pull, xml parser, -pull parser, xml, pull, parser\". +\ +[keywords]: <keywords> -On the user side, if exact phrase matches are favored, then this serves as an -encouragement to come up with ever more elaborate multi-word tags to \"cover\" -as much ground as possible. For example, \"streaming c++ xml pull parser\". +<keywords> = <keyword> [ <keyword>]* +\ -As a result, we will start simple and only allow single-word tags.| +The package keywords (optional). The format is a space-separated list of up to +five words that describe this package. Note that the package and project names +as well as words from its summary are already considered to be keywords and +need not be repeated in this value. \h2#manifest-package-description|\c{description}| |