AniDB O'Matic - Documentation: Local file renaming: Difference between revisions

Here's a few sample patterns:

* "?a - ?ep - ?e [?g]" -> <br />"Anime - 02 - Episode name [Group name]"

* "?a - ?epv?v - ?e?if(lg<><nowiki>''</nowiki>, ' ['+lg+']', <nowiki>''</nowiki>)" -> <br />With group: "Anime - 02v1 - Episode name [Group name]"<br />Without group:"Anime - 02v1 - Episode name"

* "?if(wltw, 'To watch\', <nowiki>''</nowiki>)?a?if(isMovie, if(epps>1, ' - Part '+epp+if(v>1, 'v'+v, <nowiki>''</nowiki>), if(v>1, ' - v'+v, <nowiki>''</nowiki>)), ep+if(v>1, v, <nowiki>''</nowiki>)+'- ?e') ?if(lg<><nowiki>''</nowiki>, lg+' ', <nowiki>''</nowiki>){?crc32}" -> <br />For a movie: "Anime name - v2 [Group name]{crc32}"<br />For a movie with 2 parts: "Anime name - Part 2v2 [Group name]{crc32}<br />For a normal anime, marked as "to watch in wishlist": "To watch\Anime name - 02v2 - Episode name [Group name]{crc32}

===Default pattern===

===Constant expressions===

'text' - use '' to insert a ' (e.g. 'her''s')<br />

or<br />

"text" - use \" to insert a "  (e.g. "a \"quotation\"")<br />

<br />

Number literals are simply written as numbers:<br />

1234<br />

<br />

There are also boolean consants:<br />

true<br />

false<br />

===Custom tags===

With custom tags you could simplify for example the group rule, for example you could write it:

* Using ?if: "?if(lg<><nowiki>''</nowiki>, '['+lg+']', <nowiki>''</nowiki>)" -> "?G"

* Simplest form: "[?lg]" -> "?G"

* More advanced example: "?if(lg<><nowiki>''</nowiki>, '['+lg']', if(sg<><nowiki>''</nowiki>, '['+sg']', '[RAW]'))" -> "?G"

Note that custom tags are essentially translated to ?set commands. Aka, "[?lg]" -> "?G" iq equivalent to adding "?set('G', '['+lg+']')" in front of a pattern.

===Default tags===

|?a||text||Anime name

|?ab||number||Audio bitrate

|-

|?ac||text||Audio codec

|-

|?aid||number||Anime ID

|-

|?ar||number||Average review score

|?atv||number||Average temp vote

|-

|?av||number||Average vote

|?e||text||Episode name

|-

|?ep2, ?ep3, ?ep4||text||Zero padded episode number, eg ?ep3 = 007

|-

|?epc||number||Total number of episodes in the current category (for example: 24 for normal episodes, 7 for specials, 2 for op, etc.)

|-

|?epp||number||Movie part number ep1 = 1, ep2 = 1, ep3 = 2, ep4 = 1 etc.

|-

|?epps||number||Total number of movie parts ep1 = 1, ep2 = 2, ep4 = 3

|-

|?eps||number||Total number of episodes

|-

|-

|?fs||text||File source

|?g||text||Group name, long (?lg) if available, otherwise short (?sg)

|-

|?gid||number||Group ID

|-

|?isKnown||boolean||True if the file is known to AniDB

|-

|?isMovie||boolean||True if the current file belongs to a movie anime

|-

|?isSpecial||boolean||True if the current file belongs to a special episode (Such as Op or Ed)

|-

|?lang||text||Shows 1-2 Audio and 1-2 Subtitle languages

|-

|?lac||number||Number of audio languages

|-

|?la1, ?la2, ?la3, ?la4||text||Shows 1-4 audio languages

|-

|-

|?ls||text||Shows all subtitle languages

|-

|?lsc||number||Number of subtitle languages

|-

|?ls1, ?ls2, ?ls3, ?ls4||text||Shows 1-4 subtitle languages

|-

|?m||number||Release month of anime

|-

