Page 1 of 1

Documentation incomplete

Posted: 07 Feb 2017, 09:26
by j1simon
When I press in Syntax example
Image

it opens the URL: http://www.filebot.net/naming.html but it lacks functions like: colon.
By other side in examples there is: "{ny}/{ny}" and this is translated like "movie (year)/movie (year)", where is explained this?
Regards.

Re: Documentation incomplete

Posted: 07 Feb 2017, 10:05
by rednoah
The built-in reference Image is the definite guide to what bindings are available.

The website may not always be up-to-date with the latest bindings and available methods. Click source for more detailed information that is always up-to-date.

Re: Documentation incomplete

Posted: 07 Feb 2017, 10:35
by j1simon
In that built-in reference lacks the functions or they are incomplete.
By other side, I'm testing the "movie bindings" and, for example, I select "n" and I press "Use Bidings", it closes window but it doesn't fill the expression field in "movie format" window.

Re: Documentation incomplete

Posted: 07 Feb 2017, 10:40
by rednoah
Use Bindings does set the movie object and the sample file. It is not supposed to insert variables selected in the Preview area into the format. Though it's an interesting idea.

Re: Documentation incomplete

Posted: 08 Feb 2017, 09:32
by j1simon
What's the purpose of the button "Use Bindings" if it does the same as cancel?
By other side, the documentation still is incomplete in web and in program. Moreover, In program is too difficult read them.

Re: Documentation incomplete

Posted: 08 Feb 2017, 11:07
by rednoah
1.
If you change the sample file, then Use Bindings will confirm that change, and Cancel will ignore that change.

If you do not change the sample file then it indeed does not matter what button you click.


2.
I currently don't have time to maintain the documentation.

While there are a few FileBot additions like colon() and slash() a complete documentation would necessarily need to include the relevant parts of the Java/Groovy API and that's not even remotely feasible.

I'll add the colon/slash helpers to the docs when I have time. But there's a few hundred more String methods that are part of Java/Groovy and you'll have to refer to the official API docs for that.

If you have a question on how to do something or how something works then you can either ask or just play with it.

e.g.

Code: Select all

"A: B".colon(" - ")

EDIT:

Lower-level auto-generated docs are now available here:
http://www.filebot.net/docs/net/filebot ... thods.html

Re: Documentation incomplete

Posted: 09 Feb 2017, 09:54
by j1simon
rednoah wrote:1.
If you change the sample file, then Use Bindings will confirm that change, and Cancel will ignore that change.
IMHO, that is unnecessary. The user clicks in "Select Media File" button and it selects a file (confirming in the "file explorer" window), why is it necessary to press another button to confirm a change that I have already confirmed?
This double confirmation would make sense if it were a permanent change such as rename, delete, move file,... But in this case it is just select a sample file to illustrate the expressions.

By other side it doesn't work correctly, If I press the "Use bindings" button immediately after selecting the file, it closes the window without updating the information: https://dl.dropboxusercontent.com/u/146 ... lebot2.mp4
If it needs time to update the information, it would be a good idea to show a modal window indicating it and prevent closing the window or disabling the "Use bindings" button meanwhile.

Re: Documentation incomplete

Posted: 09 Feb 2017, 10:08
by rednoah
1.
The Edit Format workflow works as follows:

Select a Sample. Have a look at the Preview values. Decide if you want to test your format with this sample file or select another or Cancel and revert to whatever file was selected previously.

If you were to select a file, but then decide you'd rather rather keep the previous one, you can just click Cancel, instead of going through the whole file dialog to find the previous file again.

:idea: IF you open the Format Editor by double-clicking a match in New Names then the Binding Dialog will only have an OK button because you won't be able to change the sample data.


2.
{ny} is based on the Info Object which is "Maniaco (1980)" in the Movie Bindings Dialog. Changing the Media File affects file bindings like {vc} {af} {crc32} etc but not necessarily metadata bindings. Just scroll down a bit in the Preview area if you want to see which bindings are different for different files.

:idea: Changing the Info Object is only possible by selecting a xattr tagged Media File. If the Media File is not xattr tagged, then the Info Object won't change.