10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->

10139N/A<!ENTITY cmd "scrollkeeper-devel">

10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">

10139N/A%commonents;

10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">

10139N/A%booktitles;

10139N/A<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.">

10139N/A]>

10139N/A<?Pub UDT _bookmark _target>

10139N/A<?Pub Inc>

10139N/A<refentry id="scrollkeeper-devel-1">

10139N/A<refmeta><refentrytitle>scrollkeeper-devel</refentrytitle><manvolnum>1</manvolnum>

10139N/A<refmiscinfo class="date">01 Apr 2003</refmiscinfo>

10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

10139N/A<refmiscinfo class="software">&release;</refmiscinfo>

10139N/A<refmiscinfo class="arch">generic</refmiscinfo>

10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

10139N/A</refmeta>

10139N/A<indexterm><primary>scrollkeeper-devel</primary></indexterm><indexterm><primary>

10139N/Aworking with OMF documents and the scrolkeeper database</primary></indexterm>

10139N/A<indexterm><primary>scrollkeeper-extract</primary></indexterm><indexterm>

10139N/A<primary>convert DocBook/SGML files to Docbook/XML files if necessary, and

10139N/Aapply a number of transformations to the XML file to extract information from

10139N/Athe XML file</primary></indexterm><indexterm><primary>scrollkeeper-gen-seriesid

10139N/A</primary></indexterm><indexterm><primary>generates a globally unique series

10139N/AID for an OMF file.</primary></indexterm><indexterm><primary>scrollkeeper-preinstall

10139N/A</primary></indexterm><indexterm><primary>points OMF files to the correct

10139N/Alocation on the target machine before registration in the <application>scrollkeeper

10139N/A</application> database</primary></indexterm><refnamediv id="scrollkeeper-devel-1-name">

10139N/A<refdescriptor>&cmd;</refdescriptor><refname>scrollkeeper-extract</refname>

10139N/A<refname>scrollkeeper-gen-seriesid</refname><refname>scrollkeeper-preinstall

10139N/A</refname><refpurpose>utilities for working with OMF documents and the <application>

10139N/Ascrollkeeper</application> database</refpurpose></refnamediv>

10139N/A<refsynopsisdiv id="scrollkeeper-devel-1-synp"><title>&synp-tt;</title>

10139N/A<cmdsynopsis><command>scrollkeeper-extract</command><arg choice="plain"><option

10139N/Arole="nodash"><replaceable>file</replaceable></option></arg><arg choice="plain"><option

10139N/Arole="nodash"><replaceable>stylesheet</replaceable></option> <option role="nodash"><replaceable>

10139N/Aoutput</replaceable></option></arg><arg choice="opt" rep="repeat"><option

10139N/Arole="nodash"><replaceable>stylesheet</replaceable></option> <option role="nodash"><replaceable>

10139N/Aoutput</replaceable></option></arg>

10139N/A</cmdsynopsis>

10139N/A<cmdsynopsis><command>scrollkeeper-gen-seriesid</command>

10139N/A</cmdsynopsis>

10139N/A<cmdsynopsis><command>scrollkeeper-preinstall</command><arg choice="plain"><option

10139N/Arole="nodash"><replaceable>docfile</replaceable></option></arg><arg choice="plain"><option

10139N/Arole="nodash"><replaceable>omf-file1</replaceable></option></arg><arg choice="plain"><option

10139N/Arole="nodash"><replaceable>omf-file2</replaceable></option></arg>

10139N/A</cmdsynopsis></refsynopsisdiv>

10139N/A<refsect1 id="scrollkeeper-devel-1-desc"><title>&desc-tt;</title>

10139N/A<para><command>scrollkeeper-extract</command> is used internally by <application>

10139N/Ascrollkeeper</application> to convert DocBook/SGML files to Docbook/XML files

10139N/Aif necessary, and to apply a number of transformations to the XML file to

10139N/Aextract information from the XML file.</para>

10139N/A<para><command>scrollkeeper-gen-seriesid</command> generates a globally unique

10139N/Aseries ID for an OMF file.</para>

10139N/A<para><command>scrollkeeper-preinstall</command> reads <filename><replaceable>

10139N/Aomf_file1</replaceable></filename>, changes the URL attribute of the identifier

10139N/Atag to <replaceable>doc_file</replaceable> and writes the output to <filename><replaceable>

10139N/Aomf_file2</replaceable></filename>. <command>scrollkeeper-preinstall</command>

10139N/Acan be used during the document installation process to point OMF files to

10139N/Athe correct location on the target machine before registration in the <application>

10139N/Ascrollkeeper</application> database.</para>

10139N/A</refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-opts"><title>&opts-tt;</title>

