/ 
Meta-0.08
River stage zero No dependents
/ Meta::Tool::Sgmltools

NAME

Meta::Tool::Sgmltools - run sgmltools for you.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

MANIFEST: Sgmltools.pm
PROJECT: meta
VERSION: 0.21

SYNOPSIS

package foo;
use Meta::Tool::Sgmltools qw();
my($object)=Meta::Tool::Sgmltools->new();
my($result)=$object->method();

DESCRIPTION

This module is here to ease the job of running sgmltools for you if you wish to use them (I think it's better to use the Jade.pm module which runs jade or openjade directly).

Sgmltools is quite problematic: 1. Sgmltools has a --jade-opt option but you CANT specify several options this way - you have to join everything into one thing.

FUNCTIONS

check($$)
c2texx($)
c2dvix($)
c2psxx($)
c2txtx($)
c2html($)
c2rtfx($)
c2mifx($)
c2info($)
c2pdfx($)
c2late($)
c2lyxx($)
tool($$$$)
TEST($)

FUNCTION DOCUMENTATION

check($$)

Run a check on the SGML document using the sgmlcheck utility.

c2texx($)

This routine will convert sgml DocBook files to Tex.

c2dvix($)

This routine will convert sgml DocBook files to Dvi.

c2psxx($)

This routine will convert sgml DocBook files to Postscript.

c2txtx($)

This routine will convert sgml DocBook files to Text.

c2html($)

This routine will convert sgml DocBook files to HTML.

c2rtfx($)

This routine will convert sgml DocBook files to Rtf (Rich Text Format).

c2mifx($)

This routine will convert sgml DocBook files to Mif (Microsoft Interchange Format). Currently this does not do the actual convertion because sgml tool do not support this so it just put an emblem.

c2info($)

This routine will convert sgml DocBook files to GNU info format. These is no info backend to sgmltools at the moment (3.0) that I am aware of. This means that this routine is broken. Do not use it.

c2pdfx($)

This routine will convert sgml DocBook files to Pdf (Portable Documentation Format). This way of prducing pdfs seems to be broken (I have not been able to see the resulting pdf using xpdf). In any case - this backend IS supported by sgmltools altough you cannot see this in the documentation.

c2late($)

This method will convert SGML DocBook files to Latex.

c2lyxx($)

This method will convert SGML DocBook files to Lyx.

tool($$$$)

This is the actual wrapper code. We pass directory search paths to jade via the option in sgmltools to pass options to jade...:) The problem is that sgmltools does not allow the option to specify the output file and so we do all the work using a temporary file and then move the result.

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

Name: Mark Veltzer
Email: mailto:veltzer@cpan.org
WWW: http://www.veltzer.org
CPAN id: VELTZER

HISTORY

0.00 MV history change
0.01 MV web site stuff
0.02 MV real deps for docbook files
0.03 MV remove old c++ files
0.04 MV pics with db support
0.05 MV bring back sgml to working condition
0.06 MV write some papers and custom dssls
0.07 MV spelling and papers
0.08 MV fix docbook and other various stuff
0.09 MV finish lit database and convert DocBook to SGML
0.10 MV perl packaging
0.11 MV BuildInfo object change
0.12 MV md5 project
0.13 MV database
0.14 MV perl module versions in files
0.15 MV movies and small fixes
0.16 MV thumbnail user interface
0.17 MV more thumbnail issues
0.18 MV website construction
0.19 MV web site automation
0.20 MV SEE ALSO section fix
0.21 MV md5 issues

SEE ALSO

Meta::Utils::Chdir(3), Meta::Utils::File::Copy(3), Meta::Utils::File::Move(3), Meta::Utils::File::Remove(3), Meta::Utils::Output(3), Meta::Utils::System(3), Meta::Utils::Text::Lines(3), Meta::Utils::Utils(3), strict(3)

TODO

-how can I stop jade from looking in /usr/lib/sgml and finding junk there ?

-remmember to restore SGML_CATALOG_FILES after invocation.

-do the actual code for c2info,c2pdfx

-try to use symlinks instead of the copies here (it will be faster).

-add a -o option to sgmltools so I wont need to bypass them here.