%BOOK_ENTITIES; %DOCBOOK_ENTS; ]>

When you create the website structure, Publican places files in the /var/www/html/docs directory. Existing files in this directory might be overwritten by this procedure. Perform the following steps on your webserver. Log into the webserver. Install Publican and its web components package. For example, on a webserver with a Fedora operating system, run: $ sudo yum install publican publican-common-web With root privileges, edit the /etc/publican-website.cfg file to specify the name of the site, the web host, and optionally, search parameters, default language, dump file settings, and web style for the site: Specify the title with the title parameter, for example: title: "Foomaster Documentation" Normally, visitors to your website do not see this title because the site's JavaScript redirects them to a homepage. However, this title is likely to be found and indexed by search engines. Specify the web host with the host parameter as a full URL, including the protocol (for example, http://). For example: host: http://docs.example.com Publican uses the value set for host to construct the URLs in the XML Sitemap that it creates for search engine crawlers, and to limit searches submitted through the search box in the navigation menu to results on your site only. Optionally, construct a search engine query to use with the search box in the navigation menu and specify the entire content of a HTML <form> with the search parameter. If you do not specify a custom web search, Publican creates a Google search limited to the host that you specified in the host parameter. For example, to construct a Yahoo! search limited to docs.example.com, set: search: '<form target="_top" method="get" action="http://search.yahoo.com/search"> <div class="search"> <input type="text" name="p" value="" /> <input type="hidden" name="vs" value="docs.example.com" /> <input type="submit" value="###Search###" /> </div> </form>' Refer to the documentation of your chosen search engine for details of how to construct custom searches. If you set value="###Search###" in the code for a submit button, Publican uses the word Search on the button, localized into any language that Publican supports. Publican does not validate the search parameter, but builds the value of this parameter into the navigation menu exactly as you specify it. Be especially careful when you use this feature. Optionally, set the default language of the website. Publican creates a separate, translatable navigation menu for each language in which you publish documentation. However, if a document is not available in a particular language, Publican links visitors to the untranslated version of that document. To specify the default, untranslated language for the site, set def_lang with a language code. For example: def_lang: fr-FR With def_lang set to fr-FR, visitors viewing the navigation menu in (for example) Spanish are presented with a link to the original French version of the document if the document has not yet been translated into Spanish. Optionally, configure a dump file for the website. Publican can output an XML file that provides complete site content details for delivery of other services, such as web feeds or customised search pages. The file is updated whenever a book is installed or removed from the site, or the $ publican update_site command is run. Configure the dump, dump_file, and zip_dump parameters as follows: dump Set dump: 1 to enable the dump file function. This parameter defaults to 0 (off). dump_file Set dump_file: name to specify the name of the dump file and the directory in which Publican stores it. This parameter defaults to /var/www/html/DUMP.xml. zip_dump Set zip_dump: 1 to specify that Publican should create a zipped version of the XML file together with the XML version. This parameter defaults to 0 (off). Refer to for a description of the contents of the dump file. Optionally, specify the web style with the web_style. web_style: 1 The website resembles those produced by Publican 2, with a list of products displayed in a navigation pane at the left of the page. (Default) web_style: 2 The website includes a breadcrumb-like navigation bar across the top of the documentation. The web style set for your site must match the web style set for your content. For example, if you set web_style: 2 for your website, you need to have web_style: 2 set in each of the books that you want to install on the site. Consider setting this parameter in the defaults.cfg or overrides.cfg files of the brands that you intend to use with this site. Optionally, specify that the site tables of contents will be updated manually with the manual_toc_update parameter, for example: manual_toc_update: 1 Normally, Publican updates the site's tables of contents every time a documentation package is added or removed. On a site with a large number of documents on it (more than a few hundred), or where documents are updated very frequently (dozens of updates per week), this process is very demanding on a server. On a large or busy site, we recommend that you set this parameter and then periodically update the tables of contents with the $ publican update_site command. Optionally, override the default JavaScript for the site with the toc_js parameter, for example: toc_js: "mybrand/scripts/megafoo.js" This file will be symlinked as toc_path/toc.js with the $ publican update_site command. This path should be relative to the toc_path parameter. Create an empty file named site_overrides.css. If you want to use site-specific styles to override those provided by interactive.css, you can add a site_overrides.css to the document that provides the site home page — refer to . If you do not want to use site-specific styles, the empty file you add here will prevent 404 errors on your server. On a Linux system, run: # touch /var/www/html/docs/site_overrides.css To make Publican refresh the site structure at any time, run: $ publican update_site