1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
|
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE appendix [
]>
<appendix id="Configuration_summary" version="5.0" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<info>
<title>Configuration summary</title>
</info>
<section id="Auto_Docs_Configs-General_options">
<info>
<title>General options</title>
</info>
<para>
These are set in the books or brands configuration files.
</para>
<variablelist>
<varlistentry id="arch">
<term>arch</term>
<listitem>
<para>
Arch to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="audience">
<term>audience</term>
<listitem>
<para>
audience to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="books">
<term>books</term>
<listitem>
<para>
A space-separated list of books used in this remote set.
</para>
</listitem>
</varlistentry>
<varlistentry id="brand">
<term>brand</term>
<listitem>
<para>
The brand to use when building this package.
</para>
<para>
The default value for this parameter is: common
</para>
</listitem>
</varlistentry>
<varlistentry id="brew_dist">
<term>brew_dist</term>
<listitem>
<para>
The brew dist to use for building the standalone desktop rpm.
</para>
<para>
The default value for this parameter is: docs-5E
</para>
<warning>
<para>
This field is deprecated and will be removed from Publican in the future.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="bridgehead_in_toc">
<term>bridgehead_in_toc</term>
<listitem>
<para>
Display bridge head elements in the TOCs?
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="chunk_first">
<term>chunk_first</term>
<listitem>
<para>
For HTML, should the first section be on the same page as its parent?
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="chunk_section_depth">
<term>chunk_section_depth</term>
<listitem>
<para>
For HTML, what is the deepest level of nesting at which a section should be split onto its own page?
</para>
<para>
The default value for this parameter is: 4
</para>
</listitem>
</varlistentry>
<varlistentry id="classpath">
<term>classpath</term>
<listitem>
<para>
Path to jar files for FOP.
</para>
<para>
The default value for this parameter is: /usr/share/java/ant/ant-trax-1.7.0.jar:/usr/share/java/xmlgraphics-commons.jar:/usr/share/java/batik-all.jar:/usr/share/java/xml-commons-apis.jar:/usr/share/java/xml-commons-apis-ext.jar
</para>
</listitem>
</varlistentry>
<varlistentry id="common_config">
<term>common_config</term>
<listitem>
<para>
Path to publican content.
</para>
<para>
The default value for this parameter is: /usr/share/publican
</para>
</listitem>
</varlistentry>
<varlistentry id="common_content">
<term>common_content</term>
<listitem>
<para>
Path to publican common content.
</para>
<para>
The default value for this parameter is: /usr/share/publican/Common_Content
</para>
</listitem>
</varlistentry>
<varlistentry id="condition">
<term>condition</term>
<listitem>
<para>
Conditions on which to prune XML before transformation.
</para>
</listitem>
</varlistentry>
<varlistentry id="confidential">
<term>confidential</term>
<listitem>
<para>
Is the content confidential?
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="confidential_text">
<term>confidential_text</term>
<listitem>
<para>
The text used to indicate content is confidential.
</para>
<para>
The default value for this parameter is: CONFIDENTIAL
</para>
</listitem>
</varlistentry>
<varlistentry id="conformance">
<term>conformance</term>
<listitem>
<para>
conformance to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="debug">
<term>debug</term>
<listitem>
<para>
Print out extra messages?
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="doc_url">
<term>doc_url</term>
<listitem>
<para>
URL for the documentation team for this package. Used for top right URL on HTML.
</para>
<para>
The default value for this parameter is: https://fedorahosted.org/publican
</para>
</listitem>
</varlistentry>
<varlistentry id="docname">
<term>docname</term>
<listitem>
<para>
Name of this document. Fetched from title tag in xml_lang/TYPE_Info.xml if not set in cfg file.
</para>
<para>
This parameter is constrained with the following regular expression: ^[0-9a-zA-Z_\-\.\+]+$
</para>
<tip>
<para>
This field is not supported for: brand.
</para>
</tip>
</listitem>
</varlistentry>
<varlistentry id="drupal_author">
<term>drupal_author</term>
<listitem>
<para>
The author name to be shown in drupal book page. It must be a valid drupal username.
</para>
<para>
The default value for this parameter is: Publican
</para>
</listitem>
</varlistentry>
<varlistentry id="drupal_image_path">
<term>drupal_image_path</term>
<listitem>
<para>
The directory where the image should be stored in drupal server.
</para>
<para>
The default value for this parameter is: /sites/default/files/documentation/
</para>
</listitem>
</varlistentry>
<varlistentry id="drupal_menu_block">
<term>drupal_menu_block</term>
<listitem>
<para>
The menu where we can find the book.
</para>
<para>
The default value for this parameter is: user-guide
</para>
</listitem>
</varlistentry>
<varlistentry id="drupal_menu_title">
<term>drupal_menu_title</term>
<listitem>
<para>
Override the bookname that will be shown in the drupal menu.
</para>
</listitem>
</varlistentry>
<varlistentry id="dt_format">
<term>dt_format</term>
<listitem>
<para>
The format to use for the desktop output.
</para>
<para>
The default value for this parameter is: html-desktop
</para>
</listitem>
</varlistentry>
<varlistentry id="dt_obsoletes">
<term>dt_obsoletes</term>
<listitem>
<para>
Space-separated list of packages the desktop RPM obsoletes.
</para>
</listitem>
</varlistentry>
<varlistentry id="dt_requires">
<term>dt_requires</term>
<listitem>
<para>
Space-separated list of packages the desktop RPM requires.
</para>
</listitem>
</varlistentry>
<varlistentry id="dtdver">
<term>dtdver</term>
<listitem>
<para>
Version of the DocBook DTD on which this project is based.
</para>
<para>
The default value for this parameter is: 4.5
</para>
</listitem>
</varlistentry>
<varlistentry id="ec_id">
<term>ec_id</term>
<listitem>
<para>
Eclipse plugin ID. Defaults to "$product.$docname"
</para>
</listitem>
</varlistentry>
<varlistentry id="ec_name">
<term>ec_name</term>
<listitem>
<para>
Eclipse plugin name. Defaults to "$product $docname"
</para>
</listitem>
</varlistentry>
<varlistentry id="ec_provider">
<term>ec_provider</term>
<listitem>
<para>
Eclipse plugin provider. Defaults to "Publican-v4.2.2"
</para>
</listitem>
</varlistentry>
<varlistentry id="extras_dir">
<term>extras_dir</term>
<listitem>
<para>
Directory where images are located.
</para>
<para>
The default value for this parameter is: extras
</para>
</listitem>
</varlistentry>
<varlistentry id="generate_section_toc_level">
<term>generate_section_toc_level</term>
<listitem>
<para>
Generate table of contents down to the given section depth.
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="ignored_translations">
<term>ignored_translations</term>
<listitem>
<para>
Languages to replace with xml_lang regardless of translation status.
</para>
</listitem>
</varlistentry>
<varlistentry id="img_dir">
<term>img_dir</term>
<listitem>
<para>
Directory where images are located.
</para>
<para>
The default value for this parameter is: images
</para>
</listitem>
</varlistentry>
<varlistentry id="info_file">
<term>info_file</term>
<listitem>
<para>
Override the default Info file.
</para>
</listitem>
</varlistentry>
<varlistentry id="lang">
<term>lang</term>
<listitem>
<para>
lang to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="license">
<term>license</term>
<listitem>
<para>
License this package uses.
</para>
<para>
The default value for this parameter is: GFDL
</para>
</listitem>
</varlistentry>
<varlistentry id="mainfile">
<term>mainfile</term>
<listitem>
<para>
The name of the main xml and ent files for this book, sans file extension and language. Fetched from docname if not set.
</para>
</listitem>
</varlistentry>
<varlistentry id="menu_category">
<term>menu_category</term>
<listitem>
<para>
Semicolon-separated list of menu categories for the desktop package.
</para>
</listitem>
</varlistentry>
<varlistentry id="os">
<term>os</term>
<listitem>
<para>
os to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="os_ver">
<term>os_ver</term>
<listitem>
<para>
The OS for which to build packages.
</para>
</listitem>
</varlistentry>
<varlistentry id="pdf_body_font">
<term>pdf_body_font</term>
<listitem>
<para>
The font to use for body text in PDFs.
</para>
<para>
The default value for this parameter is: Liberation Sans
</para>
</listitem>
</varlistentry>
<varlistentry id="pdf_mono_font">
<term>pdf_mono_font</term>
<listitem>
<para>
The font to use for mono text in PDFs.
</para>
<para>
The default value for this parameter is: Liberation Mono
</para>
</listitem>
</varlistentry>
<varlistentry id="prod_url">
<term>prod_url</term>
<listitem>
<para>
URL for the product. Used in top left URL in HTML.
</para>
<para>
The default value for this parameter is: https://fedorahosted.org/publican
</para>
</listitem>
</varlistentry>
<varlistentry id="product">
<term>product</term>
<listitem>
<para>
Product this package covers. Fetched from productname tag in xml_lang/TYPE_Info.xml
</para>
<para>
This parameter is constrained with the following regular expression: ^[0-9a-zA-Z_\-\.\+]+$
</para>
<tip>
<para>
This field is not supported for: brand.
</para>
</tip>
</listitem>
</varlistentry>
<varlistentry id="repo">
<term>repo</term>
<listitem>
<para>
Repository from which to fetch remote set books.
</para>
</listitem>
</varlistentry>
<varlistentry id="rev_dir">
<term>rev_dir</term>
<listitem>
<para>
By default Revision History is sorted in descending order. Set this to 'asc' or 'ascending' to reverse the sort.
</para>
</listitem>
</varlistentry>
<varlistentry id="rev_file">
<term>rev_file</term>
<listitem>
<para>
Override the default Revision History file.
</para>
</listitem>
</varlistentry>
<varlistentry id="revision">
<term>revision</term>
<listitem>
<para>
revision to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="revisionflag">
<term>revisionflag</term>
<listitem>
<para>
revisionflag to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="role">
<term>role</term>
<listitem>
<para>
role to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="scm">
<term>scm</term>
<listitem>
<para>
Type of repository in which books that form part of a remote set are stored. Supported types: SVN, GIT.
</para>
</listitem>
</varlistentry>
<varlistentry id="security">
<term>security</term>
<listitem>
<para>
security to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="show_remarks">
<term>show_remarks</term>
<listitem>
<para>
Display remarks in transformed output.
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="sort_order">
<term>sort_order</term>
<listitem>
<para>
Override the default sort weighting. Defaults to 50.
</para>
</listitem>
</varlistentry>
<varlistentry id="src_url">
<term>src_url</term>
<listitem>
<para>
URL to find tar of source files. Used in RPM Spec files.
</para>
</listitem>
</varlistentry>
<varlistentry id="status">
<term>status</term>
<listitem>
<para>
status to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="tmp_dir">
<term>tmp_dir</term>
<listitem>
<para>
Directory to use for building.
</para>
<para>
The default value for this parameter is: tmp
</para>
</listitem>
</varlistentry>
<varlistentry id="toc_section_depth">
<term>toc_section_depth</term>
<listitem>
<para>
Depth of sections to include in the main table of contents.
</para>
<para>
The default value for this parameter is: 2
</para>
</listitem>
</varlistentry>
<varlistentry id="txt_formater">
<term>txt_formater</term>
<listitem>
<para>
Choose the formatter to use when creating txt output.
</para>
<para>
The default value for this parameter is: default
</para>
<para>
This parameter is constrained with the following regular expression: ^(links{1}|tables{1}|default)$
</para>
</listitem>
</varlistentry>
<varlistentry id="type">
<term>type</term>
<listitem>
<para>
Type of content this package contains. Supported: set, book, article, brand
</para>
<para>
The default value for this parameter is: Book
</para>
</listitem>
</varlistentry>
<varlistentry id="userlevel">
<term>userlevel</term>
<listitem>
<para>
userlevel to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="vendor">
<term>vendor</term>
<listitem>
<para>
vendor to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="version">
<term>version</term>
<listitem>
<para>
Version of this package. Fetched from productnumber tag in xml_lang/TYPE_Info.xml
</para>
<para>
This parameter is constrained with the following regular expression: ^[0-9][^\p{IsSpace}]*$
</para>
</listitem>
</varlistentry>
<varlistentry id="web_brew_dist">
<term>web_brew_dist</term>
<listitem>
<para>
The brew dist to use for building the web rpm.
</para>
<para>
The default value for this parameter is: docs-5E
</para>
</listitem>
</varlistentry>
<varlistentry id="web_formats">
<term>web_formats</term>
<listitem>
<para>
A comma-separated list of the formats to use for the web packages.
</para>
<para>
The default value for this parameter is: html,html-single,pdf,epub
</para>
</listitem>
</varlistentry>
<varlistentry id="web_home">
<term>web_home</term>
<listitem>
<para>
This is a home page for a Publican-generated website, not a standard book.
</para>
<warning>
<para>
web_home is deprecated and will be removed from Publican in the future. Use "web_type: home" instead.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="web_host">
<term>web_host</term>
<listitem>
<para>
This is a host name for a Publican-generated website, used for searches and the Sitemap. Be sure to include the full path to your document tree. E.g. if your documents are in the docs directory: http://www.example.com/docs
</para>
<warning>
<para>
web_host is deprecated and will be removed from Publican in the future. Use "host" in the web site configuration file instead.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="web_name_label">
<term>web_name_label</term>
<listitem>
<para>
Override the book name, bottom level, menu label on a Publican website.
</para>
</listitem>
</varlistentry>
<varlistentry id="web_obsoletes">
<term>web_obsoletes</term>
<listitem>
<para>
Packages to obsolete in web RPM.
</para>
</listitem>
</varlistentry>
<varlistentry id="web_product_label">
<term>web_product_label</term>
<listitem>
<para>
Override the product, top level, menu label on a Publican website.
</para>
</listitem>
</varlistentry>
<varlistentry id="web_search">
<term>web_search</term>
<listitem>
<para>
Override the default search form for a Publican website. By default this will use Google search and do a site search if web_host is set.
</para>
<warning>
<para>
web_search is deprecated and will be removed from Publican in the future. Use "search" in the web site configuration file instead.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="web_type">
<term>web_type</term>
<listitem>
<para>
This is a special page for a Publican-generated website, not a standard book. Valid types are home, product, and version.
</para>
<para>
This parameter is constrained with the following regular expression: ^(home|product|version)$
</para>
</listitem>
</varlistentry>
<varlistentry id="web_version_label">
<term>web_version_label</term>
<listitem>
<para>
Override the version, middle level, menu label on a Publican website. To hide this menu item set this to: UNUSED
</para>
</listitem>
</varlistentry>
<varlistentry id="wkhtmltopdf_opts">
<term>wkhtmltopdf_opts</term>
<listitem>
<para>
Extra options to pass to wkhtmltopdf. e.g. wkhtmltopdf_opts: "-O landscape -s A3"
</para>
</listitem>
</varlistentry>
<varlistentry id="wordsize">
<term>wordsize</term>
<listitem>
<para>
wordsize to filter output on.
</para>
</listitem>
</varlistentry>
<varlistentry id="xml_lang">
<term>xml_lang</term>
<listitem>
<para>
Language in which XML is authored.
</para>
<para>
The default value for this parameter is: en-US
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="Auto_Docs_Configs-Brand_options">
<info>
<title>Brand options</title>
</info>
<para>
These are set in the brands configuration files.
</para>
<variablelist>
<varlistentry id="banned_attrs">
<term>banned_attrs</term>
<listitem>
<para>
A comma-separated list of XML attributes that are not permitted in the source.
</para>
</listitem>
</varlistentry>
<varlistentry id="banned_tags">
<term>banned_tags</term>
<listitem>
<para>
A comma-separated list of XML tags that are not permitted in the source.
</para>
</listitem>
</varlistentry>
<varlistentry id="base_brand">
<term>base_brand</term>
<listitem>
<para>
The base brand to use for this brand.
</para>
<para>
The default value for this parameter is: common
</para>
</listitem>
</varlistentry>
<varlistentry id="dtd_type">
<term>dtd_type</term>
<listitem>
<para>
Override Type for DocType. Must be a complete string.
</para>
</listitem>
</varlistentry>
<varlistentry id="dtd_uri">
<term>dtd_uri</term>
<listitem>
<para>
Override URI for DocType. Must be a complete string.
</para>
</listitem>
</varlistentry>
<varlistentry id="no_embedtoc">
<term>no_embedtoc</term>
<listitem>
<para>
Brand option to disable embedding the navigational toc in web packages
</para>
</listitem>
</varlistentry>
<varlistentry id="web_cfg">
<term>web_cfg</term>
<listitem>
<para>
Full path for the publican site configuration file for non standard RPM websites.
</para>
</listitem>
</varlistentry>
<varlistentry id="web_dir">
<term>web_dir</term>
<listitem>
<para>
Install path for non standard RPM websites.
</para>
</listitem>
</varlistentry>
<varlistentry id="web_req">
<term>web_req</term>
<listitem>
<para>
Name of site package for non standard RPM websites. Required to ensure the site is installed.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="Auto_Docs_Configs-Site_option">
<info>
<title>Site options</title>
</info>
<para>
These are set in the sites configuration file.
</para>
<variablelist>
<varlistentry id="site_db_file">
<term>db_file</term>
<listitem>
<para>
The name of the SQLite database file for your site, with the filename extension .db
</para>
</listitem>
</varlistentry>
<varlistentry id="site_debug">
<term>debug</term>
<listitem>
<para>
Output extra messages when running publican.
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="site_def_lang">
<term>def_lang</term>
<listitem>
<para>
The default language for this website. Tables of contents for languages other than the default language will link to documents in the default language when translations are not available.
</para>
<para>
The default value for this parameter is: en-US
</para>
</listitem>
</varlistentry>
<varlistentry id="site_dump">
<term>dump</term>
<listitem>
<para>
Dump the publican database to an XML file.
</para>
</listitem>
</varlistentry>
<varlistentry id="site_dump_file">
<term>dump_file</term>
<listitem>
<para>
The name of the file to dump the publican database to.
</para>
<para>
The default value for this parameter is: /var/www/html/DUMP.xml
</para>
</listitem>
</varlistentry>
<varlistentry id="site_footer">
<term>footer</term>
<listitem>
<para>
HTML to inject in to the footer of every page on the website.
</para>
<para>
The default value for this parameter is:
</para>
</listitem>
</varlistentry>
<varlistentry id="site_host">
<term>host</term>
<listitem>
<para>
The web host, may be a full URI or a relative path.
</para>
<para>
The default value for this parameter is: /docs
</para>
</listitem>
</varlistentry>
<varlistentry id="site_manual_toc_update">
<term>manual_toc_update</term>
<listitem>
<para>
Stop publican from automatically rebuilding teh web site everytime a book is installed, updated or removed.
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
<varlistentry id="site_search">
<term>search</term>
<listitem>
<para>
The HTML to inject in as the site serach.
</para>
<para>
The default value for this parameter is: Google site search
</para>
</listitem>
</varlistentry>
<varlistentry id="site_title">
<term>title</term>
<listitem>
<para>
Title used for all site navigation pages.
</para>
<para>
The default value for this parameter is: Documentation
</para>
</listitem>
</varlistentry>
<varlistentry id="site_tmpl_path">
<term>tmpl_path</term>
<listitem>
<para>
Full path to the template directory.
</para>
<para>
The default value for this parameter is: /usr/share/publican/templates
</para>
</listitem>
</varlistentry>
<varlistentry id="site_toc_js">
<term>toc_js</term>
<listitem>
<para>
The source file to use for JavaScript functionality.
</para>
<para>
The default value for this parameter is: default.js
</para>
</listitem>
</varlistentry>
<varlistentry id="site_toc_path">
<term>toc_path</term>
<listitem>
<para>
The path to the directory in which to create the top-level index.html file.
</para>
</listitem>
</varlistentry>
<varlistentry id="site_toc_type">
<term>toc_type</term>
<listitem>
<para>
Template to use for generagting the web style 1 toc file.
</para>
<para>
The default value for this parameter is: toc
</para>
<warning>
<para>
This field is deprecated and will be removed from Publican in the future.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="site_web_style">
<term>web_style</term>
<listitem>
<para>
Publican supports mutliple base styles for websites, this picks one.
</para>
<para>
The default value for this parameter is: 1
</para>
<para>
This parameter is constrained with the following regular expression: [1-2]
</para>
<warning>
<para>
This field is deprecated and will be removed from Publican in the future.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry id="site_zip_dump">
<term>zip_dump</term>
<listitem>
<para>
Zip up the dump file after dumping it
</para>
<para>
The default value for this parameter is: 0
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</appendix>
|