Subversion Repositories Scribus

Rev

Rev 13527 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
10646 cbradney 1
<html>
2
<head>
3
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
1243 subik 4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
10646 cbradney 5
                <title>Short Words for Scribus</title>
6
</head>
7
<body>
8
<head>
9
<body>
1243 subik 10
 
11
<h1>Short Words for Scribus</h1>
12
 
13
<p>Copyright © 2004 Petr Van&#283;k, Maciej Hanski</p>
14
<p>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".</p>
15
 
16
<h2>What is Short Words meant for</h2>
17
<p>Short Words for Scribus is a special plug-in for adding non-breaking spaces before or after so called short words.</p>
18
<p>These short words are specific to every national typography,  e.g. according to Czech, Polish, and Slovak typographical standards it is not allowed to leave one letter conjunctions at line ends, if the line contains more than 25 signs. A common issue are measure and weight units, where for obvious reasons non-breaking spaces should be put in-between the preceding numbers and the units. Last but not least, there are plenty of abbreviated academic degrees, military ranks etc, which should not be separated from their owners.</p>
19
<p>Although Scribus team cannot individually address every one of these national standards, one of the Scribus core team developers, Petr Van&#283;k, decided to provide Scribus users with a plug-in, that can be easily customized to meet their specific needs.</p>
20
 
21
<h2>How it works</h2>
22
<p>The screen shot below shows a sample text containing a short word before applying non-breaking spaces.</p>
23
<p><b>Text sample before executing Short Words</b></p>
24
<img src="before_short_words.png" alt="Text sample before executing Short Words" />
25
<p>The same text after applying non-breaking spaces. The red encircled word Mr jumped to the next line, because the normal space between Mr and Justice has been replaced by a non-breaking space.</p>
26
<p><b>Text sample after executing Short Words</b></p>
27
<img src="after_short_words.png" alt="Text sample after executing Short Words" />
28
 
29
<h2>How to execute Short Words</h2>
30
<p>If you successfully installed the plug-in, go to the <code>Extras</code> menu and choose the <code>Short Words...</code> option:</p>
31
<p><b>Calling Short Words for Scribus</b></p>
32
<img src="menu.png" alt="Calling Short Words for Scribus" />
33
<p><b>Short Words dialog window</b></p>
34
<img src="dialog.png" alt="Short Words dialog window" />
35
 
36
<dl>
37
<dt>Selected frames</dt>
38
        <dd><p>Apply non-breaking spaces to selected text frames.</p></dd>
39
<dt>Active page</dt>
40
        <dd><p>Apply non-breaking spaces to all frames of the current page.</p></dd>
41
<dt><p>All items</p></dt>
42
        <dd><p>Apply non-breaking spaces to the <em>whole document</em>.</p></dd>
43
<dt>Replace defaults by user config</dt>
44
        <dd><p>When the user config file exists you can choose if you want to append your config to the global configuration by unchecked button. You can replace predefined values by yours with checked button too.</p></dd>
45
</dl>
46
 
47
<h2>Installation</h2>
48
<p>The easiest way of installing the plug-in is to check on the Scribus site (http://www.scribus.net), if there are installation packages available for your favourite distribution, e.g. Fedora, SuSE, Gentoo, Mandrake, or PLD.</p>
49
<p>Should there be no suitable package for you, try to build the plug-in from source, which in most cases is the matter of the following three statements:</p>
50
<pre>
51
#./configure
52
# make
53
# make install
54
</pre>
55
<p>You can specify <code>./configure --prefix=/path/to/scribus/previously/installed</code>. The default prefix is <code>/usr/local</code> which is the default target when you've installed Scribus from source. On my Gentoo, I  use <code>./configure --prefix=/usr</code> to fit my ebuild.</p>
56
<p>If you fail to build the plug-in, check first, if you have all the required libraries</a>.</p>
57
 
58
<h2>Configuration</h2>
59
<p>Short Words for Scribus provides a system wide configuration file <code>scribus-short-words.rc</code>, which is usually located in the <code>/usr/local/lib/scribus/plugins</code> directory (the actual directory depends on where you or your distribution installed Scribus). This configuration file is self explanatory, basically it contains a list of short words for a given language, preceded or followed by a space and separated by commas. The position of the space, before or after a short word, indicates to the plug-in, where the non-breaking space should be put. Every line with configuration settings has to start with the language it is meant for, e.g. en for English or cs for Czech:
60
</p>
61
<pre>
62
#  English stuff START here
63
en=Dr. ,Dr ,Mr. ,Mr ,Mrs. ,Mrs ,Ms. ,Ms ,Prof. ,Prof ,Rev. ,Rev ,
64
en= Kg, kg, g, mg, oz, lb, cwt, km, Km, m, cm, mm,
65
 
66
#  Czech short words START here
67
## hanging conjunctions
68
cs=K ,k ,S ,s ,V ,v ,Z ,z ,O ,o ,U ,u ,I ,i ,A ,
69
## physics and math
70
cs= kg, g, m, cm, mm, l, hl, s, %,
71
</pre>
72
<p>If you want to use self defined short words, e.g. for a new language, create your own configuration file with your own short words, and save the file as <code>scribus-short-words.rc</code> in the <code>~/.scribus</code> directory. <em>You can choose the plugin appends your configuration into the system one or just to replace and use it only itself.</em></p>
73
 
74
<h3 class="title">Important</h3>
75
<p>The author is eager to extend the global configuration file to meet your needs, let him know about the short words and standards specific to your language.</p>
76
 
77
<h2 class="title">Short Words Copyright</h2>
78
<p>Short Words for Scribus Copyright 2003, 2004 Petr Van&#283;k, &lt;<a href="mailto:petr@yarpen.cz">petr@yarpen.cz</a>&gt;</p>
79
<p>This program is free software; you can redistribute it
80
and/or modify it under the terms of the GNU General Public License as
81
published by the Free Software Foundation; either version 2 of the
82
License, or (at your option) any later version.</p><p>This program is distributed in the hope that it will be
83
useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
84
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
85
General Public License for more details.</p><p>You should have received a copy of the GNU General Public
86
License along with this program; if not, write to the Free Software
18122 mrdocs 87
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
1243 subik 88
 
10646 cbradney 89
</body>
90
</html>