litvinovg/w2phtml
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 21 Packages Wiki Activity Actions

Merge w4l int w2l - update help files

Browse source 
git-svn-id: svn://svn.code.sf.net/p/writer2latex/code/trunk@202 f0f2a975-2e09-46c8-9428-3b39399b9f3c
This commit is contained in:
henrikjust 2014-11-03 07:55:41 +00:00
parent fbb7f60ac1
commit 88c3a7295d
7 changed files with 235 additions and 201 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
source/oxt/writer2latex/help/en/help.tree
View file

@ -2,10 +2,9 @@
<tree_view version="02-nov-2014">
<help_section application="writer2latex" id="w2l01_writer" title="Writer2LaTeX">
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/introduction.xhp">Introduction</topic>
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/menu.xhp">Menu reference</topic>
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/guidelines.xhp">Guidelines</topic>
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/menu.xhp">Menu and toolbar</topic>
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/export.xhp">LaTeX Export</topic>
<!--<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/import.xhp">Importing TeX files</topic>-->
<!--<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/import.xhp">LaTeX import</topic>-->
<node id="w2l01_writer_toolbar_configuration" title="Toolbar configuration">
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/applications.xhp">Applications</topic>
<topic id="writer2latex/org.openoffice.da.writer2latex.oxt/bibliography.xhp">Bibliography</topic>

87
source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/applications.xhp
View file

