diff options
| author | Karen Arutyunov <karen@codesynthesis.com> | 2019-04-30 20:25:19 +0300 |
|---|---|---|
| committer | Karen Arutyunov <karen@codesynthesis.com> | 2019-05-07 22:50:28 +0300 |
| commit | b26f393c2257c3dfe7937696cd4f307e4075f20c (patch) | |
| tree | ff9d26c2fa6f8bacdc37d18ed37bee9f8564bbe2 /doc | |
| parent | 216b2d199bdf3730243795ff71515e636184d98f (diff) | |
Add support for description-type package manifest value
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual.cli | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/doc/manual.cli b/doc/manual.cli index cbd17d7..a5b9eb0 100644 --- a/doc/manual.cli +++ b/doc/manual.cli @@ -529,6 +529,7 @@ license: <licenses> [; <comment>] [tags]: <tags> [description]: <text> [description-file]: <path> [; <comment>] +[description-type]: <text-type> [changes]: <text> [changes-file]: <path> [; <comment>] @@ -696,14 +697,35 @@ As a result, we will start simple and only allow single-word tags.| \ [description]: <text> [description-file]: <path> [; <comment>] +[description-type]: <text-type> \ The detailed description of the package. It can be provided either inline as a text fragment or by referring to a file within a package (e.g., \c{README}), but not both. -In the web interface (\c{brep}) the description is displayed as pre-formatted -plain text. \N{We could use the comment to \"hint\" at the file format.} +In the web interface (\c{brep}) the description is displayed according to its +type. Currently, pre-formatted plain text, \l{https://github.github.com/gfm +GitHub-Flavored Markdown}, and \l{https://spec.commonmark.org/current +CommonMark} are supported with the following \c{description-type} values, +respectively: + +\ +text/plain +text/markdown;variant=GFM +text/markdown;variant=CommonMark +\ + +If just \c{text/markdown} is specified, then the GitHub-Flavored Markdown +(which is a superset of CommonMark) is assumed. + +If the description type is not explicitly specified and the description is +specified as \c{description-file}, then an attempt to derive the type from the +file extension is made. Specifically, the \cb{.md} and \cb{.markdown} +extensions are mapped to \c{text/markdown}, the \cb{.txt} and no extension are +mapped to \c{text/plain}, and all other extensions are treated as an unknown +type, similar to unknown \c{description-type} values. And if the description +is not specified as a file, \c{text/plain} is assumed. \h2#manifest-package-changes|\c{changes}| |