Baggage files info list
The baggage files info list allows you to specify additional baggage files and external URLs that you want to be included in the search index results and/or packaged with the output.
Note: Currently, creating baggage files in this way requires that the Create standalone group Target setting be Enabled.
Note: External URLs cannot be packaged with the help, however, they can be included as part of the search index. Furthermore, external URLs must enable the Create standalone group Target setting in order to be indexed.
If your baggage files or external URLs do not have adequate title and summary values defined, then you can also use the baggage files info list to provide these values. These values are used for displaying search results.
If you have external URL links or baggage files in your source content that you do not want included in the search index, then use the attribute @noindex.
When specifying the path for baggage files, you can either use an absolute path or a path relative to the baggage files info list file.
You can specify the location and filename of the baggage files info list using the Target Settings dialog (explained below). By default the filename is called: baggage_list.xml and is available to override in the Advanced > Manage Format/Target Customizations menu. In addition to renaming this file, you can also specify an absolute path or a relative path from the project file directory. Furthermore, you can use a variable for getting the directory location of the first document in the project. Using this variable called: $FirstDocDir;, you can locate the baggage files info list file in this directory. This is a useful way to use your stationary with multiple projects.
To use this variable you need to specify it first in the Target Setting value like this:
$FirstDocDir;/baggage_list.xml.
Note: If you change the path of the baggage files info list target setting, then even if you have overridden this file, the overridden file will be ignored and the file specified will be used instead. However, if you just change the base filename, then ePublisher will look for this file as if it were an override.
To get the path of the Baggage Files info list file we follow these steps
1. If you change the default value or just change the name (without specifying a path) Reverb tries to get the file from the Targets folder first and then from the Formats folder. The file will be located in the Transforms folder, so you can easily do an override of it if you want to keep the default name, otherwise you can add the new file there with the name you defined in the Target Settings.
2. If you define an Absolute or Relative path Reverb will calculate the relative path relative to the project file and will take the absolute path as is.
If you don’t specify a title and/or a summary for a baggage file we will try to do it for you.
In case of an HTML file for getting a title (if you didn’t define one in a baggage list file) we will search for:
1. A <title> tag defined in the <head> section of the HTML.
2. The base name without the extension of the HTML file.
In case of a PDF file for getting a title (if you didn’t define one in a baggage list file) we will get the base name without the extension of the PDF file.
In case of an HTML file for getting a summary (if you didn’t define one in a baggage list file) we will search for:
1. The attribute @content in the <meta> tag defined in the <head> section of the HTML with attribute @name=”summary”.
2. All the text inside the first tag, contained in the <body> tag, with attribute @class=”summary”.
3. The attribute @content in the <meta> tag defined in the <head> section of the HTML with attribute @name=”description”.
4. All the text inside the first <p> tag, contained in the <body> tag.
In case of a PDF file for getting a summary (if you didn’t define one in a baggage list file) we will get the first 300 letters from the content of the PDF file.
The attribute @noindex accepts 2 values: true|false, or you can even not define this attribute at all, and it will take the value false by default. If you define @noindex="true" it means Reverb won’t index that file.
The attribute @path is for specifying the path to the file (relative or absolute) or the external URL. It should be an existing path to an HTML page or PDF, either local or in the web.
Note: Any text you write in this file, if it contains a reserved character you’ll have to change it to use the entity corresponding. For example, instead of “&” use “&amp;”.
The following code will show you how to structure a baggage list file, as well as some examples for the entries:
<?xml version="1.0" encoding="UTF-8" ?>
<Files version="1.0" xmlns="urn:WebWorks-Baggage-List-Schema">
<File path="http://example.com/" noindex="true"/>
<File path="https://example.com/myfavoritepage" title="My favorite page" summary="Favorite pages can make your day better"/>
<File path="Source-Docs\some_pdf.pdf" title="Some PDF title" summary="Some PDF summary"/>
<File path="C:\Documents\another_pdf.pdf" title="Another PDF title" summary="Another PDF summary"/>
...
</Files>