@ -1,28 +1,81 @@
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<meta>
<topic id="writer4latex-applications" indexer="include">
<topic id="writer2latex-applications" indexer="include">
<title xml-lang="en-US">Applications</title>
<filename>org.openoffice.da.writer4latex.oxt/applications.xhp</filename>
<filename>org.openoffice.da.writer2latex.oxt/applications.xhp</filename>
</topic>
</meta>
<body>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:ConfigurationDialog" id="bm_configurationdialog"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:ConfigurationDialog" id="bm_configurationdialog"/>
<paragraph role="heading" level="1" xml-lang="en-US">Configuration of applications</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Before you can use Writer4LaTeX you must configure it to use your LaTeX
<paragraph role="paragraph" xml-lang="en-US">Before you can use Writer2LaTeX you must configure it to use your LaTeX
distribution as well as viewers for the different output formats.</paragraph>
<section id="howtoget" xml-lang="en-US">
Select <emph>Tools - Options - %PRODUCTNAME Writer - Writer4LaTeX - Applications</emph>
Select <emph>Tools - Options - %PRODUCTNAME Writer - Writer2LaTeX toolbar - Applications</emph>
</section>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:ConfigurationAutoButton" id="bm_configurationautobutton"/>
<paragraph role="heading" level="2" xml-lang="en-US">Automatic Configuration</paragraph>
<paragraph role="paragraph" xml-lang="en-US">If you click this button, Writer4LaTeX will try to locate the external programs
and configure them. You will be presented with a short report of the results. Any applications that Writer4LaTeX cannot find for
you must be configured manually.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:ConfigurationAutoButton" visibility="hidden">Click here to let Writer4LaTeX configure your external applications automatically</ahelp></paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Prerequisites</paragraph>
<paragraph role="paragraph" xml-lang="en-US">This requires that you have installed certain software on your system.</paragraph>
<switch select="sys">
<case select="WIN">
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Writer2LaTeX needs a working LaTeX distribution<!-- including TeX4ht-->.
MikTeX is recommended and can be downloaded from
<link href="http://www.miktex.org" name="MikTeX download">http://www.miktex.org</link>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">In addition, you should install viewers for PDF and PostScript files.
Gsview is recommended and can be downloaded from
<link href="http://pages.cs.wisc.edu/~ghost/gsview/" name="gsview download">http://pages.cs.wisc.edu/~ghost/gsview/</link>.
Note that you have to install ghostscript as well (follow the links on the web site).</paragraph>
</listitem>
</list>
</case>
<case select="UNIX">
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Writer2LaTeX needs a working LaTeX distribution<!-- which includes TeX4ht-->.
<link href="http://www.tug.org/texlive/" name="TeX live">TeX live</link>
is recommended and is available for most UNIX-like systems. The installation depends on your system.
If you are using Debian or Ubuntu you can for example install the basic required packages by typing these commands from a terminal window:</paragraph>
<paragraph role="code" xml-lang="en-US">sudo apt-get install texlive
<br/>sudo apt-get install texlive-latex-extra
<br/>sudo apt-get install texlive-xetex
<!--<br/>sudo apt-get install tex4ht--></paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Also you should install viewers for DVI, PDF and PostScript files.
The viewers evince and okular can handle all formats and are recommended.
You can also use a combination of the viewers xdvi, xpdf and ghostview.
</paragraph>
</listitem>
</list>
</case>
<case select="MAC">
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Writer2LaTeX needs a working LaTeX distribution<!-- which includes TeX4ht-->.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Also you should install viewers for DVI, PDF and PostScript files.
</paragraph>
</listitem>
</list>
<paragraph xml-lang="en-US"><emph>Note</emph>: The Writer2LaTeX toolbar is not tested on Mac OS X.</paragraph>
</case>
</switch>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:ConfigurationApplication" id="bm_configurationapplication"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:ConfigurationAutoButton" id="bm_configurationautobutton"/>
<paragraph role="heading" level="2" xml-lang="en-US">Automatic Configuration</paragraph>
<paragraph role="paragraph" xml-lang="en-US">If you click this button, Writer2LaTeX will try to locate the external programs
and configure them. You will be presented with a short report of the results. Any applications that Writer2LaTeX cannot find for
you must be configured manually.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:ConfigurationAutoButton" visibility="hidden">Click here to let Writer2LaTeX configure your external applications automatically</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:ConfigurationApplication" id="bm_configurationapplication"/>
<paragraph role="heading" level="2" xml-lang="en-US">Application</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Select the external application you wish to configure in the list.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The available applications are:</paragraph>
@ -52,18 +105,18 @@
<paragraph role="paragraph" xml-lang="en-US">PostScript Viewer: Application to view PostScript files</paragraph>
</listitem>
</list>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:ConfigurationApplication" visibility="hidden">Select the external application you wish to configure here</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:ConfigurationApplication" visibility="hidden">Select the external application you wish to configure here</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:ConfigurationExecutable" id="bm_configurationexecutable"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:ConfigurationExecutable" id="bm_configurationexecutable"/>
<paragraph role="heading" level="2" xml-lang="en-US">Executable</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Type the full path to the executable or click <emph>Browse</emph> to find
the executable in your file system</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:ConfigurationExecutable" visibility="hidden">Type the full path to the executable here or find it using the Browse button</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:ConfigurationExecutable" visibility="hidden">Type the full path to the executable here or find it using the Browse button</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:ConfigurationOptions" id="bm_configurationoptions"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:ConfigurationOptions" id="bm_configurationoptions"/>
<paragraph role="heading" level="2" xml-lang="en-US">Options</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Fill out any additional options here. Often you will only need the file name,
which is denoted <emph>%s</emph>.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:ConfigurationOptions" visibility="hidden">Fill out any additional options here, using %s to represent the file name</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:ConfigurationOptions" visibility="hidden">Fill out any additional options here, using %s to represent the file name</ahelp></paragraph>
</body>
</helpdocument>

