CLI interface to medialist (fossil mirror)
| Revision | d635e4183f0b937a96038c4b69a8146050644e59 (tree) |
|---|---|
| Time | 2023-03-16 16:49:32 |
| Author | mio <stigma@disr...> |
| Commiter | mio |
Begin updating texinfo document for MediaList
FossilOrigin-Name: 15aad67b913148a5a132d29e68e7adb57eed07b6fa861a9c52dc30047d480cfb
docs/medialist.info (diff)| @@ -1,7 +1,7 @@ | ||
| 1 | 1 | \input texinfo @c -*-texinfo-*- |
| 2 | 2 | |
| 3 | -@set VERSION 0.3 | |
| 4 | -@set UPDATED 2022-02-18 | |
| 3 | +@set VERSION 0.4 | |
| 4 | +@set UPDATED 2022-03-16 | |
| 5 | 5 | |
| 6 | 6 | @settitle MediaList @value{VERSION} |
| 7 | 7 | @syncodeindex pg cp |
| @@ -10,7 +10,7 @@ | ||
| 10 | 10 | This manual is for MediaList (version @value{VERSION}, @value{UPDATED}), |
| 11 | 11 | a library for interacting with medialist files. |
| 12 | 12 | |
| 13 | -Copyright @copyright{} 2022 mio. | |
| 13 | +Copyright @copyright{} 2022-2023 mio. | |
| 14 | 14 | |
| 15 | 15 | @quotation |
| 16 | 16 | This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 |
| @@ -21,8 +21,8 @@ International License. To view a copy of this license, visit | ||
| 21 | 21 | The example (@xref{Example}) provided is released to the public domain. |
| 22 | 22 | |
| 23 | 23 | @quotation |
| 24 | -To the extent possible under law, mio has waived all copyright and related or | |
| 25 | -neighbouring rights to the Example in the MediaList manual. To view more | |
| 24 | +To the extent possible under law, mio has waived all copyright and related | |
| 25 | +or neighbouring rights to the Example in the MediaList manual. To view more | |
| 26 | 26 | information, visit @uref{http://creativecommons.org/publicdomain/zero/1.0/}. |
| 27 | 27 | @end quotation |
| 28 | 28 | @end copying |
| @@ -43,9 +43,6 @@ information, visit @uref{http://creativecommons.org/publicdomain/zero/1.0/}. | ||
| 43 | 43 | |
| 44 | 44 | This manual is for MediaList (version @value{VERSION}, @value{UPDATED}). |
| 45 | 45 | |
| 46 | -@c TODO | |
| 47 | -@c * Move mTSV before Data Types | |
| 48 | - | |
| 49 | 46 | @menu |
| 50 | 47 | * Overview:: |
| 51 | 48 | * mTSV:: |
| @@ -59,30 +56,33 @@ This manual is for MediaList (version @value{VERSION}, @value{UPDATED}). | ||
| 59 | 56 | @chapter Overview |
| 60 | 57 | |
| 61 | 58 | `medialist' is a D package for interacting with |
| 62 | -@acronym{mTSV, m? Tab Separated Values} files. These files are rather similar | |
| 63 | -to normal @dfn{TSV} files, but differ in that they support comments. The | |
| 64 | -package works by sending ``commands'' and arguments for those ``commands'' to | |
| 65 | -a specific @dfn{mTSV} file (a ``list''). | |
| 59 | +@acronym{mTSV, m? Tab Separated Values} files. These files are rather | |
| 60 | +similar to normal @dfn{TSV} files, but differ in that they support comments. | |
| 61 | +Basing the ``list''s off of the @dfn{TSV} format means that they're just | |
| 62 | +plain-text, allowing people to still edit them manually with a text editor. | |
| 66 | 63 | |
| 67 | -Basing the ``list''s off of the @dfn{TSV} format means the files are still | |
| 68 | -plain-text, that is to say, you can edit them with any text-editor. The package | |
| 69 | -simply assists with creating programs so you can easily maintain your ``list''. | |
| 64 | +The package is designed to help create and maintain @dfn{mTSV} files, with a | |
| 65 | +focus on reading and watching media. It works by sending various | |
| 66 | +``commands'' to the list, along with some arguments. | |
| 67 | +@xref{x-mlcommand,,MLCommand} for an overview of the different ``commands''. | |
| 70 | 68 | |
| 71 | 69 | @node mTSV |
| 72 | 70 | @chapter mTSV |
| 73 | 71 | |
| 74 | 72 | @cindex mTSV |
| 75 | 73 | |
| 76 | -The mTSV file format is based off the @acronym{TSV, Tab Separated Values} file | |
| 77 | -format. The complete file represents a data table where each value is separated | |
| 78 | -by the tab character (@code{0x09}, @kbd{HORIZONTAL TAB}). The rows are | |
| 79 | -delimitated by a new line (@code{0x0A}, @kbd{LINE FEED}). So far this is the | |
| 80 | -same as a regular TSV file. The only difference with mTSV is with the addition | |
| 81 | -of ``comments''. If a line starts with an octothorpe (@code{0x23}, @key{#}), | |
| 82 | -then it is interpreted as a comment and the line can be ignored. | |
| 74 | +The mTSV file format is based off the @acronym{TSV, Tab Separated Values} | |
| 75 | +file format. The complete file represents a data table where each value is | |
| 76 | +separated by the tab character (@code{0x09}, @kbd{HORIZONTAL TAB}). The | |
| 77 | +rows are delimitated by a new line (@code{0x0A}, @kbd{LINE FEED}). So far | |
| 78 | +this is the same as a regular @dfn{TSV} file. The only difference with | |
| 79 | +a @dfn{mTSV} file is with the addition of ``comments''. If a line starts | |
| 80 | +with an octothorpe (@code{0x23}, @key{#}), then it is interpreted as a | |
| 81 | +comment and the line can be ignored. | |
| 83 | 82 | |
| 84 | -Some programs (e.g. the @uref{https://yume-neru.neocities.org/p/medialist.html, medialist suite of programs}) use these comments as a way of providing per-file | |
| 85 | -configuration. | |
| 83 | +Some programs (e.g. the | |
| 84 | +@uref{https://yume-neru.neocities.org/p/medialist.html, medialist suite of programs}) | |
| 85 | +use these comments as a way of providing per-file configuration. | |
| 86 | 86 | |
| 87 | 87 | @node Data Types |
| 88 | 88 | @chapter Data Types |
| @@ -178,6 +178,7 @@ If it is @code{false}, then it failed and the values shouldn't be trusted. | ||
| 178 | 178 | @end table |
| 179 | 179 | |
| 180 | 180 | @section MLCommand |
| 181 | +@anchor{x-mlcommand} | |
| 181 | 182 | |
| 182 | 183 | @pindex enum MLCommand |
| 183 | 184 |
nemophila
Fork