From 88c3a7295db2598666c4324236ee746fe0118637 Mon Sep 17 00:00:00 2001 From: henrikjust Date: Mon, 3 Nov 2014 07:55:41 +0000 Subject: [PATCH] Merge w4l int w2l - update help files git-svn-id: svn://svn.code.sf.net/p/writer2latex/code/trunk@202 f0f2a975-2e09-46c8-9428-3b39399b9f3c --- source/oxt/writer2latex/help/en/help.tree | 5 +- .../applications.xhp | 87 ++++++++-- .../bibliography.xhp | 52 +++--- .../guidelines.xhp | 48 ------ .../introduction.xhp | 162 ++++++++---------- .../menu.xhp | 72 ++++++-- .../templates.xhp | 10 ++ 7 files changed, 235 insertions(+), 201 deletions(-) delete mode 100644 source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/guidelines.xhp diff --git a/source/oxt/writer2latex/help/en/help.tree b/source/oxt/writer2latex/help/en/help.tree index c651fc9..c0c5e5d 100644 --- a/source/oxt/writer2latex/help/en/help.tree +++ b/source/oxt/writer2latex/help/en/help.tree @@ -2,10 +2,9 @@ Introduction - Menu reference - Guidelines + Menu and toolbar LaTeX Export - + Applications Bibliography diff --git a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/applications.xhp b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/applications.xhp index bd34fb0..faceda0 100644 --- a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/applications.xhp +++ b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/applications.xhp @@ -1,28 +1,81 @@ - + Applications - org.openoffice.da.writer4latex.oxt/applications.xhp + org.openoffice.da.writer2latex.oxt/applications.xhp - + Configuration of applications - Before you can use Writer4LaTeX you must configure it to use your LaTeX + Before you can use Writer2LaTeX you must configure it to use your LaTeX distribution as well as viewers for the different output formats.
- Select Tools - Options - %PRODUCTNAME Writer - Writer4LaTeX - Applications + Select Tools - Options - %PRODUCTNAME Writer - Writer2LaTeX toolbar - Applications
- - Automatic Configuration - 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. - Click here to let Writer4LaTeX configure your external applications automatically + Prerequisites + This requires that you have installed certain software on your system. + + + + + Writer2LaTeX needs a working LaTeX distribution. + MikTeX is recommended and can be downloaded from + http://www.miktex.org. + + + In addition, you should install viewers for PDF and PostScript files. + Gsview is recommended and can be downloaded from + http://pages.cs.wisc.edu/~ghost/gsview/. + Note that you have to install ghostscript as well (follow the links on the web site). + + + + + + + Writer2LaTeX needs a working LaTeX distribution. + TeX live + 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: + sudo apt-get install texlive +
sudo apt-get install texlive-latex-extra +
sudo apt-get install texlive-xetex + + + + 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. + + + + + + + + Writer2LaTeX needs a working LaTeX distribution. + + + + Also you should install viewers for DVI, PDF and PostScript files. + + + + Note: The Writer2LaTeX toolbar is not tested on Mac OS X. + + - + + Automatic Configuration + 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. + Click here to let Writer2LaTeX configure your external applications automatically + + Application Select the external application you wish to configure in the list. The available applications are: @@ -52,18 +105,18 @@ PostScript Viewer: Application to view PostScript files - Select the external application you wish to configure here + Select the external application you wish to configure here - + Executable Type the full path to the executable or click Browse to find the executable in your file system - Type the full path to the executable here or find it using the Browse button + Type the full path to the executable here or find it using the Browse button - + Options Fill out any additional options here. Often you will only need the file name, which is denoted %s. - Fill out any additional options here, using %s to represent the file name + Fill out any additional options here, using %s to represent the file name \ No newline at end of file diff --git a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/bibliography.xhp b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/bibliography.xhp index 5f7f320..54732f9 100644 --- a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/bibliography.xhp +++ b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/bibliography.xhp @@ -1,39 +1,39 @@ - + Bibliography - org.openoffice.da.writer4latex.oxt/bibliography.xhp + org.openoffice.da.writer2latex.oxt/bibliography.xhp - + Configuration of bibliography - On this page you can define the interaction between Writer4LaTeX and + On this page you can define the interaction between Writer2LaTeX and external bibliographic tools.
- Select Tools - Options - %PRODUCTNAME Writer - Writer4LaTeX - Bibliography + Select Tools - Options - %PRODUCTNAME Writer - Writer2LaTeX toolbar - Bibliography
Citations and BibTeX files 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. 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. - + Use external BibTeX files for ordinary citations 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.) 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. - Check this if your citations refer to external BibTeX file(s) + Check this if your citations refer to external BibTeX file(s) - + Convert Zotero citations Zotero is a free, easy-to-use tool to help you collect, organize, cite, and share your research sources. @@ -55,9 +55,9 @@ You can now export your Zotero database: In Zotero, select Export Library, and choose BibTeX (Writer2LaTeX) (not BibTeX). Save the file in the folder, you have defined. - Check this to convert Zotero citations to LaTeX + Check this to convert Zotero citations to LaTeX - + Convert JabRef citations JabRef 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. - Check this to convert JabRef citations to LaTeX + Check this to convert JabRef citations to LaTeX - + Include original citations as comments 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. - Check this to include the citations inserted by Zotero or JabRef as comments in the LaTeX source. + Check this to include the citations inserted by Zotero or JabRef as comments in the LaTeX source. - + BibTeX location - Writer4LaTeX will look for BibTeX files in the location you define. + Writer2LaTeX will look for BibTeX files in the location you define. In central folder: 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). - Select the type of location for your BibTeX files + Select the type of location for your BibTeX files - + BibTeX folder Enter the path to the folder containing your BibTeX files, or select the folder using the Browse-button. - Enter the path to the folder containing the BibTeX files + Enter the path to the folder containing the BibTeX files - - Click to select the path to the folder containing the BibTeX files + + Click to select the path to the folder containing the BibTeX files Natbib - + Use natbib.sty 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). - Check this to use the package natbib.sty for your citations + Check this to use the package natbib.sty for your citations - + Options Enter any options to the package natbib.sty here. - Enter any options to the package natbib.sty here + Enter any options to the package natbib.sty here diff --git a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/guidelines.xhp b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/guidelines.xhp deleted file mode 100644 index b76ac2c..0000000 --- a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/guidelines.xhp +++ /dev/null @@ -1,48 +0,0 @@ - - - - - Guidelines - org.openoffice.da.writer4latex.oxt/guidelines.xhp - - - - Guidelines - Not every feature in %PRODUCTNAME Writer is supported by LaTeX. To avoid unexpected - results follow these guidelines. - - - Page styles: %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 - Insert - Manual break is not affected by this limitation. - In LaTeX the same page geometry is used for all pages. The dimensions are - taken from the first page of your document. - Do not create headers and footers with more than one line of text, - these will not be exported correctly to LaTeX. - - - Background color: Background color is currently not supported - except in table cells. You should avoid using background color elsewhere. - - - Graphics: 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. - 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 (Insert - Object). - - - Tables: Avoid using cells spanning several rows, as this - is currently not supported. Cells spanning several columns are fully supported. - - - In general you should be aware that not all formatting is exported. The export of formatting - depends on the selected LaTeX format. - - \ No newline at end of file diff --git a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/introduction.xhp b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/introduction.xhp index cb4fb8b..5f53447 100644 --- a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/introduction.xhp +++ b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/introduction.xhp @@ -1,48 +1,44 @@ - + Introduction - org.openoffice.da.writer4latex.oxt/introduction.xhp + org.openoffice.da.writer2latex.oxt/introduction.xhp - Introduction to Writer4LaTeX + Introduction to Writer2LaTeX - 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 - LyX. - - - Authoring LaTeX files with Writer4LaTeX - You can use Writer4LaTeX in two different ways - + 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. + Writer2LaTeX has two modes of operation - You can prepare your documents with Writer as you usually do, - keeping a few - guidelines 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. - - - - 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. - - 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. + You can use Writer2LaTeX as an export filter. + It adds LaTeX and BibTeX export to the File - Export + menu. - + + + You can use Writer as a frontend for LaTeX. + It adds a + toolbar + to interact with your LaTeX installation. + The functionality of %PRODUCTNAME Writer with + the Writer2LaTeX toolbar can be compared to the application + LyX. + + Before you can use the Writer2LaTeX toolbar, you need to + configure it. + + - + - Before you start - Before you can use Writer4LaTeX, you need to - configure it. - This requires that you have installed certain software on your system. - - - - - The LaTeX export filter Writer2LaTeX must be installed in %PRODUCTNAME. - You can get this extension at - http://extensions.services.openoffice.org/project/writer2latex. - - - Writer4LaTeX needs a working LaTeX distribution. - MikTeX is recommended and can be downloaded from - http://www.miktex.org. - - - Finally you should install viewers for PDF and PostScript files. - Gsview is recommended and can be downloaded from - http://pages.cs.wisc.edu/~ghost/gsview/. - Note that you have to install ghostscript as well (follow the links on the web site). - - - - - - - The LaTeX export filter Writer2LaTeX must be installed in %PRODUCTNAME. - You can get this extension at - http://extensions.services.openoffice.org/project/writer2latex. - - - Writer4LaTeX needs a working LaTeX distribution. - TeX live - 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: - sudo apt-get install texlive -
sudo apt-get install texlive-latex-extra -
sudo apt-get install texlive-xetex - - - - 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. - - - - - - 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. - You also need to install the LaTeX export filter Writer2LaTeX - in %PRODUCTNAME. You can get this extension at - http://extensions.services.openoffice.org/project/writer2latex. - - + Authoring LaTeX files with Writer2LaTeX + 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. + + + Guidelines + Not every feature in %PRODUCTNAME Writer is supported by LaTeX. + To avoid unexpected results follow these guidelines. + + + Page styles: %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 + Insert - Manual break is not affected by this limitation. + In LaTeX the same page geometry is used for all pages. The dimensions are + taken from the first page of your document. + Do not create headers and footers with more than one line of text, + these will not be exported correctly to LaTeX. + + + Background color: Background color is currently not supported + except in table cells. You should avoid using background color elsewhere. + + + Graphics: 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. + 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 (Insert - Object). + + + Tables: Avoid using cells spanning several rows, as this + is currently not supported. Cells spanning several columns are fully supported. + + + In general you should be aware that not all formatting is exported. The export of formatting + depends on the selected LaTeX format. \ No newline at end of file diff --git a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/menu.xhp b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/menu.xhp index 7604af6..8f1a1b8 100644 --- a/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/menu.xhp +++ b/source/oxt/writer2latex/help/en/org.openoffice.da.writer2latex.oxt/menu.xhp @@ -1,32 +1,68 @@ - + The LaTeX menu - org.openoffice.da.writer4latex.oxt/menu.xhp + org.openoffice.da.writer2latex.oxt/menu.xhp - The LaTeX menu - Writer4LaTeX offers the top level menu LaTeX in Writer - with the following commands. + Menu and toolbar - - Run LaTeX... - Convert the document to LaTeX and display the result in an external viewer. - You can configure the export in the dialog. - Run LaTeX and display the result + Using Writer2LaTeX as an export filter - - Run LaTeX directly - 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. - Run LaTeX directly and display the result + File - Export - - View Log files + Writer2xhtml adds two entries to the File - Export + menu in Writer + + + LaTeX 2e [Writer2LaTeX] to export the + current document to LaTeX. + + + BibTeX [Writer2LaTeX] to export the + bibliographic references in the current document to BibTeX. + + + + Using the Writer2LaTeX toolbar + + The Writer2LaTeX toolbar office the following commands. + + Insert BibTeX reference + + + Insert a reference to an item in a BibTeX file. + Insert reference to an item in a BibTeX file + + Publish to LaTeX + + + Convert the document to LaTeX, process the result with LaTeX + and display the result in an external viewer. + Before you can use this feature, you need to + configure + the external applications to use. + + + Run LaTeX and display the result + + View Log files + + In case of any problems in the conversion process, you can view the log files created by LaTeX, MakeIndex and BibTeX here - View log files created by LaTeX, MakeIndex and BibTeX + View log files created by LaTeX, MakeIndex and BibTeX + + Edit custom format + + + Edit the custom export format. This format is used if you select + Custom as LaTeX format in the export dialog. + \ No newline at end of file diff --git a/source/oxt/writer4latex/help/en/org.openoffice.da.writer4latex.oxt/templates.xhp b/source/oxt/writer4latex/help/en/org.openoffice.da.writer4latex.oxt/templates.xhp index af7e51b..47a350d 100644 --- a/source/oxt/writer4latex/help/en/org.openoffice.da.writer4latex.oxt/templates.xhp +++ b/source/oxt/writer4latex/help/en/org.openoffice.da.writer4latex.oxt/templates.xhp @@ -8,10 +8,20 @@ Using the templates + 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. + + 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. + + The article template
Choose File - New - Templates and Documents - Writer2LaTeX
+ This template contains a number of styles that corresponds to LaTeX code. If you use these styles and makes sure to use the configuration W4L: Article when you convert your document (this is selected automatically) with Writer2LaTeX, you will get a result that resembles a handwritten LaTeX file.