<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>UWE</firstname>">
  <!ENTITY dhsurname   "<surname>STEINMANN</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>April 20, 2006</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>3</manvolnum>">
  <!ENTITY dhemail     "<email>uwe@steinmann.cx</email>">
  <!ENTITY dhusername  "Uwe Steinmann">
  <!ENTITY dhucpackage "<refentrytitle>PS_SHOW_BOXED</refentrytitle>">
  <!ENTITY funcname    "PS_show_boxed">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&funcname;</refname>

    <refpurpose>Output text in a box</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <para>#include &lt;pslib.h&gt;</para>
		<para>int &funcname;(PSDoc *psdoc, char *text, float left, float bottom, float width, float height, const char *hmode, const char *feature)</para>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>Outputs a text in a given box. The lower left corner of the
		  box is at (<parameter>left</parameter>, <parameter>bottom</parameter>).
			If the <parameter>height</parameter> is set to 0.0 the box will become
			as tall as needed to contain all the text. If
			<parameter>feature</parameter> is set to <literal>blind</literal> no
			text will be output but the is set as usual. This can for example be
			used to calculate the box height needed to comprise all text or in
			order to determine how much text fits into a box.</para>
		<para>
			Line breaks will be inserted where
		  needed. Multiple spaces are treated as one. Tabulators are treated as
			spaces. The parameter <parameter>hmode</parameter> can be "justify",
			"fulljustify", "right", "left", or "center". The difference of "justify"
			and "fulljustify" just affects the last line of the box. In fulljustify
			mode the last line will be left and right justified unless this is also
			the last line of paragraph. In justify mode it will always be left
			justified.</para>

		<para>The text will be hyphenated if the parameter
			"hyphenation" is set to "true" and the parameter "hyphendict" contains
			a valid filename for a hyphenation file. The line spacing is taken
			from the value "leading". Paragraphs can be separated by an empty
			line just like in TeX. If the value "parindent" is set to value &gt; 0.0
			then the first n lines will be indented. The number of indented lines
			is set by the parameter "numindentlines". In order to prevent indenting
			of the first m paragraphs set the value "parindentskip" to a positive
			number.</para>
  </refsect1>

  <refsect1>
    <title>USED PARAMETERS</title>

		<para>The output of <function>&funcname;</function> can be configured
		  with several parameters and values which must be set with either
			<function>PS_set_parameter(3)</function> or
			<function>PS_set_value(3)</function>. Beside the parameters and values
			which affect text output the following parameters and values are
			evaluated.</para>
		<variablelist>
		  <varlistentry>
			  <term>leading (value)</term>
			  <listitem>
				  <para>Distance between baselines of two consecutive lines.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>linebreak (parameter)</term>
			  <listitem>
				  <para>Set to "true" if you want a carrige return to start a new
					  line instead of treating it as a space. Defaults to "false".
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>parbreak (parameter)</term>
			  <listitem>
				  <para>Set to "true" if you want a carrige return on a single line
					  to start a new paragraph instead of treating it as a space.
						Defaults to "true".
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>hyphenation (parameter)</term>
			  <listitem>
				  <para>Set to "true" in order to turn hyphenation on. This requires
					  a dictionary to be set with the parameter "hyphendict". Defaults
						to "false".
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>hyphendict (parameter)</term>
			  <listitem>
				  <para>Filename of the dictionary used for hyphenation pattern (see
					  below).
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>hyphenminchar (value)</term>
			  <listitem>
				  <para>The number of chars which must at least be left over before
					  or after the hyphen. This implies that only words of at least
						two times this value will be hyphenated. The default value is
						three. Setting a value of zero will result in the default value.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>parindent (value)</term>
			  <listitem>
				  <para>Set the amount of space in pixel for indenting the first
					  m lines of a paragraph. m can be set with the value
						"numindentlines".
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>parskip (value)</term>
			  <listitem>
				  <para>Set the amount of extra space in pixel between paragraphs.
					  Defaults to 0 which will result in a normal line distance.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>numindentlines (value)</term>
			  <listitem>
				  <para>Number of lines from the start of the paragraph which will
					  be indented. Defaults to 1.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>parindentskip (value)</term>
			  <listitem>
				  <para>Number of paragraphs in the box whose first lines will
					  not be indented. This defaults to 0. This is useful for paragraphs
						right after a section heading or text being continued in a
						second box. In both case one would set this to 1.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>linenumbermode (parameter)</term>
			  <listitem>
				  <para>Set how lines are to be numbered. Possible values are "box"
					  for numbering lines in the whole box or "paragraph" to number
						lines within each paragraph.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>linenumberspace (value)</term>
			  <listitem>
				  <para>The space for the column left of the numbered line containing
					  the line number. The
					  line number will be right justified into this column. Defaults
						to 20.
					</para>
				</listitem>
			</varlistentry>
		  <varlistentry>
			  <term>linenumbersep (value)</term>
			  <listitem>
				  <para>The space between the column with line numbers and the
					  line itself. Defaults to 5.
					</para>
				</listitem>
			</varlistentry>
		</variablelist>
  </refsect1>
  <refsect1>
    <title>HYPHENATION</title>
    <para>Text is hyphenated if the parameter "hyphenation" is set to true
		  and a valid hyphenation dictory is set. pslib does not ship its own
			hyphenation dictionary but uses one from openoffice, scribus or koffice.
			You can find their dictionaries for different languages in one of the
			following directories if the software is
			installed: /usr/share/apps/koffice/hyphdicts/,
			/usr/lib/scribus/dicts/, or /usr/lib/openoffice/share/dict/ooo/.
			Currently scribus appears to have the most complete hyphenation
			dictionaries.</para>
  </refsect1>
  <refsect1>
    <title>RETURN VALUE</title>
    <para>Number of charactes that could not be written. This function will
		  also set the value "boxheight" to the actual height of the box. This
			enables you to put several boxed beneath each other and keep the propper
			line spacing.</para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>PS_continue_text(3)</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->