52
source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/bibliography.xhp
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<meta>
<topic id="writer4latex-bibliography" indexer="include">
<topic id="writer2latex-bibliography" indexer="include">
<title xml-lang="en-US">Bibliography</title>
<filename>org.openoffice.da.writer4latex.oxt/bibliography.xhp</filename>
<filename>org.openoffice.da.writer2latex.oxt/bibliography.xhp</filename>
</topic>
</meta>
<body>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyDialog" id="bm_bibliographydialog"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyDialog" id="bm_bibliographydialog"/>
<paragraph role="heading" level="1" xml-lang="en-US">Configuration of bibliography</paragraph>
<paragraph role="paragraph" xml-lang="en-US">On this page you can define the interaction between Writer4LaTeX and
<paragraph role="paragraph" xml-lang="en-US">On this page you can define the interaction between Writer2LaTeX and
external bibliographic tools.</paragraph>
<section id="howtoget" xml-lang="en-US">
Select <emph>Tools - Options - %PRODUCTNAME Writer - Writer4LaTeX - Bibliography</emph>
Select <emph>Tools - Options - %PRODUCTNAME Writer - Writer2LaTeX toolbar - Bibliography</emph>
</section>
<paragraph role="heading" level="2" xml-lang="en-US">Citations and BibTeX files</paragraph>
<paragraph role="paragraph" xml-lang="en-US">There are several ways to handle bibliographic references in %PRODUCTNAME Writer.
If you use the standard bibliographic tool provided by %PRODUCTNAME, Writer4LaTeX can convert the references to BibTeX if you
If you use the standard bibliographic tool provided by %PRODUCTNAME, Writer2LaTeX can convert the references to BibTeX if you
choose to do so in the export dialog. In this case you should not make any settings on this page.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You may also use other tools such as Zotero or JabRef to handle your citations.
If you want to use BibTeX to format references inserted by these tools, Writer4LaTeX can convert them for you. In this case
If you want to use BibTeX to format references inserted by these tools, Writer2LaTeX can convert them for you. In this case
you have to define the location of the BibTeX files produced by Zotero or JabRef.</paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyUseExternalBibTeXFiles" id="bm_useexternalbibtexfiles"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyUseExternalBibTeXFiles" id="bm_useexternalbibtexfiles"/>
<paragraph role="heading" level="3" xml-lang="en-US">Use external BibTeX files for ordinary citations</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Check this if the citations in your document refers to one or more external BibTeX files.
(The keys used in the document must match up with the keys in the external BibTeX files.)</paragraph>
<paragraph role="paragraph" xml-lang="en-US">This feature is for advanced users that maintain their references in BibTeX.
It enables you to use the original BibTeX files in the LaTeX document rather than converting the inserted
references back into BibTeX.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyUseExternalBibTeXFiles" visibility="hidden">Check this if your citations refer to external BibTeX file(s)</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyUseExternalBibTeXFiles" visibility="hidden">Check this if your citations refer to external BibTeX file(s)</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyConvertZoteroCitations" id="bm_convertzoterocitations"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyConvertZoteroCitations" id="bm_convertzoterocitations"/>
<paragraph role="heading" level="3" xml-lang="en-US">Convert Zotero citations</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><link href="http://www.zotero.org" name="Link to the Zotero Website">Zotero</link>
is a free, easy-to-use tool to help you collect, organize, cite, and share your research sources.
@ -55,9 +55,9 @@
<paragraph role="paragraph" xml-lang="en-US">You can now export your Zotero database: In Zotero, select
<emph>Export Library</emph>, and choose <emph>BibTeX (Writer2LaTeX)</emph> (not <emph>BibTeX</emph>).
Save the file in the folder, you have defined.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyConvertZoteroCitations" visibility="hidden">Check this to convert Zotero citations to LaTeX</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyConvertZoteroCitations" visibility="hidden">Check this to convert Zotero citations to LaTeX</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyConvertJabRefCitations" id="bm_convertjabrefcitations"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyConvertJabRefCitations" id="bm_convertjabrefcitations"/>
<paragraph role="heading" level="3" xml-lang="en-US">Convert JabRef citations</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><link href="http://jabref.sourceforge.net/" name="Link to the JabRef Website">JabRef</link>
is an open source bibliography reference manager using BibTeX as native file format.
@ -69,18 +69,18 @@
Also, the bibliography created by JabRef will be replaced with a BibTeX-generated bibliography.
If you do not check this option, the original
citation text inserted by JabRef will be used.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyConvertJabRefCitations" visibility="hidden">Check this to convert JabRef citations to LaTeX</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyConvertJabRefCitations" visibility="hidden">Check this to convert JabRef citations to LaTeX</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyIncludeOriginalCitations" id="bm_includeoriginalcitations"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyIncludeOriginalCitations" id="bm_includeoriginalcitations"/>
<paragraph role="heading" level="3" xml-lang="en-US">Include original citations as comments</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Check this if you want to include the original citations produced by Zotero or
JabRef as comments in the LaTeX source. This has no effect on the final result but might be helpful if you edit the LaTeX source.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyIncludeOriginalCitations" visibility="hidden">Check this to include the citations inserted by Zotero or JabRef as comments in the LaTeX source.</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyIncludeOriginalCitations" visibility="hidden">Check this to include the citations inserted by Zotero or JabRef as comments in the LaTeX source.</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyBibTeXLocation" id="bm_bibtexlocation"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyBibTeXLocation" id="bm_bibtexlocation"/>
<paragraph role="heading" level="3" xml-lang="en-US">BibTeX location</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Writer4LaTeX will look for BibTeX files in the location you define.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Writer2LaTeX will look for BibTeX files in the location you define.</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>In central folder</emph>: Select this option if you keep all your
@ -97,30 +97,30 @@
same name for the LaTeX file and the BibTeX file (your BibTeX file might be overwritten if you do).</paragraph>
</listitem>
</list>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyBibTeXLocation" visibility="hidden">Select the type of location for your BibTeX files</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyBibTeXLocation" visibility="hidden">Select the type of location for your BibTeX files</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyBibTeXDir" id="bm_bibtexdir"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyBibTeXDir" id="bm_bibtexdir"/>
<paragraph role="heading" level="3" xml-lang="en-US">BibTeX folder</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Enter the path to the folder containing your BibTeX files, or select the folder
using the <emph>Browse</emph>-button.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyBibTeXDir" visibility="hidden">Enter the path to the folder containing the BibTeX files</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyBibTeXDir" visibility="hidden">Enter the path to the folder containing the BibTeX files</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyBibTeXDirButton" id="bm_bibtexdirbutton"/>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyBibTeXDirButton" visibility="hidden">Click to select the path to the folder containing the BibTeX files</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyBibTeXDirButton" id="bm_bibtexdirbutton"/>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyBibTeXDirButton" visibility="hidden">Click to select the path to the folder containing the BibTeX files</ahelp></paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Natbib</paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyUseNatbib" id="bm_usenatbib"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyUseNatbib" id="bm_usenatbib"/>
<paragraph role="heading" level="3" xml-lang="en-US">Use natbib.sty</paragraph>
<paragraph role="paragraph" xml-lang="en-US">To fully support the citations inserted by Zotero or JabRef you will need
the package natbib.sty. Check this if you want to take advantage of this package (the BibTeX style you use must be compatible
with natbib.sty).</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyUseNatbib" visibility="hidden">Check this to use the package natbib.sty for your citations</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyUseNatbib" visibility="hidden">Check this to use the package natbib.sty for your citations</ahelp></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex.oxt:BibliographyNatbibOptions" id="bm_natbiboptions"/>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex.oxt:BibliographyNatbibOptions" id="bm_natbiboptions"/>
<paragraph role="heading" level="3" xml-lang="en-US">Options</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Enter any options to the package natbib.sty here.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex.oxt:BibliographyNatbibOptions" visibility="hidden">Enter any options to the package natbib.sty here</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex.oxt:BibliographyNatbibOptions" visibility="hidden">Enter any options to the package natbib.sty here</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"></paragraph>

