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
|
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section [
<!ENTITY % BOOK_ENTITIES SYSTEM "Users_Guide.ent">
%BOOK_ENTITIES;
<!ENTITY % sgml.features "IGNORE">
<!ENTITY % xml.features "INCLUDE">
<!ENTITY % DOCBOOK_ENTS PUBLIC "-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" "/usr/share/xml/docbook/schema/dtd/4.5/dbcentx.mod">
%DOCBOOK_ENTS;
]>
<section conformance="188" version="5.0" xml:id="sect-Publican-Users_Guide-Installing_a_brand" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<info>
<title>Installing a brand</title>
</info>
<para>
<application>Publican</application> brands for Fedora, Genome, and oVirt documents are available as RPM packages in Fedora. Similarly, Red Hat internally distributes RPM packages containing <application>Publican</application> brands for GIMP, JBoss, and Red Hat documents. Providing that you have access to the relevant repositories, you can install these brands on a computer that runs Red Hat Enterprise Linux or Fedora — or an operating system derived from either — with the command <command>yum install publican-<replaceable>brand</replaceable></command> or with a graphical package manager such as <application>PackageKit</application>.
</para>
<para>
If you use <application>Publican</application> on an operating system that does not use RPM packages, your documentation project might provide its brand in another format. Whatever the format in which the brand is supplied, you must place the brand files in a subdirectory of the <application>Publican</application> <filename>Common_Content</filename> directory. By default, this directory is located at <filename>/usr/share/publican/Common_Content</filename> on Linux operating systems and at <filename>%SystemDrive%/%ProgramFiles%/Publican/Common_Content</filename> on Windows operating systems — typically, <filename>C:/Program Files/Publican/Common_Content</filename>
</para>
<para>
Each currently available brand is distributed under a brand-specific license as follows:
</para>
<para>
To install the brand:
</para>
<procedure>
<step>
<para>
If the brand was supplied to you in an archive of some kind, for example, a tarball or ZIP file, unpack the brand into a new directory on your system.
</para>
</step>
<step>
<para>
Change into the directory in which you created or unpacked the brand:
</para>
<screen><prompt>$</prompt> <command>cd publican-<replaceable>brand</replaceable></command></screen>
<para>
where <replaceable>brand</replaceable> is the name of the brand.
</para>
</step>
<step>
<para>
Build the brand:
</para>
<screen><prompt>$</prompt> <command>publican build --formats xml --langs all --publish</command></screen>
</step>
<step>
<para>
Install the brand:
</para>
<screen><prompt>$</prompt> <command>sudo publican install_brand --path <replaceable>path</replaceable></command></screen>
<para>
where <replaceable>path</replaceable> is the path to the <application>Publican</application> Common Content files. For example, on a Linux system, run:
</para>
<screen><prompt>$</prompt> <command>sudo publican install_brand --path /usr/share/publican/Common_Content</command></screen>
<para>
or on a Windows system, run
</para>
<screen><prompt>$</prompt> <command>publican install_brand --path "C:/Program Files/Publican/Common_Content"</command></screen>
</step>
</procedure>
<table conformance="189" xml:id="tabl-Publican-Users_Guide-Installing_a_brand-Current_Brands_and_their_packages">
<info>
<title>Current Brands and their packages</title>
</info>
<tgroup cols="5">
<colspec colnum="1" colwidth="1*"></colspec>
<colspec colnum="2" colwidth="2*"></colspec>
<colspec colnum="3" colwidth="2*"></colspec>
<colspec colnum="4" colwidth="2*"></colspec>
<colspec colnum="5" colwidth="2*"></colspec>
<thead>
<row>
<entry> Brand </entry>
<entry> License of Common Content files </entry>
<entry> Default license for documents </entry>
<entry> Package </entry>
<entry> Comment </entry>
</row>
</thead>
<tbody>
<row>
<entry> common </entry>
<entry> <link xlink:href="http://creativecommons.org/publicdomain/zero/1.0/" xmlns:xlink="http://www.w3.org/1999/xlink">CC0 1.0</link> </entry>
<entry> <link xlink:href="http://www.gnu.org/licenses/fdl.html" xmlns:xlink="http://www.w3.org/1999/xlink">GFDL Version 1.2</link> </entry>
<entry> publican </entry>
<entry> GPL compatible license. No options. </entry>
</row>
<row>
<entry> RedHat </entry>
<entry> <link xlink:href="http://creativecommons.org/licenses/by-sa/3.0/" xmlns:xlink="http://www.w3.org/1999/xlink">CC-BY-SA 3.0</link> </entry>
<entry> <phrase>CC-BY-SA 3.0</phrase> </entry>
<entry> publican-redhat </entry>
<entry> </entry>
</row>
<row>
<entry> Fedora </entry>
<entry> <phrase>CC-BY-SA 3.0</phrase> </entry>
<entry> <phrase>CC-BY-SA 3.0</phrase> </entry>
<entry> publican-fedora </entry>
<entry> </entry>
</row>
<row>
<entry> JBoss </entry>
<entry> <phrase>CC-BY-SA 3.0</phrase> </entry>
<entry> <phrase>CC-BY-SA 3.0</phrase> </entry>
<entry> publican-jboss </entry>
<entry> No Options. </entry>
</row>
<row>
<entry> oVirt </entry>
<entry> <link xlink:href="http://www.opencontent.org/openpub/" xmlns:xlink="http://www.w3.org/1999/xlink">OPL 1.0</link> </entry>
<entry> <phrase>OPL 1.0</phrase> </entry>
<entry> publican-ovirt </entry>
<entry> No Options. </entry>
</row>
<row>
<entry> GIMP </entry>
<entry> <link xlink:href="http://www.gnu.org/licenses/fdl.html" xmlns:xlink="http://www.w3.org/1999/xlink">GFDL Version 1.2</link> </entry>
<entry> <phrase>GFDL Version 1.2</phrase> </entry>
<entry> publican-gimp </entry>
<entry> Matches the license for existing GIMP documentation. </entry>
</row>
<row>
<entry> Genome </entry>
<entry> <phrase>OPL 1.0</phrase> </entry>
<entry> <phrase>OPL 1.0</phrase> </entry>
<entry> publican-genome </entry>
<entry> No Options. </entry>
</row>
</tbody>
</tgroup>
</table>
<para>
Note the difference in licensing between the common content files provided in the common brand (CC0) and the default license set for books generated with the common brand (GFDL). The CC0 license allows you to redistribute and relicense the files that make up the common brand (including the CSS and image files) to suit your project. <application>Publican</application> suggests the GFDL for documentation by default because <application>Publican</application> is developed primarily to build documentation for software. The GFDL is compatible with the GPL, which is the most commonly used license for open-source software.
</para>
</section>
|
