The PAD File filter is used to insert fields from your PAD File anywhere in your nodes. The following describe the usage.
The tag has two syntaxes. One is to access a field directly in one of your PAD File. This one is written like this: [padfile: language padfile-name field] where language is optional. Also, if the padfile-name is not specified, the system will attempt to look for the PAD File named "pad_file". (The recommanded default for your website if you have just one single PAD File.) So a simple tag such as [padfile: link] will insert a link to your padfile.xml file.
The other syntax is very similar but does not pertain to any specific PAD File. It is written like this: [padfile: field]
The language can be used abbreviated or in full. So English and en are equivalent. The language is not necessary for most fields which are not translated. However, it is useful for the link to force only a specific description language and for the descriptions (obviously!)
The name of the PAD File is the filename only, not the name of the program (because the filename needs to be unique.) Also, you can specify the PADID.
In a few cases, you can use some extraneous arguments. In those cases you must specify all the parameters. If you want all the languages or the language name is ignored anyway, you may simply use the special keyword 'all' for the language. For instance, to present the screenshot in a smaller size such as 640x480, you can use the following:
[padfile: all pad_file screenshot 640 480]
At this time, only the icon and screenshot make use of the width and height parameters. None of the other fields have extra arguments.
The available fields are listed in the table below:
| Field | Comments | Language |
|---|---|---|
| active | Wether the PAD File is 'active' or 'off'. | Ignored |
| address_1 | The first line of address of the owner. | Ignored |
| address_2 | The second line of address of the owner. | Ignored |
| author_first_name | First name of the program author. | Ignored |
| author_last_name | Last name of the program author. | Ignored |
| author_email | Email address, as a mailto: link, of the program author. Note that since this is public in the PAD File, having it on screen makes no difference. | Ignored |
| author_email_only | The email address only as plain text. | Ignored |
| byte_size | The exact size of the program file one can download (i.e. the packaged file). | Ignored |
| category | The category, in full. | Ignored |
| category_detail | The last part of the category (after the ::). | Ignored |
| category_group | The first part of the category (before the ::). | Ignored |
| change_log | The change log text. Since it cannot include HTML, it is displayed as plain text. The newline characters are changed to <bt/>. | Ignored |
| city_town | The name of the city where the owner resides. | Ignored |
| company_name | The name of the owner, a company or an author. | Ignored |
| contact_first_name | First name of the program contact. | Ignored |
| contact_last_name | Last name of the program contact. | Ignored |
| contact_email | Email address, as a mailto: link, of the program contact. Note that since this is public in the PAD File, having it on screen makes no difference. | Ignored |
| contact_email_only | The email address only as plain text. | Ignored |
| cost | The amount of money the program costs in the indicated currency. | Ignored |
| country | The name of the country where the owner resides. | Ignored |
| creation_date | The date when you created the PAD File on your Drupal website. | Ignored |
| creation_time | The time when you created the PAD File on your Drupal website. | Ignored |
| currency | The name of the currency used with the cost field. | Ignored |
| currency_3letters | The 3 letter name of the currency used with the cost field. | Ignored |
| desc45 | The description of 45 characters or less. | Required |
| desc80 | The description of 80 characters or less. | Required |
| desc250 | The description of 250 characters or less. | Required |
| desc450 | The description of 450 characters or less. | Required |
| desc2000 | The description of 2000 characters or less. | Required |
| distribution_permissions | The distribution permissions of the program. The newline characters are changed to <bt/>. | Ignored |
| download_counter | The number of times this file was downloaded. | Ignored |
| download_url_primary | Show a link to the page where the customers can download the product. The label is the name of the product with the word "Download" in front of it. | Ignored |
| download_url_primary_only | The URL to the page where the customers can download the product. | Ignored |
| download_url_primary_with_icon | Show a link to the page where the customers can download the product. The image is the icon of the product. | Ignored |
| download_url_other1 | Show a backup link to the page where the customers can download the product. The label is the name of the product with the word "Download" in front of it. | Ignored |
| download_url_other1_only | A backup URL to the page where the customers can download the product. | Ignored |
| download_url_other2 | Show a backup link to the page where the customers can download the product. The label is the name of the product with the word "Download" in front of it. | Ignored |
| download_url_other2_only | A backup URL to the page where the customers can download the product. | Ignored |
| download_url_secondary | Show a backup link to the page where the customers can download the product. The label is the name of the product with the word "Download" in front of it. | Ignored |
| download_url_secondary_only | A backup URL to the page where the customers can download the product. | Ignored |
| eula | The complete EULA of the program. The newline characters are changed to <bt/>. | Ignored |
| expiration | The count of days or uses formatted according to the base. | Ignored |
| expiration_base | The raw expiration base. | Ignored |
| expiration_count | The raw expiration count. | Ignored |
| expiration_date | The date when the program expires. | Ignored |
| expiration_info | The textual information about the expiration mechanism(s) of the program. | Ignored |
| expiration_time | The time when the program expires. | Ignored |
| export | Add an inline link to the PAD File which will open a window so your users can save the PAD File on their hard drive. When a language is specified, only include that language in the PAD File. | Optional |
| export_url | The link to the PAD File so the user can export (save it to disk). When a language is specified, only include that language in the PAD File. | Optional |
| fax_phone | The fax phone number of the company or author. | Ignored |
| general_email | Email address, as a mailto: link, of the program general. Note that since this is public in the PAD File, having it on screen makes no difference. | Ignored |
| general_email_only | The email address only as plain text. | Ignored |
| general_phone | The general phone number of the company or author. | Ignored |
| hr_size | The human readable size of the program file. This means it is tested and shown in bytes if less than 1024, in Kilobytes when between 1024 and 768Kb and Megabytes when over 768Kb. | Ignored |
| icon_url | The IMG tag to the program icon. | Ignored |
| icon_url_only | The raw URL to the program icon. | Ignored |
| info_url | A link to a page presenting the program in details. | Ignored |
| info_url_only | The raw URL to the info page. | Ignored |
| info_url_with_icon | A URL to the info page of the program using the program icon. | Ignored |
| kb_size | The approximative size of the program file in kilobytes. | Ignored |
| keywords | The list of keywords for this set of descriptions. | Required |
| install_support | What the program installer supports in regard to install/uninstallation. | Ignored |
| languages | The languages found in the program. | Ignored |
| link | Add an inline link to the PAD File. When a language is specified, only include that language in the PAD File. This uses the name of the program as the link label. | Optional |
| link_url | The URL of the link to the PAD File. When a language is specified, only include that language in the PAD File. This URL is the same as the one generated by link | Optional |
| link_with_icon | Add an inline link to the PAD File. When a language is specified, only include that language in the PAD File. This uses the icon of the program as the link image. | Optional |
| link_with_screenshot | Add an inline link to the PAD File. When a language is specified, only include that language in the PAD File. This uses the screenshot of the program as the link image. | Optional |
| mb_size | The approximative size of the program in megabytes. | Ignored |
| modification_date | The date when you last modified the PAD File on your Drupal website. | Ignored |
| modification_time | The time when you last modified the PAD File on your Drupal website. | Ignored |
| operating_systems | The different operating systems supported by the program. | Ignored |
| ordering_url | A link to the page where your customers can pay for your software. The label is set to "Click to order <program name>" | Ignored |
| ordering_url_only | The URL to the ordering page. | Ignored |
| ordering_url_with_icon | A link to the page where your customers can pay for your software. The image is set to the program icon. | Ignored |
| padid | The identifier of this PAD File in the Drupal database. | Ignored |
| program_name | Insert the name of the program as it appears in the PAD File. | Ignored |
| release_date | The date when the program was released. | Ignored |
| release_time | The time when the program was released. | Ignored |
| requirements | The different requirements for the software to work. | Ignored |
| sales_email | Email address, as a mailto: link, of the program sales. Note that since this is public in the PAD File, having it on screen makes no difference. | Ignored |
| sales_email_only | The email address only as plain text. | Ignored |
| sales_phone | The phone number one can use to purchase the product. | Ignored |
| screenshot_url | The IMG tag to the program screenshot. | Ignored |
| screenshot_url_only | The raw URL to the program screenshot. | Ignored |
| state | The name of the state where the owner resides. | Ignored |
| status | The current status of the program (such as Alpha, Beta, ...) | Ignored |
| support_email | Email address, as a mailto: link, of the program support. Note that since this is public in the PAD File, having it on screen makes no difference. | Ignored |
| support_email_only | The email address only as plain text. | Ignored |
| support_phone | The support phone number of the company or author. | Ignored |
| total_count | The total number of PAD File, active and inactive. | Ignored |
| total_downloads | The total number of downloads, across all PAD Files, whether they are active or not. | Ignored |
| type | The type of software (such as Shareware, Freeware, Commercial...) | Ignored |
| uid | The user identifier of the user who created the PAD File. | Ignored |
| user_name | The name of the user who created the PAD File. | Ignored |
| version | The version of the program. | Ignored |
| website | A link to the website of the owner (NOT THE PRODUCT WEBSITE). The name of the company (i.e. "company_name") is used as the label of the link. | Ignored |
| website_url | The URL to the owner website (NOT THE PRODUCT WEBSITE). This is not a link, just the URL. | Ignored |
| zip | The zip or postal code where the owner resides. | Ignored |