From a5018169ed323ff329533144425e1d4a269a77bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mattias=20Andr=C3=A9e?= Date: Tue, 30 Oct 2012 23:23:40 +0100 Subject: [PATCH] info: document the format of metadata --- manuals/ponysay.texinfo | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/manuals/ponysay.texinfo b/manuals/ponysay.texinfo index 3c684304..cdb08d8e 100644 --- a/manuals/ponysay.texinfo +++ b/manuals/ponysay.texinfo @@ -1509,6 +1509,7 @@ To perform an uninstallation of old files run @command{make uninstall-old}. @menu * Pony anatomy:: Anatomy of pony files. +* Pony metadata:: Metadata in pony files. * Pony quote infrastructure:: Pony quote infrastructure. * Balloon style files:: Balloon style files. * Printing in TTY with KMS:: Printing in TTY with KMS support. @@ -1553,6 +1554,36 @@ the balloon) itself was printed by @command{cowsay} and is not defined in the co files. +@node Pony metadata +@section Pony metadata +@cindex pony metadata +@cindex metadata +@cindex tags, metadata +@cindex comments, metadata +@cindex pony tags, metadata +@cindex pony comments, metadata + +New in ponysay 3.0 is pony metadata, this feature is not supported in @command{util-say} +(at least not yet). It extends the previously described@footnote{@ref{Pony anatomy}} +format of the pony files, by letting you specify details about the pony image, and +the pony itself, as well as adding comments. + +The metadata entry must be at the absolute beginning of the file (UTF-8 signture +excluded), and is the file must be encoded in UNIX line breaks. The metadata entry +begins with a line with exact 3 dollar signs and nothing else (@code{$$$}), and +end in the same way direct follow by the pony image starting from the next line. + +A metadata tag consists of a tag name in upper case and a tag value, with a colon +(@code{:}), optionally with regular spaces or tab spaces. Multiple tag names can +be used multiple times or can be completely skipped. There are only a few tags, +namely @var{BALLOON TOP}, @var{BALLOON BOTTOM}, @var{FREE}, that absolutely should +not be used muliple tag; a general rule is that a tag desribing a pony should be +duplicated exact as many times as there are ponies in the image. + +Any line that does not conform to the format of a tag line is a part of the comment +field. Leading line breaks in the comment field is ignored. + + @node Pony quote infrastructure @section Pony quote infrastructure @cindex pony quote infrastructure