This is the bug/patch tracker for Rockbox. Click here for more information.
Quick links: Bugs · Patches · Rockbox frontpage
FS#12090 - Manual: add metadata section
Attached to Project:
Rockbox
Opened by Andree Buschmann (Buschel) - Sunday, 01 May 2011, 22:53 GMT+2
Last edited by Alexander Levin (fml2) - Monday, 09 May 2011, 22:35 GMT+2
Opened by Andree Buschmann (Buschel) - Sunday, 01 May 2011, 22:53 GMT+2
Last edited by Alexander Levin (fml2) - Monday, 09 May 2011, 22:35 GMT+2
|
DetailsI have the impression that a reasonable amount of questions in the forums comes from rockbox' metadata implementation. This is why I want to add a metadata section to the manual. This first patch adds such section and provides a table with information about what metadata tag type is used for which file extensions.
Next steps: - feature overview (e.g. which tags support replaygain, embedded album art, ... in rockbox) - limitations (e.g. max string lengths) 
manual_v04.patch
(2.9 KiB)
manual/appendix/file_formats.tex | 44 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) |
This task depends upon
Closed by Alexander Levin (fml2)
Monday, 09 May 2011, 22:35 GMT+2
Reason for closing: Accepted
Additional comments about closing: Committed as r29847
Monday, 09 May 2011, 22:35 GMT+2
Reason for closing: Accepted
Additional comments about closing: Committed as r29847
1. For creating a new section the usual way is to put two consecutive newlines in the code, not \\ which starts a new line. The LaTeX sources should always start new paragraphs, starting a new line is almost never needed. The output is slightly different for new lines and new paragraphs; if the indentation of new paragraphs isn't wanted that should be adjusted in the preamble instead of breaking the document structure with \\ (this is done wrong in the manual in several places unfortunately). The macro \note shouldn't need a separate paragraph before it since it does that itself.
2. using \textbf for the table headings is ugly. I think we had a macro for headers in the past, but I can't find that anymore -- the table macros were changed since.
2. This is exactly how the tables which are defined right before this new table are configured. At least this is consistent...
As for the sections: Dominik, I think you mean paragraphs? Andree: instead of
audio file extension.\\
\note{There is always only \textbf{one} tag type supported for each file
extension.}
write
audio file extension.
\note{There is always only \textbf{one} tag type supported for each file
extension.}
I.e. no "\\" at the end of line and an empty line before "\note".
Also, if there is always only \textbf{one} tag type supported for each file extension (BTW: here I would use "emph" instead of "textbf"), wouldn't it be better to have just one column and write there which tags are supported instead of many columns with X's?