# Updated Documentation — Work in Progress
**URL:** https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547
**Category:** General Discussion
**Created:** [March 2, 2022, 12:57pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547 "2022-03-02T12:57:59Z")
**Posts on this page:** 20
**Page:** 2
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 5, 2022, 1:06pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/21 "2022-03-05T13:06:33Z")
> [@ohrenkino](#):
>
> The description does not explain the special effect of $loop(1) which does not sort the selected files. The current description looks as though a field reference would be mandatory.
You're passing `1` as field name in this case. I think any non-existent field would have the same effect.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 5, 2022, 1:56pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/22 "2022-03-05T13:56:51Z")
THank you for considering these comments.
I like the part on scripting now much better.
But ...
`$mid(x,i,n) returns the first n characters of text x, starting at character i. If n is ommited, the character at position i is returned.`
IMHO the "i" parameter is not described properly. I think that the substring starts at **character position** and that position has to be expressed by a number. The way it may be read now is that you enter a letter from the string and expect the substring to start there.
I am also not quite sure if "the first n characters" is correct or whether it should leave out "the first".
The description for $num(x,y) ... probably one of the most frequent use cases is to transform TRACK into a (padded) number but also to take that what is a number and strip off the rest like in TRACK = 10/12 to become just "10". And perhaps leading to the surprising result of "00" if used with an Vinyl number "A1".
So I think that function transfers the string x into a number, until it hits a non-numeric character. The transformed string then is output with the specified padding.
Even though this is an old description from the previous help
`$regexp(x,expr,repl)`
the description talks about a 4th optional parameter - it would be nice to see a complete syntax here.
(This would be another of the examples where some kind of metasyntax would come into its own as this command not only has optional parameters but these parameters have restrictions as to what they can be: 0 or 1. This is a little different from the $caps() functions where the user can enter something of his choice as optional parameter).
`$replace(x,y,z)` - the old help mentioned a maximum of 32 pairs of y and z. Is this still valid?
`$trim(x)`, `$trimLeft(x)`, `$trimRight(x)` each talk about a second optional parameter but that is not reflected in the syntax.
On the Arithmetic Functions I miss the information that MP3tag does not support floating point arithmatic.
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 5, 2022, 3:12pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/23 "2022-03-05T15:12:11Z")
Thank you! I've incorporated the suggested changes (except for meta-syntax as mentioned before).
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 5, 2022, 3:38pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/24 "2022-03-05T15:38:50Z")
On the topic of mappings
> **[Mp3tag Documentation: the universal Tag Editor](https://docs.mp3tag.de/mapping/)**
>
> Mp3tag Documentation. Mp3tag is the universal Tag Editor. It supports editing of metadata and cover art for many different audio and video formats (MP3, MP4, FLAC, WAV, ...), file renaming, metadata import and repeatable actions.
here, esp. POPULARIMETER, RATING WMP, ..MM, .. WINAMP
an explanation would be nice that there is an option in Tags\>Enhanced that lets you see the raw data in POPULARIMETER and that all the RATING... fields are processed representations of POPULARIMETER. A link to the option would be nice an perhaps revealing which raw string in POULARIMETER would be shown in which RATING ... field.
I am not so sure whether it is really necessary to have a second section with further explanation about values and other specialities at the bottom.
I saw the necessity in the old help where the fields were described in a table and the table had limited space - but in that table, the fields with more need for explanartion were linked to the extra bits at the bottom.
Now the layout isn't a table any more and so there is no real space limitations in the vertical. So, personally, I would add the extra information right there where the field is described and not in an extra section at the bottom.
The old solution with link has the disadvantage (IMHO) that on the one hand, you could easily jump from the top to the bottom - but if you are there ... should there be a jump back into the field list? Wouldn't that be puzzling if you jumped in circles?
The easier way, I would think, is to simply add the short extra information at the bottom of each field description, perhaps as a section "Extra" or "Further information".
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 5, 2022, 5:18pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/25 "2022-03-05T17:18:00Z")
I've moved the additional notes to the respective field and extended the documentation of the `RATING MM` and `RATING WMP` fields with the link to the advanced setting.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 5, 2022, 5:51pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/26 "2022-03-05T17:51:46Z")
Alas! Finally, a typo!
> **[Mp3tag Documentation: the universal Tag Editor](https://docs.mp3tag.de/customization/options/tags/mpeg/)**
>
> Mp3tag Documentation. Mp3tag is the universal Tag Editor. It supports editing of metadata and cover art for many different audio and video formats (MP3, MP4, FLAC, WAV, ...), file renaming, metadata import and repeatable actions.
please aks their -\> please ask their
and in
> **[Mp3tag Documentation: the universal Tag Editor](https://docs.mp3tag.de/customization/options/library/)**
>
> Mp3tag Documentation. Mp3tag is the universal Tag Editor. It supports editing of metadata and cover art for many different audio and video formats (MP3, MP4, FLAC, WAV, ...), file renaming, metadata import and repeatable actions.
an "iff" with a double "f".
On another note: in older times there were questions about the Lyrics V1 tag. The advice there was to remove ID3V1 tags
(e.g. [[X] Anzeige von !!! Lyrics TAG !!! in Spalte APE-Tag](https://community.mp3tag.de/t/x-anzeige-von-lyrics-tag-in-spalte-ape-tag/17624))
So, would it be helpful to mention that if you select "Remove ID3V1 tags" the Lyrics V1 tag also gets removed?
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 5, 2022, 6:07pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/27 "2022-03-05T18:07:01Z")
I don't know if this something to be mentioned in the section about export or in the [messages section](https://docs.mp3tag.de/customization/options/messages/)
If you select the message
## at exporting tags
If enabled, shows a confirmation message that allows for opening the exported file after exporting.
MP3tag tries to open the resulting export file with the associated application.
So the reaction there depends on the extension of the filename specified in $filename() or the filename in the export dialogue.
So if a cmd file is created, a word of caution might be of value.
What I would like to see is a link from the export description to the message that deals with the export and also from the export message to the export description to make clear why sometimes another program gets opened after the export.
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 5, 2022, 7:05pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/28 "2022-03-05T19:05:37Z")
Fixed the typos and mentioned Lyrics3. Also made clear that Mp3tag uses the default program associated with the file extension of the exported file when confirming to open.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 6, 2022, 8:02am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/29 "2022-03-06T08:02:29Z")
Still on the topic of exports
> **[Mp3tag Documentation: the universal Tag Editor](https://docs.mp3tag.de/export/)**
>
> Mp3tag Documentation. Mp3tag is the universal Tag Editor. It supports editing of metadata and cover art for many different audio and video formats (MP3, MP4, FLAC, WAV, ...), file renaming, metadata import and repeatable actions.
I would like to see a description of how the export filename is found.
The default is taken from the export configuration.
If there nothing has been defined, then the last used export filename is taken.
Both can be overwritten at the time of calling the export and prior to clicking OK.
The description for $filename(name,[enc]) (oooh, I see some kind of metasyntax creeping in!) should be appended to that the name is also an optional parameter but then a filename has to be defined at runtime.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 6, 2022, 8:40am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/30 "2022-03-06T08:40:21Z")
On the topic of Format Strings and Placeholders:
> **[Mp3tag Documentation: the universal Tag Editor](https://docs.mp3tag.de/format/)**
>
> Mp3tag Documentation. Mp3tag is the universal Tag Editor. It supports editing of metadata and cover art for many different audio and video formats (MP3, MP4, FLAC, WAV, ...), file renaming, metadata import and repeatable actions.
There is an example list of assumingly frequently used field variables - but these are by far not all.
The complete list for these (supported) tag fields can be found in
> **[Mp3tag Documentation: the universal Tag Editor](https://docs.mp3tag.de/mapping/)**
>
> Mp3tag Documentation. Mp3tag is the universal Tag Editor. It supports editing of metadata and cover art for many different audio and video formats (MP3, MP4, FLAC, WAV, ...), file renaming, metadata import and repeatable actions.
but in the Format strings and Placeholders section there is no link to the mapping section - just like there is no link from the mapping section to the Format strings.
In the Export section there is a link to Scripting functions and Format string but none to the Mapping section.
IMHO either the sections should be linked so that the user gets an idea what he/she can really use in format strings or the sections about placeholders should be combined - just like they are in the button menus in e.g. the filter or the converters.
Then you would have a complete list together and also learn that the variables are grouped for special purposes.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 6, 2022, 8:55am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/31 "2022-03-06T08:55:30Z")
On the topic of filters
"It is not possible to filter by strings containing double quotations marks. This is a limitation of the feature." - I think that there was the workaround with $char(34)
e.g.
> [@Filter (Finding) double quotation marks "](https://community.mp3tag.de/t/filter-finding-double-quotation-marks/52685):
>
> Hi, Would there any filter argument that will find double quotation marks? I would like to change all nick names that have double quotation marks to single quotation marks but finding them all is the challenge. eg. from say "Slim" to 'Slim' or from "Guitar Shorty" to 'Guitar Shorty' etc Thanks
I am not sure if the filter syntax is really described correctly.
Most syntax examples start with
` ...`
(fascinatingly with some kind of metasyntax...)
but I think that this not really just a `` as there are filter examples like
> [@Filter expressions](https://community.mp3tag.de/t/filter-expressions/10080/3):
>
> Filter with Scripting Check if a field is longer than 4 characters: "$len(%bpm%)" GREATER 4 Files with multipe artist tags: "$meta\_sep(Artist,\\)" HAS \\ Check if two fields have the same value: "$if($eql(%artist%,%albumartist%),yes,no)" IS yes Check if the title is part of the filename: "$ifgreater($strstr(%\_filename%,%title%),0,yes,no)" IS yes
where the scripting part at the front is not really a ``
I would think that this is a "generating format string" enclosed in double quotation marks.
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 6, 2022, 1:38pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/32 "2022-03-06T13:38:29Z")
> [@ohrenkino](#):
>
> I would like to see a description of how the export filename is found.
I've extended the documentation in that regard.
> [@ohrenkino](#):
>
> appended to that the name is also an optional parameter
Added, also mentioned file extension which is also possible.
> [@ohrenkino](#):
>
> but in the Format strings and Placeholders section there is no link to the mapping section - just like there is no link from the mapping section to the Format strings.
Added links in both directions.
> [@ohrenkino](#):
>
> I think that there was the workaround with $char(34)
I've added this although I'm not sure if it should be part of the documentation.
> [@ohrenkino](#):
>
> but I think that this not really just a `` as there are filter examples like
There is already a clarifying statement under "Notes"
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 6, 2022, 9:02pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/33 "2022-03-06T21:02:24Z")
I've just made a silent release by redirecting the URLs of the old help files to the new documentation. I think it's in very good shape now and already much better than what we had before.
Thanks @ohrenkino for your helpful feedback and all the suggestions for improvement! 🙏 🙏
---
### Author:  [@MotleyG](https://community.mp3tag.de/u/MotleyG)
#### Post date: [March 7, 2022, 2:07am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/34 "2022-03-07T02:07:24Z")
Sorry to reply so late in this process. I had a couple of things stand out as I read through the these updates help notes.
In the Getting Started\>Overview section there is mention of several audio formats that mp3tag supports. This is not a complete list, but also it does _not_ mention that mp3tag also supports several video formats as well. I think this should be relevant. Plus you can link from this paragraph to the full list of supported file formats referenced later.
> **[Overview – Mp3tag Documentation](https://docs.mp3tag.de/getting-started/overview/)**
>
> General description about Mp3tag, the design philosophy and the intention of this documentation. Mp3tag is the universal Tag Editor.
> **[Supported File Formats – Mp3tag Documentation](https://docs.mp3tag.de/file-formats/)**
>
> Overview of supported file formats and their respective tag formats. Mp3tag is the universal Tag Editor.
The other thing that I think would be helpful would be to include the menu bar icons used in mp3tag in all of the applicable sections. This would help provide a visual link from the help documents to those functions within the mp3tag window. I’m not sure how easy it is to insert these,
The fixed mapping link is broken in the section Mapping\> User-defined field mappings
> **[Mapping – Mp3tag Documentation](https://docs.mp3tag.de/customization/options/tags/mapping/)**
>
> Documentation of user-defined field mapping configuration options. Mp3tag is the universal Tag Editor.
There are several references to “field“ values, enclosed in the less-than and greater-than characters that the forum won’t show. Perhaps these can be an active link to a page with a list of the common ones that are pre-defined in mp3tag. The list should match those in the filter, broken into the standard, extended, and information fields. Of course this can be further enhanced by custom user-defined fields but are behind the scope of those defined here.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 7, 2022, 7:26am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/35 "2022-03-07T07:26:05Z")
Just a few amendments:
The List of Menus does not mention the Help menu.
As this menu features some functions that may help (!) if something does not work like
"Check for updates" where the failure to produce a message indicates that MP3tag has no internet access
or
the "About" dialogue which now tells you what kind of installation you have (Standard or portable),
it would be nice to see these functions mentioned.
(I do see the problem that if you have no internet access and you want to see the information about how to check the connection that this is could turn into a cul-de-sac.)
In the section "[Download and Installation](https://docs.mp3tag.de/getting-started/installation/)" a link to the function File\>Open Configuration folder and Help\>About would add more insight.
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 7, 2022, 9:27am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/36 "2022-03-07T09:27:13Z")
> [@MotleyG](#):
>
> In the Getting Started\>Overview section there is mention of several audio formats that mp3tag supports. This is not a complete list, but also it does _not_ mention that mp3tag also supports several video formats as well. I think this should be relevant. Plus you can link from this paragraph to the full list of supported file formats referenced later.
I'm not sure, but maybe you're referring to an older version of that site. It mentions some tag formats and links to [Supported File Formats – Mp3tag Documentation](https://docs.mp3tag.de/file-formats/)
> [@MotleyG](#):
>
> The other thing that I think would be helpful would be to include the menu bar icons used in mp3tag in all of the applicable sections.
I've made a note regarding this.
> [@MotleyG](#):
>
> The fixed mapping link is broken in the section Mapping\> User-defined field mappings
Fixed, thanks!
> [@MotleyG](#):
>
> There are several references to “field“ values, enclosed in the less-than and greater-than characters that the forum won’t show.
I'm afraid, I don't understand this suggestion. Can you give an example?
---
### Author:  [@Florian](https://community.mp3tag.de/u/Florian)
#### Post date: [March 7, 2022, 10:14am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/37 "2022-03-07T10:14:06Z")
> [@ohrenkino](#):
>
> The List of Menus does not mention the Help menu.
Added, [Menu Help – Mp3tag Documentation](https://docs.mp3tag.de/menus/help/)
> [@ohrenkino](#):
>
> In the section "[Download and Installation](https://docs.mp3tag.de/getting-started/installation/)" a link to the function File\>Open Configuration folder and Help\>About would add more insight.
I've added some details on Backup and Restore of configuration settings and mentioned the menu entry in this context.
---
### Author:  [@LyricsLover](https://community.mp3tag.de/u/LyricsLover)
#### Post date: [March 7, 2022, 10:24am UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/38 "2022-03-07T10:24:49Z")
I suggest to release an additional overview in table format for the [tag mapping](https://docs.mp3tag.de/mapping/) like this:
[https://wiki.hydrogenaud.io/index.php?title=Tag\_Mapping#Mapping\_Tables](https://wiki.hydrogenaud.io/index.php?title=Tag_Mapping#Mapping_Tables)
or your own "old" [Tag Field Mappings – Mp3tag Documentation](https://docs.mp3tag.de/mapping)
This could be done as separate PDF or Picture (it's size could be increased by clicking on it) if a table doesn't fit in the current layout.
---
### Author:  [@MotleyG](https://community.mp3tag.de/u/MotleyG)
#### Post date: [March 7, 2022, 2:37pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/39 "2022-03-07T14:37:05Z")
> [@Florian](#):
>
> I'm not sure, but maybe you're referring to an older version of that site. It mentions some tag formats and links to [Supported File Formats – Mp3tag Documentation](https://docs.mp3tag.de/file-formats/)
I must have missed the highlight for the link when I was reading through it last night, as it is there now. But it calls out specifically "audio formats" and I was suggesting that mp3tag is now much more diverse and also allows tag editing for several video formats as well. Perhaps a small change to the link to indicate "a variety of audio _and video_ formats" would be more accurate.
> [@MotleyG](#):
>
> There are several references to “field“ values, enclosed in the less-than and greater-than characters that the forum won’t show.
I'm afraid, I don't understand this suggestion. Can you give an example?
[/quote]
On the filter page...
> **[Filter and Search – Mp3tag Documentation](https://docs.mp3tag.de/filter/)**
>
> Documentation on Filter and Search and keywords to form complex filter expressions. Mp3tag is the universal Tag Editor.
...their are many examples of the use of `` but none are linked to any references like almost all others are.
> **[Filter and Search – Mp3tag Documentation](https://docs.mp3tag.de/filter/)**
>
> Documentation on Filter and Search and keywords to form complex filter expressions. Mp3tag is the universal Tag Editor.
Here there is mention that `*` will address all fields.
Other examples provide some scope with an example, but nowhere is there a list in the help of what all of the valid existing predefined `` values are. A reference page to list these for these may clarify better where a user may begin.
---
### Author:  [@ohrenkino](https://community.mp3tag.de/u/ohrenkino)
#### Post date: [March 7, 2022, 3:19pm UTC](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/40 "2022-03-07T15:19:34Z")
> [@MotleyG](#):
>
> the valid existing predefined `` values
I would like to support your point of view.
This is something I tried to address in my post here:
> [@Updated Documentation — Work in Progress](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547/31):
>
> On the topic of filters "It is not possible to filter by strings containing double quotations marks. This is a limitation of the feature." - I think that there was the workaround with $char(34) e.g. I am not sure if the filter syntax is really described correctly. Most syntax examples start with \ ... (fascinatingly with some kind of metasyntax...) but I think that this not really just a \ as there are filter examples like where the scripting part at the front is not really…
You can see that I had my problems with this notation and metasyntax.
I still think that it is not a field but a "generating format string" - which is used in many other contexts.
I would still consider it a nice move to use the same jargon for all these contexts.
[Previous page](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547.md?page=1)
[Next page](https://community.mp3tag.de/t/updated-documentation-work-in-progress/56547.md?page=3)