The lyx2html Handbook Jan Schaumann jschauma@netmeister.org Version 0.2 , Tue Sep 12 11:53:30 EST 2000 This Handbook describes lyx2html Version 0.2 1. Introduction 2. Installation 2.1 How to obtain lyx2html 2.2 Requirements 2.3 Compilation and installation 2.3.1 From RPM 2.3.2 From Source 3. Usage 3.1 General Usage 3.2 Test files 4. Supported features 5. Upcoming features 6. Bugs 7. Copyright 8. Misc ================================================== 1 Introduction ``lyx2html'' is a very simple Lyx to HTML converter. As the name suggests, it takes a ``.lyx'' document as input and generates an HTML-file following a few simple rules. ``lyx2html'' can be very useful for generation documentation. This is a beta-release, meaning there are probably still a lot of bugs in the program, and that it might not generate the expected output or that it might even segfault on you. For a list of supported features, please see Section 4. For a list of known bugs, please see Section 6. ================================================== 2 Installation 2.1 How to obtain lyx2html lyx2html 0.2 can be obtained from: * http://www.netmeister.org/apps/lyx2html-0.2.tar.gz * http://guinness.cs.stevens-tech.edu/~/jschauma/lyx2html-0.2.tar.gz * http://www.netmeister.org/apps/lyx2html-0.2-1mdk.i686.rpm * http://www.netmeister.org/apps/lyx2html-0.2-1mdk.src.rpm View the Changelog for (d'uh) Changes: http://www.netmeister.org/apps/lyx2html/CHANGES 2.2 Requirements In order to successfully compile and use lyx2html, you need the following programs and libraries which are available on most platforms as distribution packages and thereby can be installed easily. * gcc (or compatible), available at http://www.gnu.org * GNU make (or compatible), available at http://www.gnu.org 2.3 Compilation and installation 2.3.1 From RPM If you are installing lyx2html from an RPM, please referr to rpm(1) and/or ``rpm --help''. The general syntax is ``rpm -i lyx2html-0.2-1mdk.i686.rpm''. 2.3.2 From Sources At first extract the contents of the archive. If you have GNU tar installed, you can simply issue the command tar zxvf lyx2html-0.2.tar.gz If you don't have GNU tar, you can use gzip -dc lyx2html-0.2.tar.gz | tar xvf - Then change the directory to the root directory of the distribution and build lyx2html by issuing the commands: cd lyx2html-0.2 make make install The last command is optional and requires superuser privileges. Should you run into problems, report them to the the author at jschauma@netmeister.org ================================================== 3 Usage 3.1 General Usage The general usage of lyx2html is lyx2html <filename>.lyx To see which command line arguments lyx2html supports, try lyx2html --help 3.2 Test files To see if lyx2html works, try to convert the lyx-version of this README: lyx2html test/README.lyx If all goes well, you should then have the HTML version in test/README.html ================================================== 4 Supported Features lyx2html currently supports the following features: * Title * Author * Abstract * creation of a Table of Contents * http-, https- and ftp-URLs will be converted into html-hyperlinks * bulleted lists (<ul>) * numbered lists (<ol>) * italics * bold * Date: if you enter "Date" in the style Date, the current date will be substituted - useful for "Last modified" * footnotes (will be converted to ``(footnotetext)'') * if you enter "Date" with style "\layout Date", the /current/ date will be placed into the document ================================================== 5 Upcoming Features Features that are not currently implemented but are being worked on are: * support for email-address (conversion into mailto-hyperlinks) * support for footnotes (as ``real'' footnotes) * support for cross references (as hyperlinks) * font family typewriter => <code></code> * different fonts and font colors * command line option ``--split'': If "--split" was specified, the outfile will be infile-SectionNumber.html. If "--split infile outfilemask" was specified, the output will be output-SectionNumber.html (=>thus exit if "--split" AND "outfile.html", as this would lead to "outfile.html-SectionNumber.html") * better use of memory ================================================== 6 Known bugs As mentioned earlier, this release of lyx2html is a beta-release. Lots of things are not working correctly or at all. If you find a bug, please report it to the author. If you get a segfault, please send a backtrace to the author. This will help improve the programs performance. The current memory-allocation is, even though improved over 0.1.1, still miserable and even leads to occasional segfaults. I definitely have to work on this! ================================================== 7 Copyright lyx2html Copyright 2000 Jan Schaumann, jschauma@netmeister.org 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., 675 Mass Ave, Cambridge, MA 02139, USA. ================================================== 8 Misc A few things that are important to me and that everybody should have an opinion about: * http://www.aclu.org * http://www.amnesty.org * http://www.worldwildlife.org * http://www.ncadp.org