| Personal Video Database Export Templates Manual |
| File structure: | » |
| Main Template | ||||
| %OPTIONS% | ||||
| encoding=”S” | Defines encoding of the resulting file. Possible values are: UTF8, UTF8BOM, ANSI | |||
| sortby=”S” | Defines the field by which records are to be sorted (field numeric identifiers or string constants are acceptable)(see Movie Field Values and Person Field Values) | |||
| sortdir=”S” | Defines sort direction. Possible values are: sdAscending, sdDescending | |||
| recordtemplate=”S” | Defines the file that contains a record template file (relative path). Following variables can be used to format the file name and/or path: %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| imagepath=”S” | Defines the path where images are to be saved (relative to the resulting text file). Following variables can be used to format the file name and/or path: %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| copyfile="source<->target" | Makes the plug-in copy certain files to a new location. Following variables can be used to format the file name and/or path: %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| fullstar=”S” | Defines the path to the full star image used to display rating (relative to resulting text file). Following variables can be used to format the file name and/or path: %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| halfstar=”S” | Defines the path to the half star image used to display rating (relative to resulting text file). Following variables can be used to format the file name and/or path: %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| nonestar=”S” | Defines the path to the empty star image used to display rating (relative to resulting text file). Following variables can be used to format the file name and/or path: %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| itemsperpage=”X” | Defines the number of records exported to one page. Each page will be saved in separate file with following naming format: filenamepagenumber.extension | |||
| filter=”S” | File filter used in "Save as" dialog. Format: File Type Name|*.extension1;*.extension2;...;*.extensionN | |||
| recordfilename=”S” | Defines the format of the filename for files generated using Record Template. Following variables can be used to distinguish files of different records: %id% - movie ID, %t% - Title/Name, %ot% - Original Title/Translated Name, %y% - Movie Year, %rid% - Database record id, %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| pagestpl=”S” | Defines the path to a template for generating a list of pages relative to main template file | |||
| prevtpl=”S” | Defines the path to a template used in Page Template to create a link to a previous page relative to main template file | |||
| nexttpl=”S” | Defines the path to a template used in Page Template to create a link to a next page relative to main template file | |||
| pagelinktpl=”S” | Defines the path to a template used in Page Template to create a link to a certain page number relative to main template file | |||
| pagecurtpl=”S” | Defines the path to a template used in Page Template to output current page number relative to main template file | |||
| replace=”value1<->value2” | Tells the export plug-in to replaces all occurrences of value1 with value2. You can set value1 or value2 to a line break using #13#10 | |||
| boolvals=”TrueValue<->FalseValue” | Defines strings that should be used for Boolean field values | |||
| replacecase=” value1<->value2” | Same as replace, but case sensitive | |||
| nearfiles=”B” | This option tells the plugin to store exported files near video files and defines how to format filenames. Possible variables are: %id% - movie ID, %t% - Title/Name, %ot% - Original Title/Translated Name, %y% - Movie Year, %rid% - Database record id | |||
| imagenameformat=”S” | Tells the export plug-in how to format filenames of the images resulting from export. Possible variables are: %id% - movie ID, %w% - Image Width, %h% - Image Height, %ext% - File Extension, %f% - Image Field, %fs% - Image Type, %t% - Title/Name, %ot% - Original Title/Translated Name, %y% - Movie Year, %rid% - Database record id, %in% - Image Number, %fname% - selected target filename (without extension), %fext% - selected target file extension | |||
| %OPTIONS% | ||||
| All Templates | ||||
| Header | Page Template | Footer | ||
| You can place header code that is not repeated for each value or record between tag: %HEAD% | You can place footer code that is not repeated for each value or record between tag: %FOOT% | |||
| Values {%value=”identifier”} | ||||
| Special Values | ||||
| 200 | Total records count | |||
| 201 | Total pages count | |||
| 202 | Current page number | |||
| 203 | Current record number | |||
| 204 | Path to the database file (including file name) | |||
| 205 | Database name | |||
| 206 | Path to the first page (HTML) | |||
| 207 | Path to the index file for the current record (HTML) | |||
| 208 | Path to the last page (HTML) | |||
| 209 | Path to the previous page (HTML) | |||
| 210 | Path to the next page (HTML) | |||
| 211 | Insert pages template | |||
| 212 | Inserts list of page numbers using Page Templates | |||
| 213 | Insert previous page template | |||
| 214 | Insert next page template | |||
| 215 | Path to the current record's file (HTML) | |||
| 216 | Path to the previous record's file (HTML) | |||
| 217 | Path to the next record's file (HTML) | |||
| 218 | Insert a hyperlink to a certain page | |||
| 219 | Path to the first page | |||
| 220 | Path to the index file for the current record | |||
| 221 | Path to the last page | |||
| 222 | Path to the previous page | |||
| 223 | Path to the next page | |||
| 224 | Path to the current record's file | |||
| 225 | Path to the current record's file | |||
| 226 | Path to the next record's file | |||
| 227 | Path to the images (relative) | |||
| 228 | Path to the images (relative) (HTML) | |||
| 229 | Path to the images (full) | |||
| 230 | Path to the images (full) (HTML) | |||
| 231 | Current date | |||
| 232 | Current time | |||
| 233 | Selected file name (without extension) | |||
| 234 | Selected file extension | |||
| 300 | IMDB ID (retrieved from URL) | |||
| 301 | Video Width (Movies only) | |||
| 302 | Video Height | |||
| Field Values (Movie) | ||||
| Identifier | Field | Parameters | ||
| mid | Database Record ID | |||
| num | Movie ID | |||
| title | Title | |||
| origtitle | Original Title | |||
| aka | Also Known As (separated with line break) | template, maxvalues | ||
| year | Year | |||
| genre | Genre (comma separated list) | template, maxvalues | ||
| country | Country (comma separated list) | template, maxvalues | ||
| studio | Studio (comma separated list) | template, maxvalues | ||
| release | Release | |||
| mpaa | MPAA | |||
| location | Media Location | |||
| category | Category (comma separated list) | template, maxvalues | ||
| tagline | Tagline (multiline) | |||
| description | Description (multiline) | |||
| count | Media Count | |||
| type | Media Type | |||
| rating | Rating | template | ||
| imdbrating | IMDB Rating | template | ||
| orating | Additional Rating | template | ||
| orname | Additional Rating Name | |||
| rip | Quality | |||
| length | Duration | format | ||
| langs | Language (comma separated list) | template, maxvalues | ||
| translation | Translation (comma separated list) | template, maxvalues | ||
| resolution | Resolution | |||
| videocodec | Video Codec | |||
| videobitrate | Video Bitrate | |||
| audiocodec | Audio Codec (comma separated list) | template, maxvalues | ||
| audiobitrate | Audio Bitrate (comma separated list) | template, maxvalues | ||
| audiocount | Number of audio streams | |||
| sampling | Audio stream sampling (comma separated list) | template, maxvalues | ||
| channels | Audio stream channels count (comma separated list) | template, maxvalues | ||
| rdate | Release Date | |||
| budget | Budget | |||
| money | Box Office | |||
| aspect | Aspect Ratio | |||
| size | File Size | |||
| url | URL (separated with space) | |||
| path | File Path (files separated with |) | template, maxvalues | ||
| comment | Comment (multiline) | |||
| dateadded | Date Added | |||
| moddate | Date Modified | |||
| code | Barcode | |||
| medialabel | Media Label (comma separated list) | template, maxvalues | ||
| loan | Is Borrowed (Boolean) | |||
| subs | Subtitles (comma separated list) | template, maxvalues | ||
| framerate | Frame Rate | |||
| features | Features (multiline) | |||
| viewed | Seen (Boolean) | |||
| bookmark | Bookmarked (Boolean) | |||
| wish | Wish (Boolean) | |||
| series | Is Series (Boolean) | |||
| episodes | Episodes | template, grouptemplate | ||
| visible | Visible (Boolean) | |||
| loandate | Loan Date | |||
| loanname | Borrowed to | |||
| loanperiod | Load Period | |||
| Borrowed to (Email) | ||||
| viewdate | View Date | |||
| tags | Tags (comma separated list) | template, maxvalues | ||
| awards | Awards | template, grouptemplate | ||
| links | Connections | template, grouptemplate | ||
| astreams | Audio Streams | template, grouptemplate | ||
| origlang | Original Language | |||
| extension | Video File Extension | |||
| actors | Actors | template, maxvalues, params | ||
| directors | Directors | template, maxvalues, params | ||
| writers | Writers | template, maxvalues, params | ||
| composers | Composers | template, maxvalues, params | ||
| producers | Producers | template, maxvalues, params | ||
| credits | Credits | template, grouptemplate | ||
| poster | Poster | template, maxvalues, params, width, height | ||
| screenshots | Screenshots | template, maxvalues, params, width, height | ||
| froncover | Front Cover | template, params, width, height | ||
| cdcover | Disc Cover | template, params, width, height | ||
| CustomFieldName | Custom Field | custom | ||
| Field Values (Person) | ||||
| Identifier | Field | Parameters | ||
| pid | Database Record ID | |||
| name | Name | |||
| transname | Translated Name | |||
| altnames | Alternative Names (comma separated list) | template, maxvalues | ||
| birthday | Birthday | |||
| birthplace | Birthplace | |||
| bookmark | Bookmarked (Boolean) | |||
| visible | Visible (Boolean) | |||
| bio | Biography (multiline) | |||
| filmography | Filmography | template, grouptemplate | ||
| comment | Comment (multiline) | |||
| death | Date of Death | |||
| age | Age | |||
| url | URL (separated with space) | template, maxvalues | ||
| genre | Genre (comma separated list) | template, maxvalues | ||
| dateadded | Date Added | |||
| moddate | Date Modified | |||
| careertype | Career Type (comma separated list) | template, maxvalues | ||
| awards | Awards | template, grouptemplate | ||
| photo | Photo | template, maxvalues, params, width, height | ||
| Parameters {%value="identifier" parameter="value"} | ||||
| template | Path to subtemplate for fields with multiple values or multiple groups (relative path) | |||
| grouptemplate | Path to group subtemplate for fields that support grouping (relative path) | |||
| params | Set this parameter to full to tell the export plug-in to retrieve all possible data associated with the field | |||
| maxvalues | Maximum values count for fields with multiple values | |||
| width | Maximum image width (The image will be resized to fit) | |||
| height | Maximum image height (The image will be resized to fit) | |||
| format | Format of the duration field. Possible values are: s – Seconds, m – Minutes, Standard time format string like HH:MM:SS | |||
| custom | Set to true if you want to retrieve a custom field value | |||
| SubTemplates | ||||
| {%value} (without parameters) is used in subtemplates of fields with multiple values to represent a certain value and in page templates to output current page number | ||||
| {%param=”identifier”} Retrieves a certain field value | ||||
| {%groupparam=identifier} Defines the field by which values should be grouped (Group Templates only) | ||||
| Actors, Directors, Producers, Writers, Composers | pid – Database record id, name, transname, url, role | |||
| Links | mid – Database record id, linktype – Link Category, linkname – Link Name , num – Movie ID, title, origtitle, year, imdbrating, rating, description, url | |||
| Awards | event, year, result, award, category | |||
| Episodes | epid – Database episode id, mid – Database record id, epnum – Episode Number, season – Season Number, num – Episode Movie ID, title, origtitle, year, imdbrating, rating, description, url | |||
| Credits | ctype – Credits Type: 0 – Actors, 1 – Directors, 2 – Writers, 3 – Composers, 4 - Producers, pid – Database record id, name, transname, url, role | |||
| Filmography | ctype – Credits Type: 0 – Actors, 1 – Directors, 2 – Writers, 3 – Composers, 4 - Producers, ctypestr – Credits Type string equivalent, mid – Database record id, title, origtitle, year, role, url | |||
| Posters, Photos, Screenshots | imgid – Database image id, imgformat – Image Format (jpg, bmp, gif, png, tif), imgpath – path to the location where the image is saved (if images are saved not inside the database), imgdata – path to the location where the exported image will be saved | |||
| Functions: | « |
| Syntax: {#Function Name Parmeters separated by space, quote character is '} | ||
| Function | Description | Example |
| ExtractFilePath | Removes filename from file path passed as parameter |
{#ExtractFilePath 'C:\test.txt'} Result: C:\ |
| ExtractFileName | Removes path leaving only the filename from file path passed as parameter |
{#ExtractFileName 'C:\test.txt'} Result: test.txt |
| ExtractFileExt | Extracts extension from filename (or full file path) |
{#ExtractFileExt 'C:\test.txt'} Result: .txt |
| ConditionAdd | Adds certain text at the end if the passed parameter fits condition |
{#ConditionAdd > '0' '{%value=count}' ' x {%value=type}'} If Media Count > 0 then output: Media Count value x Media |
| ConditionAddFirst | Adds certain text in the beginning if the passed parameter fits condition |
{#ConditionAddFirst = 'test' '{%value=label}' 'Test Label is '} If Media Label is equal to test then output: Test Label is Media Label |
| StringReplace | Replaces a part of a string with another string |
{#StringReplace '{%value=wish}' '0' 'no'} Replace 0 with no in Wish field |