|?seps||number||Total number of special episodes

|-

|?sg||text||Short group name

|-

|?v||number||File version

|?w||boolean||File watched status, true if watched

|?wa||boolean||Anime watched status, true if all normal episodes have been watched

|-

|?wad||text||Anime detailed watched status, returns "none", "partial" or "all"

|-

|?wltg||boolean||True if the anime is marked as "to get" in the wishlist

|-

|?wlp||number||Returns wishlist priority, 0 = high, 1 = normal, 2 = low

|?wltw||boolean||True if the anime is marked as "to watch" in the wishlist

|-

|?y||number||Release year of anime

|-

|?ye||number||End year of anime

|-

|?yme||text||End year and month of anime

===Function tags===

|?if(test, trueval, falseval)||any||If statement, returns trueval if test is true, otherwise returns falseval.<br /> Example: ?if(a=b, 'equal', 'not equal')

|-

|?in(find, text)||boolean||Checks if find is present text.<br />Example ?in('complete movie', lc(e))

|-

|?join(glue, text...)||text||Joins together two or more texts, empty parameters are ignored with no glue added.<br />Example ?join(' ', 'a', 'b', 'c')

|-

|?lc(text)||text||Converts text to lower case.<br />Example ?lc(crc)

|-

|?length(text)||number||Returns the text length of text.<br />Example ?length(a)

|-

|?limit(text, length[, end])||text||Limits the length of text to at most length characters. End is optional, if specified and the text is cropped, it'll be added at the end of text.<br />Example ?limit(e, 100) or ?limit(e, 100, '...')

|-

|?min(number...)||number||Returns the lowest supplied number<br />Example ?min(1, 7, 3, 9, 2) returns 1

|-

|?max(number...)||number||Returns the highest supplied number<br />Example ?max(1, 7, 3, 9, 2) returns 9

|-

|?out(variable)||any||Returns variable.<br />Example ?out(crc)

|-

|?sc(text)||text||Converts text to sentence case.<br />Example ?sc(a)

|-

|?set(name, data)||nothing||Declares a new tag called name containing data, same as custom tags internally.<br />Example ?set('temp', 'text')

|-

|?split(text, find, index)||text||Splits text on find and returns the specified index. Index starts from 1.<br />Example ?split(ym, '-', 2)

|-

|?start(text, find)||boolean||Checks if find matches the start of text.<br />Example ?start(y, '199')

|-

|?tc(text)||text||Converts text to title case.<br />Example ?tc(a)

|-

|?uc(text)||text||Converts text to upper case.<br />Example ?uc(crc)

'''Logical operators'''<br />

==File managers==

File managers are used to automatically manage file renaming / removing and adding / updating files in your MyList.

===Rename pattern===

Each file manager can have 1 renaming pattern. To use multiple patterns you need to specify multiple patterns. The rename pattern can contain a part of a path or a full path to indicate where the file should be stored. The path part of a rename might be ignored under certain circumstances however, see below.

===Target paths===

A file manager can have one or more target paths for moving files. If no target path is specified the folder the file was found in will be used instead. If there are multiple target paths the file manager will try to figure out where the file has the most related files. This is determined by a) the anime the file belongs to and b) the anime group the file belongs to. If there's not enough space available on the target drive it'll check the next preferred target if there's enough space and so on. If no space is available in any target path the file will be renamed in it's current location, but with any path part of the file removed, aka the filename part of the rename pattern will be used but the file will remain in the folder it was found in.

 

 

 

 

===Add new files to AniDB===

This will make the file manager automatically add found files to your MyList.

 

This will make the file manager automatically update the storage field of MyList entries based on the volume it's stored on. This field currently only works for files on a removable storage such as a DVD. The label used will be the label of the removable media, eg. DVD #013.

 

This will make the file manager update your MyList to OnHDD if the file was found on a HDD or Network drive, or OnRemovable if the file is on a CD/DVD.

 

===Automatically mark removed files as Deleted in MyList===

This will make the file manager update your MyList to indicate the file has been deleted if removed by the above rule.