10139N/A<para>None.</para>

10139N/A</refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-oper"><title>&oper-tt;</title>

10139N/A<para>The following operands are supported:</para>

10139N/A<variablelist termlength="narrow"><varlistentry><term><option role="nodash"><replaceable>

10139N/Adocfile</replaceable></option></term><listitem><para>Specifies the file path

10139N/Ato the document that <replaceable>omf-file1</replaceable> describes.</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><option role="nodash"><replaceable>file</replaceable></option></term>

10139N/A<listitem><para>Specifies the XML file that is to be used as input for XSLT

10139N/Atransformations.</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><option role="nodash"><replaceable>omf-file1</replaceable></option></term>

10139N/A<listitem><para>Specifies the OMF file that contains metadata for <replaceable>

10139N/Adocfile</replaceable>.</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><option role="nodash"><replaceable>omf-file2</replaceable></option></term>

10139N/A<listitem><para>Specifies the file created by <command>scrollkeeper-preinstall

10139N/A</command>, which contains the same data as <replaceable>omf-file1</replaceable> except

10139N/Athat the URL attribute of the identifier tag is changed to <replaceable>docfile

10139N/A</replaceable>.</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><option role="nodash"><replaceable>output</replaceable></option></term>

10139N/A<listitem><para>Specifies the file that contains the result when the preceding <replaceable>

10139N/Astylesheet</replaceable> has been applied to <replaceable>file</replaceable>.

10139N/A</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><option role="nodash"><replaceable>stylesheet</replaceable></option></term>

10139N/A<listitem><para>Specifies an XSLT transformation to apply.</para>

10139N/A</listitem></varlistentry>

10139N/A</variablelist></refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-exam"><title>&exam-tt;</title>

10139N/A<example role="example"><title>Creating a New scrollkeeper Series ID</title>

10139N/A<para><screen>example% <userinput>scrollkeeper-gen-seriesid</userinput></screen></para>

10139N/A</example>

10139N/A<example role="example"><title>Extracting a TOC From a Document</title>

10139N/A<para><screen>example% <userinput>scrollkeeper-extract <replaceable>/path/to/xml/file.xml

10139N/A</replaceable> /usr/share/scrollkeeper/stylesheets/toc.xsl <replaceable>/path/to/toc.xml

10139N/A</replaceable></userinput></screen></para>

10139N/A</example>

10139N/A</refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-exit"><title>&exit-tt;</title>

10139N/A<para>The following exit values are returned:</para>

10139N/A<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>

10139N/A<listitem><para>Application exited successfully</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

10139N/Aexited with failure</para>

10139N/A</listitem></varlistentry>

10139N/A</variablelist></refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-file"><title>&file-tt;</title>

10139N/A<para>The following files are used by this application:</para>

11904N/A<variablelist termlength="wholeline"><varlistentry><term><filename>

10139N/A/usr/bin/scrollkeeper-extract</filename> </term><listitem><para>The command-line

10139N/Aexecutable for the <filename>scrollkeeper-extract</filename> application.

10139N/A</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-gen-seriesid</filename>

10139N/A</term><listitem><para>The command-line executable for the <filename>scrollkeeper-gen-seriesid

10139N/A</filename> application.</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><filename>/usr/bin/scrollkeeper-preinstall</filename>

10139N/A</term><listitem><para>The command-line executable for the <filename>scrollkeeper-preinstall

10139N/A</filename> application.</para>

10139N/A</listitem></varlistentry>

10139N/A</variablelist></refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-attr"><title>&attr-tt;</title>

10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

10139N/Afor descriptions of the following attributes:</para>

10139N/A<informaltable frame="all">

10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

10139N/A<colspec colname="COLSPEC1" colwidth="1*">

10139N/A<thead>

10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>

10139N/A</thead>

10139N/A<tbody>

10139N/A<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-libs-devel

10139N/A</para></entry></row>

10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

11171N/Acolname="COLSPEC1"><para>Obsolete</para></entry></row>

10139N/A</tbody>

10139N/A</tgroup>

10139N/A</informaltable>

10139N/A</refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-also"><title>&also-tt;</title>

11925N/A<para>

11941N/A<citerefentry><refentrytitle>scrollkeeper</refentrytitle><manvolnum>1</manvolnum></citerefentry>

11925N/A</para>

10139N/A</refsect1>

10139N/A<refsect1 id="scrollkeeper-devel-1-note"><title>&note-tt;</title>

11933N/A<para>Written by Sander Vesik, Sun Microsystems Inc., 2003.</para>

11933N/A<para>Updated by Ghee Teo, Sun Microsystems Inc., 2007.</para>

10139N/A</refsect1>

10139N/A</refentry>