File: Publican_Defaults.xml

package info (click to toggle)
publican 4.3.2-5
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 18,364 kB
  • sloc: javascript: 17,390; perl: 13,081; xml: 11,558; makefile: 167; python: 29; sh: 29
file content (105 lines) | stat: -rw-r--r-- 3,229 bytes parent folder | download | duplicates (4)
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
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE chapter [
<!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;
]>
<chapter conformance="207" version="5.0" xml:id="chap-Publican-Users_Guide-Publican_defaults" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
	<info>
		<title>Publican defaults</title>

	</info>
	 <para>
		Users can set their own default values for <application>Publican</application> in <filename>~/.publican.cfg</filename>. Currently, <application>Publican</application> supports the following values:
	</para>
	 <itemizedlist>
		<listitem>
			<para>
				firstname
			</para>

		</listitem>
		 <listitem>
			<para>
				surname
			</para>

		</listitem>
		 <listitem>
			<para>
				email
			</para>

		</listitem>
		 <listitem>
			<para>
				formats
			</para>

		</listitem>
		 <listitem>
			<para>
				lang
			</para>

		</listitem>
		 <listitem>
			<para>
				langs
			</para>

		</listitem>

	</itemizedlist>
	 <note>
		<para>
			This file is completely different to <filename>publican.cfg</filename> that is used to build a book. It does not accept the same parameters.
		</para>

	</note>
	 <section conformance="208" xml:id="sect-Publican-Users_Guide-Publican_defaults-Publican_default_examples">
		<info>
			<title>Publican default examples</title>

		</info>
		 <para>
			Users can set <replaceable>formats</replaceable>, <replaceable>lang</replaceable>, and <replaceable>langs</replaceable> to their standard build parameters.
		</para>
		 <example conformance="251" xml:id="exam-Publican-Users_Guide-Publican_default_examples-Setting_formats_and_lang">
			<info>
				<title>Setting formats and lang</title>

			</info>
			 
<screen><prompt>$</prompt> <command>echo 'formats: "html,html-single,pdf,txt"' &gt;&gt; ~/.publican.cfg</command>
<prompt>$</prompt> <command>echo 'langs: "en-US"' &gt;&gt; ~/.publican.cfg</command>
<prompt>$</prompt> <command>publican build</command>
<computeroutput>Setting up en-US</computeroutput>
<computeroutput>[...]</computeroutput>
<computeroutput> Finished txt</computeroutput></screen>

		</example>
		 <para>
			<application>Publican</application> 3.0 allows you to add a revision history entry from the command line. You can set your user details in <filename>~/.publican.cfg</filename>.
		</para>
		 <example conformance="252" xml:id="exam-Publican-Users_Guide-Publican_default_examples-Setting_user_details">
			<info>
				<title>Setting user details</title>

			</info>
			 
<screen><prompt>$</prompt> <command>echo 'firstname: "Dude"' &gt;&gt; ~/.publican.cfg</command> 
<prompt>$</prompt> <command>echo 'surname: "McPants"' &gt;&gt; ~/.publican.cfg</command> 
<prompt>$</prompt> <command>echo 'email: "dude.mcpants@awesome.com"' &gt;&gt; ~/.publican.cfg</command> 
<prompt>$</prompt> <command>publican add_revision --member "Updated examples in chapter 2." \</command>
<command>--member "Removed obsolete example in sect 4.1"</command></screen>

		</example>

	</section>

</chapter>