48
source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/guidelines.xhp
View file

@ -1,48 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<meta>
<topic id="writer4latex-guidelines" indexer="include">
<title xml-lang="en-US">Guidelines</title>
<filename>org.openoffice.da.writer4latex.oxt/guidelines.xhp</filename>
</topic>
</meta>
<body>
<paragraph role="heading" level="1" xml-lang="en-US">Guidelines</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Not every feature in %PRODUCTNAME Writer is supported by LaTeX. To avoid unexpected
results follow these guidelines.</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Page styles</emph>: %PRODUCTNAME Writer offers a sofisticated
page style scheme, where every page style can define another style to be used for the next page.
You can thus have something like Style A → Style B → Style C.
In LaTeX this is only possible in the first step of a page sequence:
The example above will produce Style A → Style B → Style B in LaTeX.
You should beware of this when you design your page styles. Note that explicit change of page style with
<emph>Insert - Manual break</emph> is not affected by this limitation.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">In LaTeX the same page geometry is used for all pages. The dimensions are
taken from the first page of your document.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Do not create headers and footers with more than one line of text,
these will not be exported correctly to LaTeX.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Background color</emph>: Background color is currently not supported
except in table cells. You should avoid using background color elsewhere.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Graphics</emph>: Anchor graphics to paragraph or to character if you
want a floating graphic. If you want the graphic to be a part of the text flow, anchor it to character. Do not anchor
graphics to page as this will make the graphics turn up the wrong place in your document.
You are advised not to wrap text around graphics as this is not exported to LaTeX anyway.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Also, do not use drawing objects inserted directly in the text (using the
Drawing toolbar). These will not be converted to LaTeX.
If you need to insert a drawing, insert an embedded Draw object (<emph>Insert - Object</emph>).</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Tables</emph>: Avoid using cells spanning several rows, as this
is currently not supported. Cells spanning several columns are fully supported.</paragraph>
</listitem>
</list>
<paragraph role="paragraph" xml-lang="en-US">In general you should be aware that not all formatting is exported. The export of formatting
depends on the selected LaTeX format.</paragraph>
</body>
</helpdocument>

