InfoLister templates syntax

Introduction

Since version 0.9, InfoLister supports plain-text templates in addition to previously supported XML+XSLT output mode. Learning InfoLister's template format is considerably easier than learning XSLT or CSS.

A template mostly consists of user markup, ignored by InfoLister. There are only four kinds of text processed by it:

• Metadata.

  You must provide the display name of your template and the content type of output document in the beginning of the template.

  Any InfoLister template looks like this: content/type;Display Name;(template contents), i.e. the content type, the display name and the text of your template separated with semicolons.

  • Content type defines the way the text produced by InfoLister is displayed in InfoLister's window. It doesn't affect the saved file in any way. For example, use text/plain for simple text documents, text/html for HTML and text/xml for XML.
  • Display name is is the string you see in InfoLister Options when selecting a template. Currently does not apply to custom templates.
  • Template text will be used by InfoLister when producing the output document. Its syntax is described below.

  A simple template used to generate just the User agent string would be: text/plain;Just a UA string;%useragent%

• Variables.

  Variables are strings that are replaced by their values by InfoLister. They have this syntax: %variable_name%, i.e. the name of variable enclosed in "%" signs. The list of available variables is available below.

• Lists.

  List templates are used to generate (guess what?) lists of your extensions, themes and plugins. Their syntax is as follows: {{list_name:(template, possibly including %variables%)}}.

  For example: {{extension:<li> %name% ver. %version%}}. Details in a separate section.

• Optional content.

  Optional content may be used to hide certain template text, if you tell InfoLister to exclude certain information from its output. The syntax is: [[(template with %variables% and lists)]].

  For example,[[User agent: %useragent%]] will not be generated, if you uncheck "user agent" in InfoLister's Options.

Variables

The following global variables are supported:

• %app% - the name of application being inspected, e.g. Firefox or Thunderbird.
• %lastupd% - the date and time when the information has been collected.
• %useragent% - the User agent string of the application.
• %extensions_count% - the total number of installed extensions. Will be zero if the extensions checkbox is not selected in InfoLister's Options.
• %disabled_extensions_count% - the number of disabled extensions.
• %enabled_extensions_count% - the number of enabled extensions.
• %themes_count% - the number of installed themes.
• %plugins_count% - the number of plugins.

Lists

The three list types supported are: extension, theme and plugin. Inside the list template, available variables are different from global variables. The following are supported (only %name% applies to plugins):

• %name% - the display name of an item.
• %version% - the version of an item.
• %homepageURL% - the home page of an item.
• %description% - the description of an item.
• %creator% - the author of the item.
• %id% - the ID of an item.
• %disabled-text% - set to (disabled) for disabled extensions, otherwise empty.
• %selected-text% - set to (selected) for the selected theme, otherwise empty.
• %xpiLink% - the URL to the XPI with the extension.
  Note: unlike the rest of properties, this one requires Internet access. The links are collected from extensions' update manifests, so this will not work for extensions that do not have a valid update manifest (that is, those that neither are hosted at addons.mozilla.org, nor include a valid updateURL property in their install manifest)

Examples

Four example templates are available (after you install InfoLister) at chrome://infolister/locale/templates/text.template, chrome://infolister/locale/templates/html.template, chrome://infolister/locale/templates/bbcode.template, and chrome://infolister/locale/templates/xpilist.template (copy and paste to the Location Bar; clicking won't work due to security restrictions)

Contact info

If you have any questions, corrections or suggestions, feel free to mail me to asqueella+infolister@gmail.com.