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
|
<?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="210" version="5.0" xml:id="sect-Publican-Users_Guide-Renaming_a_document" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<info>
<title>Renaming a document</title>
</info>
<para>
The <prompt>$</prompt> <command>publican rename</command> command makes it easy for you to rename a document to give it a new title, or to change the name or version of the product to which the document applies. The command accepts up to three options:
</para>
<variablelist>
<varlistentry>
<term><option>--name</option> <replaceable>new_title</replaceable></term>
<listitem>
<para>
changes the title of the document. For example, to rename a document from <citetitle>Server Configuration Guide</citetitle> to <citetitle>Server Deployment Guide</citetitle>, change into the document's root directory and run:
</para>
<screen><prompt>$</prompt> <command>publican rename --name "Server Deployment Guide"</command></screen>
<para>
Specifically, the command changes the content of the <tag><title></tag> tag in the <filename>Article_Info.xml</filename>, <filename>Book_Info.xml</filename>, or <filename>Set_Info.xml</filename> file, and sets a value for the <parameter>mainfile</parameter> parameter in the <filename>publican.cfg</filename> file so that <application>Publican</application> can still find the root XML node and the entities for the document.
</para>
<para>
Note that the <prompt>$</prompt> <command>publican rename</command> command does not change any file names. Therefore, the root XML node and the document entities are still located in files named after the original title of the document — <filename>Server_Configuration_Guide</filename> in the previous example.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--product</option> <replaceable>new_product</replaceable></term>
<listitem>
<para>
changes the name of the product to which the document applies. For example, if the product was previously named <productname>ForceRivet</productname> but is now called <productname>PendantFarm</productname>, change into the document's root directory and run:
</para>
<screen><prompt>$</prompt> <command>publican rename --product PendantFarm</command></screen>
<para>
The command changes the content of the <tag><productname></tag> tag in the <filename>Article_Info.xml</filename>, <filename>Book_Info.xml</filename>, or <filename>Set_Info.xml</filename> file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--version</option> <replaceable>new_version</replaceable></term>
<listitem>
<para>
changes the product version to which the document applies. For example, if the product version was previously <productnumber>1.0</productnumber>
but is now <productnumber>2.0</productnumber>
, change into the document's root directory and run:
</para>
<screen><prompt>$</prompt> <command>publican rename --version 2.0</command></screen>
<para>
The command changes the content of the <tag><productnumber></tag> tag in the <filename>Article_Info.xml</filename>, <filename>Book_Info.xml</filename>, or <filename>Set_Info.xml</filename> file.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
You can combine any combination of these options into a single command. For example:
</para>
<screen><prompt>$</prompt> <command>publican rename --name "Server Deployment Guide" --product PendantFarm --version 2.0</command></screen>
</section>
|