162
source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/introduction.xhp
View file

@ -1,48 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<meta>
<topic id="writer4latex-introduction" indexer="include">
<topic id="writer2latex-introduction" indexer="include">
<title xml-lang="en-US">Introduction</title>
<filename>org.openoffice.da.writer4latex.oxt/introduction.xhp</filename>
<filename>org.openoffice.da.writer2latex.oxt/introduction.xhp</filename>
</topic>
</meta>
<body>
<paragraph role="heading" level="1" xml-lang="en-US">Introduction to Writer4LaTeX</paragraph>
<paragraph role="heading" level="1" xml-lang="en-US">Introduction to Writer2LaTeX</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The purpose of the Writer4LaTeX extension is to turn Writer into a frontend for LaTeX.
By installing Writer4LaTeX you will thus be available to author well-structured LaTeX documents using (almost) the full power of
%PRODUCTNAME Writer.
The functionality of %PRODUCTNAME Writer with Writer4LaTeX can be compared to the application
<link href="http://www.lyx.org" name="Link to the Lyx Website">LyX</link>.
</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Authoring LaTeX files with Writer4LaTeX</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You can use Writer4LaTeX in two different ways
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The Writer2LaTeX extension provides you with a set of tools to
create LaTeX documents with %PRODUCTNAME Writer.
By installing Writer2LaTeX you will be able to author well-structured LaTeX documents using (almost)
the full power of %PRODUCTNAME Writer.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Writer2LaTeX has two modes of operation</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US">You can prepare your documents with Writer as you usually do,
keeping a few
<link href="org.openoffice.da.writer4latex.oxt/guidelines.xhp" name="Guidelines">guidelines</link> in mind.
You can then invoke Writer4LaTeX to convert your document into LaTeX, process the LaTeX document and display the final result. You are free to create either a LaTeX document that preserves as much of your formatting as possible – or create a clean LaTeX document that will resemble a LaTeX document created by hand.
</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">You can use some special
<link href="org.openoffice.da.writer4latex.oxt/templates.xhp" name="Using the templates">Writer templates</link>
provided with Writer4LaTeX to
create your documents. Using the styles supported by these templates, you can easily create standard LaTeX documents
using the opportunities of standard LaTeX document classes.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">For this initial version, templates for the standard LaTeX classes article
are provided. More templates will be added later (report, book, beamer...), and you can also add your own templates.
<paragraph role="paragraph" xml-lang="en-US">You can use Writer2LaTeX as an export filter.
It adds LaTeX and BibTeX export to the <emph>File - Export</emph>
<link href="org.openoffice.da.writer2latex.oxt/menu.xhp" name="Applications">menu</link>.
</paragraph>
</listitem>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">You can use Writer as a frontend for LaTeX.
It adds a
<link href="org.openoffice.da.writer2latex.oxt/menu.xhp" name="Applications">toolbar</link>
to interact with your LaTeX installation.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The functionality of %PRODUCTNAME Writer with
the Writer2LaTeX toolbar can be compared to the application
<link href="http://www.lyx.org" name="Link to the Lyx Website">LyX</link>.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Before you can use the Writer2LaTeX toolbar, you need to
<link href="org.openoffice.da.writer2latex.oxt/applications.xhp" name="Applications">configure</link> it.
</paragraph>
</listitem>
</list>
<!--<paragraph role="heading" level="2" xml-lang="en-US">LaTeX import</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You can
<link href="org.openoffice.da.writer4latex.oxt/import.xhp" name="Import TeX files">import</link>
<link href="org.openoffice.da.writer2latex.oxt/import.xhp" name="Import TeX files">import</link>
existing LaTeX documents into Writer.
This feature uses Eitan M. Gurari's excellent
<link href="http://www.cse.ohio-state.edu/~gurari/TeX4ht/" name="Link to the TeX4ht Website">TeX4ht</link>
@ -51,63 +47,51 @@
that were originally authored in LaTeX.
</paragraph>-->
<paragraph role="heading" level="2" xml-lang="en-US">Before you start</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Before you can use Writer4LaTeX, you need to
<link href="org.openoffice.da.writer4latex.oxt/applications.xhp" name="Applications">configure</link> it.
This requires that you have installed certain software on your system.</paragraph>
<switch select="sys">
<case select="WIN">
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US">The LaTeX export filter Writer2LaTeX must be installed in %PRODUCTNAME.
You can get this extension at
<link href="http://extensions.services.openoffice.org/project/writer2latex" name="Writer2LaTeX download">http://extensions.services.openoffice.org/project/writer2latex</link>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Writer4LaTeX needs a working LaTeX distribution<!-- including TeX4ht-->.
MikTeX is recommended and can be downloaded from
<link href="http://www.miktex.org" name="MikTeX download">http://www.miktex.org</link>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Finally you should install viewers for PDF and PostScript files.
Gsview is recommended and can be downloaded from
<link href="http://pages.cs.wisc.edu/~ghost/gsview/" name="gsview download">http://pages.cs.wisc.edu/~ghost/gsview/</link>.
Note that you have to install ghostscript as well (follow the links on the web site).</paragraph>
</listitem>
</list>
</case>
<case select="UNIX">
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US">The LaTeX export filter Writer2LaTeX must be installed in %PRODUCTNAME.
You can get this extension at
<link href="http://extensions.services.openoffice.org/project/writer2latex" name="Writer2LaTeX download">http://extensions.services.openoffice.org/project/writer2latex</link>.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Writer4LaTeX needs a working LaTeX distribution<!-- which includes TeX4ht-->.
<link href="http://www.tug.org/texlive/" name="TeX live">TeX live</link>
is recommended and is available for most UNIX-like systems. The installation depends on your system.
If you are using Debian or Ubuntu you can for example install the required packages by typing these commands from a terminal window:</paragraph>
<paragraph role="code" xml-lang="en-US">sudo apt-get install texlive
<br/>sudo apt-get install texlive-latex-extra
<br/>sudo apt-get install texlive-xetex
<!--<br/>sudo apt-get install tex4ht--></paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US">Finally you should install viewers for DVI, PDF and PostScript files.
The viewers evince and okular can handle all formats and are recommended.
You can also use a combination of the viewers xdvi, xpdf and ghostview.
</paragraph>
</listitem>
</list>
</case>
<case select="MAC">
<paragraph>Writer4LaTeX has not been tested on Mac OS X, but it should be possible to configure it manually
if you have installed a LaTeX distribution and viewers for DVI, PDF and PostScript documents.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You also need to install the LaTeX export filter Writer2LaTeX
in %PRODUCTNAME. You can get this extension at
<link href="http://extensions.services.openoffice.org/project/writer2latex" name="Writer2LaTeX download">http://extensions.services.openoffice.org/project/writer2latex</link>.</paragraph>
</case>
</switch>
<paragraph role="heading" level="2" xml-lang="en-US">Authoring LaTeX files with Writer2LaTeX</paragraph>
<paragraph role="paragraph" xml-lang="en-US">With Writer2LaTeX you can prepare your documents with Writer
as you usually do.
You can then invoke Writer2LaTeX to convert your document into LaTeX, process the LaTeX document and display
the final result.
You are free to create either a LaTeX document that preserves as much of your formatting as possible – or
create a clean LaTeX document that will resemble a LaTeX document created by hand.
</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Guidelines</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Not every feature in %PRODUCTNAME Writer is supported by LaTeX.
To avoid unexpected results follow these guidelines.</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Page styles</emph>: %PRODUCTNAME Writer offers a sofisticated
page style scheme, where every page style can define another style to be used for the next page.
You can thus have something like Style A → Style B → Style C.
In LaTeX this is only possible in the first step of a page sequence:
The example above will produce Style A → Style B → Style B in LaTeX.
You should beware of this when you design your page styles. Note that explicit change of page style with
<emph>Insert - Manual break</emph> is not affected by this limitation.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">In LaTeX the same page geometry is used for all pages. The dimensions are
taken from the first page of your document.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Do not create headers and footers with more than one line of text,
these will not be exported correctly to LaTeX.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Background color</emph>: Background color is currently not supported
except in table cells. You should avoid using background color elsewhere.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Graphics</emph>: Anchor graphics to paragraph or to character if you
want a floating graphic. If you want the graphic to be a part of the text flow, anchor it to character. Do not anchor
graphics to page as this will make the graphics turn up the wrong place in your document.
You are advised not to wrap text around graphics as this is not exported to LaTeX anyway.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Also, do not use drawing objects inserted directly in the text (using the
Drawing toolbar). These will not be converted to LaTeX.
If you need to insert a drawing, insert an embedded Draw object (<emph>Insert - Object</emph>).</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>Tables</emph>: Avoid using cells spanning several rows, as this
is currently not supported. Cells spanning several columns are fully supported.</paragraph>
</listitem>
</list>
<paragraph role="paragraph" xml-lang="en-US">In general you should be aware that not all formatting is exported. The export of formatting
depends on the selected LaTeX format.</paragraph>
</body>
</helpdocument>

72
source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/menu.xhp
View file

@ -1,32 +1,68 @@
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<meta>
<topic id="writer4latex-menu" indexer="include">
<topic id="writer2latex-menu" indexer="include">
<title xml-lang="en-US">The LaTeX menu</title>
<filename>org.openoffice.da.writer4latex.oxt/menu.xhp</filename>
<filename>org.openoffice.da.writer2latex.oxt/menu.xhp</filename>
</topic>
</meta>
<body>
<paragraph role="heading" level="1" xml-lang="en-US">The LaTeX menu</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Writer4LaTeX offers the top level menu <emph>LaTeX</emph> in Writer
with the following commands.</paragraph>
<paragraph role="heading" level="1" xml-lang="en-US">Menu and toolbar</paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex:ProcessDocument" id="bm_processdocument"/>
<paragraph role="heading" level="2" xml-lang="en-US">Run LaTeX...</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Convert the document to LaTeX and display the result in an external viewer.
You can configure the export in the dialog.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex:ProcessDocument" visibility="hidden">Run LaTeX and display the result</ahelp></paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">Using Writer2LaTeX as an export filter</paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex:ProcessDirectly" id="bm_processdirectly"/>
<paragraph role="heading" level="2" xml-lang="en-US">Run LaTeX directly</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Convert the document to LaTeX and display the result in an external viewer.
This command does not display the configuration dialog, but reuses the last settings.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex:ProcessDirectly" visibility="hidden">Run LaTeX directly and display the result</ahelp></paragraph>
<paragraph role="heading" level="3" xml-lang="en-US"><link href="org.openoffice.da.writer2latex.oxt/export.xhp"
name="Export LaTeX files">File - Export</link></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer4latex:ViewLog" id="bm_viewlog"/>
<paragraph role="heading" level="2" xml-lang="en-US">View Log files</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Writer2xhtml adds two entries to the <emph>File - Export</emph>
menu in Writer</paragraph>
<list type="unordered">
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>LaTeX 2e [Writer2LaTeX]</emph> to export the
current document to LaTeX.</paragraph>
</listitem>
<listitem>
<paragraph role="paragraph" xml-lang="en-US"><emph>BibTeX [Writer2LaTeX]</emph> to export the
bibliographic references in the current document to BibTeX.</paragraph>
</listitem>
</list>
<paragraph role="heading" level="2" xml-lang="en-US">Using the Writer2LaTeX toolbar</paragraph>
<paragraph role="paragraph" xml-lang="en-US">The Writer2LaTeX toolbar office the following commands.</paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">Insert BibTeX reference</paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex:InsertBibTeX" id="bm_insertbibtex"/>
<paragraph role="paragraph" xml-lang="en-US">Insert a reference to an item in a BibTeX file.</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex:InsertBibTeX" visibility="hidden">Insert reference to an item in a BibTeX file</ahelp></paragraph>
<paragraph role="heading" level="3" xml-lang="en-US"><link href="org.openoffice.da.writer2latex.oxt/export.xhp"
name="Export LaTeX files">Publish to LaTeX</link></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex:ProcessDocument" id="bm_processdocument"/>
<paragraph role="paragraph" xml-lang="en-US">Convert the document to LaTeX, process the result with LaTeX
and display the result in an external viewer.</paragraph>
<paragraph role="paragraph" xml-lang="en-US">Before you can use this feature, you need to
<link href="org.openoffice.da.writer2latex.oxt/applications.xhp" name="Applications">configure</link>
the external applications to use.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex:ProcessDocument" visibility="hidden">Run LaTeX and display the result</ahelp></paragraph>
<paragraph role="heading" level="3" xml-lang="en-US">View Log files</paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex:ViewLog" id="bm_viewlog"/>
<paragraph role="paragraph" xml-lang="en-US">In case of any problems in the conversion process, you can view the log files created by
LaTeX, MakeIndex and BibTeX here</paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer4latex:ViewLog" visibility="hidden">View log files created by LaTeX, MakeIndex and BibTeX</ahelp></paragraph>
<paragraph role="paragraph" xml-lang="en-US"><ahelp hid="org.openoffice.da.writer2latex:ViewLog" visibility="hidden">View log files created by LaTeX, MakeIndex and BibTeX</ahelp></paragraph>
<paragraph role="heading" level="3" xml-lang="en-US"><link href="org.openoffice.da.writer2latex.oxt/Configuration/Documentclass.xhp"
name="Confguration">Edit custom format</link></paragraph>
<bookmark xml-lang="en-US" branch="hid/org.openoffice.da.writer2latex:EditCustomFormat" id="bm_editcustomformat"/>
<paragraph role="paragraph" xml-lang="en-US">Edit the custom export format. This format is used if you select
<emph>Custom</emph> as LaTeX format in the export dialog.</paragraph>
</body>
</helpdocument>

10
source/oxt/writer4latex/help/en/org.openoffice.da.writer4latex.oxt/templates.xhp
View file

@ -8,10 +8,20 @@
</meta>
<body>
<paragraph role="heading" level="1" xml-lang="en-US">Using the templates</paragraph>
<paragraph role="paragraph" xml-lang="en-US">You can use some special
Writer templates provided with Writer4LaTeX to
create your documents. Using the styles supported by these templates, you can easily create standard LaTeX documents
using the opportunities of standard LaTeX document classes.
</paragraph>
<paragraph role="paragraph" xml-lang="en-US">For this initial version, templates for the standard LaTeX classes article
are provided. More templates will be added later (report, book, beamer...), and you can also add your own templates.
</paragraph>
<paragraph role="heading" level="2" xml-lang="en-US">The article template</paragraph>
<section id="howtoget" xml-lang="en-US">
Choose <emph>File - New - Templates and Documents - Writer2LaTeX</emph>
</section>
<paragraph role="paragraph" xml-lang="en-US">This template contains a number of styles that corresponds to LaTeX code.
If you use these styles and makes sure to use the configuration <emph>W4L: Article</emph> when you convert your document
(this is selected automatically) with Writer2LaTeX, you will get a result that resembles a handwritten LaTeX file.