Menu
▾
▴
plplot-cvs
|
From: <ai...@us...> - 2008-09-10 17:22:00
|
Revision: 8768
http://plplot.svn.sourceforge.net/plplot/?rev=8768&view=rev
Author: airwin
Date: 2008-09-10 17:22:11 +0000 (Wed, 10 Sep 2008)
Log Message:
-----------
Integrate Ada documentation into our overall PLplot documentation. The result
validates and produces reasonable looking html, but is still a little rough
(e.g., heading numbers are screwed up) so needs more work.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2008-09-10 17:20:16 UTC (rev 8767)
+++ trunk/doc/docbook/src/CMakeLists.txt 2008-09-10 17:22:11 UTC (rev 8768)
@@ -31,6 +31,7 @@
set(
SOURCE_FILES
+${CMAKE_CURRENT_SOURCE_DIR}/ada.xml
${CMAKE_CURRENT_SOURCE_DIR}/advanced.xml
${CMAKE_CURRENT_SOURCE_DIR}/api.xml
${CMAKE_CURRENT_SOURCE_DIR}/api-c.xml
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-09-10 17:20:16 UTC (rev 8767)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-09-10 17:22:11 UTC (rev 8768)
@@ -50,15 +50,16 @@
<!ENTITY chap-advanced SYSTEM "advanced.xml">
<!ENTITY chap-deploying SYSTEM "deploying.xml">
<!ENTITY chap-drivers SYSTEM "drivers.xml">
+<!ENTITY chap-ada SYSTEM "ada.xml">
<!ENTITY chap-c SYSTEM "c.xml">
+<!ENTITY chap-cplus SYSTEM "cplus.xml">
+<!ENTITY chap-fortran77 SYSTEM "fortran77.xml">
<!ENTITY chap-fortran95 SYSTEM "fortran95.xml">
-<!ENTITY chap-fortran77 SYSTEM "fortran77.xml">
-<!ENTITY chap-cplus SYSTEM "cplus.xml">
+<!ENTITY chap-perl SYSTEM "perl.xml">
+<!ENTITY chap-python SYSTEM "python.xml">
<!ENTITY chap-tcl SYSTEM "tcl.xml">
<!ENTITY chap-wish SYSTEM "wish.xml">
<!ENTITY chap-gui SYSTEM "gui.xml">
-<!ENTITY chap-perl SYSTEM "perl.xml">
-<!ENTITY chap-python SYSTEM "python.xml">
<!ENTITY chap-bibliography SYSTEM "bibliography.xml">
<!ENTITY chap-api SYSTEM "api.xml">
<!ENTITY chap-api-c SYSTEM "api-c.xml">
@@ -372,15 +373,16 @@
<part>
<title> Language Bindings </title>
+ &chap-ada;
&chap-c;
+ &chap-cplus;
+ &chap-fortran77;
&chap-fortran95;
- &chap-fortran77;
- &chap-cplus;
+ &chap-perl;
+ &chap-python;
&chap-tcl;
&chap-wish;
&chap-gui;
- &chap-perl;
- &chap-python;
</part>
<part>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2008-09-25 22:42:47
|
Revision: 8826
http://plplot.svn.sourceforge.net/plplot/?rev=8826&view=rev
Author: airwin
Date: 2008-09-25 22:42:37 +0000 (Thu, 25 Sep 2008)
Log Message:
-----------
Apply id attributes to <part> tags and complete the id attributes for all
<sect1> tags to replace the remaining "numerical" (e.g., "x13759.html")
html file names with meaningful names.
Modified Paths:
--------------
trunk/doc/docbook/src/api-compat.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api-compat.xml
===================================================================
--- trunk/doc/docbook/src/api-compat.xml 2008-09-25 22:37:50 UTC (rev 8825)
+++ trunk/doc/docbook/src/api-compat.xml 2008-09-25 22:42:37 UTC (rev 8826)
@@ -53,7 +53,7 @@
PLplot, released on &Release-Date;.
</para>
- <sect1>
+ <sect1 id="api_definition">
<title>
What is in the API?
</title>
@@ -84,7 +84,7 @@
</sect1>
- <sect1>
+ <sect1 id="api_regression_tests">
<title>
Regression test for backwards compatibility
</title>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-09-25 22:37:50 UTC (rev 8825)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-09-25 22:42:37 UTC (rev 8826)
@@ -358,12 +358,12 @@
<toc></toc>
<!-- <lot></lot> -->
- <part>
+ <part id="part_introduction">
<title> Introduction </title>
&chap-intro;
</part>
- <part>
+ <part id="part_programming">
<title> Programming </title>
&chap-simple;
&chap-advanced;
@@ -371,7 +371,7 @@
&chap-drivers;
</part>
- <part>
+ <part id="part_bindings">
<title> Language Bindings </title>
&chap-ada;
&chap-c;
@@ -385,7 +385,7 @@
&chap-gui;
</part>
- <part>
+ <part id="part_reference">
<title> Reference </title>
&chap-bibliography;
&chap-api;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-08-21 22:10:55
|
Revision: 12494
http://sourceforge.net/p/plplot/code/12494
Author: airwin
Date: 2013-08-21 22:10:51 +0000 (Wed, 21 Aug 2013)
Log Message:
-----------
Implement XSL configuration method for print results for the default
-DDOCBOOK_XML_BACKEND=ON case. Use this configuration method to
establish ansi style for funcsynopsis for pdf and ps results.
Tested by Alan W. Irwin <ai...@us...> using
the -DBUILD_DOC=ON cmake option and the pdf_target target.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
Added Paths:
-----------
trunk/doc/docbook/src/plplotdoc-print.xsl.in
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2013-08-21 21:18:36 UTC (rev 12493)
+++ trunk/doc/docbook/src/CMakeLists.txt 2013-08-21 22:10:51 UTC (rev 12494)
@@ -350,9 +350,18 @@
)
if(BUILD_PRINT)
+ # Custom commands for building html version of documentation
+ set(STYLESHEET_PRINT ${PLPLOTDOC}-print.xsl)
+ set(STYLESHEET_PRINT_IN ${STYLESHEET_PRINT}.in)
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_PRINT_IN}
+ ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
+ @ONLY
+ )
+
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps.gz
- COMMAND ${XMLTO} -vv --with-fop ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+ COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} ps ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.ps ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.ps
COMMAND ${GZIP} -f ${BASE}.ps
DEPENDS
@@ -379,7 +388,7 @@
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
- COMMAND ${XMLTO} -vv --with-fop pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+ COMMAND ${XMLTO} -vv --with-fop -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT} pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.pdf ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
DEPENDS
${SOURCE_FILES}
Added: trunk/doc/docbook/src/plplotdoc-print.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-print.xsl.in (rev 0)
+++ trunk/doc/docbook/src/plplotdoc-print.xsl.in 2013-08-21 22:10:51 UTC (rev 12494)
@@ -0,0 +1,54 @@
+<?xml version='1.0'?>
+<!--
+ plplotdoc-print.xsl.in: XSL customization for the HTML PLplot docs
+
+ Copyright (C) 2013 Alan W. Irwin
+
+ Redistribution and use in source (XML DocBook) and "compiled" forms
+ (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ 1. Redistributions of source code (XML DocBook) must retain the
+ above copyright notice, this list of conditions and the following
+ disclaimer as the first lines of this file unmodified.
+
+ 2. Redistributions in compiled form (transformed to other DTDs,
+ converted to HTML, PDF, PostScript, and other formats) must
+ reproduce the above copyright notice, this list of conditions and
+ the following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+ Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+-->
+<!--
+These ideas for customizing the PLplot html documentation are adapted
+from
+http://www.sagehill.net/docbookxsl/CustomMethods.html#CustomizationLayer
+http://www.sagehill.net/docbookxsl/SettingParams.html
+http://www.sagehill.net/docbookxsl/Chunking.html#ChunkFilenames
+http://www.sagehill.net/docbookxsl/UsingCSS.html
+http://www.sagehill.net/docbookxsl/Parameters.html
+http://docbook.sourceforge.net/release/xsl/current/doc/html/
+....
+-->
+<xsl:stylesheet
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:fo="http://www.w3.org/1999/XSL/Format"
+ version="1.0">
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"/>
+
+<xsl:param name="funcsynopsis.style" select="'ansi'"/>
+
+</xsl:stylesheet>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2014-01-29 02:28:00
|
Revision: 12971
http://sourceforge.net/p/plplot/code/12971
Author: airwin
Date: 2014-01-29 02:27:57 +0000 (Wed, 29 Jan 2014)
Log Message:
-----------
Make remaining changes to bring api.xml into complete consistency with
plplot.h according to the new check_api_xml_consistency target that I
developed for our build system that was based on H?\199?\142ili?\195?\160ng W?\195?\161ng's
"check" application that was written in the Go language.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2014-01-29 02:23:42 UTC (rev 12970)
+++ trunk/doc/docbook/src/api.xml 2014-01-29 02:27:57 UTC (rev 12971)
@@ -2347,7 +2347,7 @@
<varlistentry>
<term>
<parameter>labels</parameter>
- (<literal>const char *const *</literal>, input)
+ (<literal>const char * const *</literal>, input)
</term>
<listitem>
<para>
@@ -2378,7 +2378,7 @@
<varlistentry>
<term>
<parameter>axis_opts</parameter>
- (<literal>const char *const *</literal>, input)
+ (<literal>const char * const *</literal>, input)
</term>
<listitem>
<para>
@@ -2427,7 +2427,7 @@
<varlistentry>
<term>
<parameter>values</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -2741,7 +2741,7 @@
<varlistentry>
<term>
<parameter>f</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -6988,7 +6988,7 @@
<varlistentry>
<term>
<parameter>idata</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -7148,7 +7148,7 @@
<varlistentry>
<term>
<parameter>idata</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -7808,7 +7808,7 @@
<varlistentry>
<term>
<parameter>text</parameter>
- (<literal>const char *const *</literal>, input)
+ (<literal>const char * const *</literal>, input)
</term>
<listitem>
<para>
@@ -7940,7 +7940,7 @@
<varlistentry>
<term>
<parameter>symbols</parameter>
- (<literal>const char *const *</literal>, input)
+ (<literal>const char * const *</literal>, input)
</term>
<listitem>
<para>
@@ -8610,7 +8610,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -8752,7 +8752,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -9327,7 +9327,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -9485,7 +9485,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -9696,7 +9696,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>const PLFLT *const *</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -13667,7 +13667,7 @@
<varlistentry>
<term>
<parameter>a</parameter>
- (<literal>PLFLT **</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -13768,7 +13768,7 @@
<varlistentry>
<term>
<parameter>clevel</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -13831,7 +13831,7 @@
<varlistentry>
<term>
<parameter>fill</parameter>
- (<literal>void (*) (PLINT, PLFLT *, PLFLT *)</literal>, input)
+ (<literal>void (*) (PLINT, const PLFLT *, const PLFLT *)</literal>, input)
</term>
<listitem>
<para>
@@ -13969,7 +13969,7 @@
<varlistentry>
<term>
<parameter>a</parameter>
- (<literal>PLFLT **</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -14139,7 +14139,7 @@
<varlistentry>
<term>
<parameter>fill</parameter>
- (<literal>void (*) (PLINT, PLFLT *, PLFLT *)</literal>, input)
+ (<literal>void (*) (PLINT, const PLFLT *, const PLFLT *)</literal>, input)
</term>
<listitem>
<para>
@@ -14257,7 +14257,7 @@
<varlistentry>
<term>
<parameter>a</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -14480,7 +14480,7 @@
<varlistentry>
<term>
<parameter>fill</parameter>
- (<literal>void (*) (PLINT, PLFLT *, PLFLT *)</literal>, input)
+ (<literal>void (*) (PLINT, const PLFLT *, const PLFLT *)</literal>, input)
</term>
<listitem>
<para>
@@ -14599,7 +14599,7 @@
<varlistentry>
<term>
<parameter>label_func</parameter>
- (<literal>void (*) (PLINT, PLFLT, char *, PLINT, void *)</literal>, input)
+ (<literal>void (*) (PLINT, PLFLT, char *, PLINT, PLPointer)</literal>, input)
</term>
<listitem>
<para>
@@ -14651,7 +14651,7 @@
<varlistentry>
<term>
<parameter>label_data</parameter>
- (<literal>void *</literal>, input)
+ (<literal>PLPointer</literal>, input)
</term>
<listitem>
<para>
@@ -15152,10 +15152,10 @@
<sect1 id="plspal1" renderas="sect3">
<title>
- <function>plspal1</function>: Set the colors for color table 1
- from a cmap1 file
+ <function>plspal1</function>: Set the palette for cmap1
+ using the specified cmap1*.pal format file
</title>
-
+
<para>
<funcsynopsis>
<funcprototype>
@@ -15163,12 +15163,13 @@
<function>plspal1</function>
</funcdef>
<paramdef><parameter>filename</parameter></paramdef>
+ <paramdef><parameter>interpolate</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</para>
<para>
- Set the colors for color table 1 from a cmap1 file
+ Set the palette for cmap1 using the specified cmap1*.pal format file.
</para>
<variablelist>
@@ -15179,19 +15180,42 @@
</term>
<listitem>
<para>
- The name of the cmap1 file, or a empty to string to
- specify the default cmap1 file.
+ The name of the cmap1*.pal file, or an empty string to
+ specify the default cmap1.pal file.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>interpolate</parameter>
+ (<literal>PLBOOL</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ If this parameter is true, the columns containing the
+ intensity index, r, g, b, alpha and
+ alt_hue_path in the cmap1*.pal file are used to set
+ the cmap1 palette with a call to &plscmap1la;.
+ (The cmap1*.pal header contains a flag which controls
+ whether the r, g, b data sent to &plscmap1la; are
+ interpreted as HLS or RGB.)
+ </para>
+ <para>
+ If this parameter is false, the intensity index and alt_hue_path columns
+ are ignored and the r, g, b (interpreted as RGB), and alpha columns of the
+ cmap1*.pal file are used instead to set the cmap1 palette directly
+ with a call to &plscmap1a;.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>
- Redacted form: <function>plspal1(filename)</function>
+ Redacted form: <function>plspal1(filename, interpolate)</function>
</para>
<para>
- This function is in example 16.
+ This function is used in example 16.
</para>
</sect1>
@@ -15482,7 +15506,7 @@
<funcdef>
<function>plstart</function>
</funcdef>
- <paramdef><parameter>device</parameter></paramdef>
+ <paramdef><parameter>devname</parameter></paramdef>
<paramdef><parameter>nx</parameter></paramdef>
<paramdef><parameter>ny</parameter></paramdef>
</funcprototype>
@@ -15491,12 +15515,12 @@
<para>
Alternative to &plstar; for initializing the plotting package. The
- <literal><parameter>device</parameter></literal> name keyword for the
- desired output device must be supplied as an argument. The device
+ device name keyword for the
+ desired output device must be supplied as an argument. These
keywords are the same as those printed out by &plstar;. If the
requested device is not available, or if the input string is empty or
begins with ``?'', the prompted start up of &plstar; is used. This
- routine also divides the output device into
+ routine also divides the output device page into
<literal><parameter>nx</parameter></literal> by
<literal><parameter>ny</parameter></literal> subpages, each of which
may be used independently. The subroutine &pladv; is used to advance
@@ -15506,12 +15530,12 @@
<variablelist>
<varlistentry>
<term>
- <parameter>device</parameter>
+ <parameter>devname</parameter>
(<literal>const char *</literal>, input)
</term>
<listitem>
<para>
- Device name (keyword) of the required output device. If NULL
+ Device name keyword of the required output device. If NULL
or if the first character is a ``?'', the normal (prompted)
start up is used.
</para>
@@ -15548,12 +15572,12 @@
<itemizedlist>
<listitem>
<para>
- General: <function>plstart(device, nx, ny)</function>
+ General: <function>plstart(devname, nx, ny)</function>
</para>
</listitem>
<listitem>
<para>
- Perl/PDL: <function>plstart(nx, ny, device)</function>
+ Perl/PDL: <function>plstart(nx, ny, devname)</function>
</para>
</listitem>
</itemizedlist>
@@ -15577,27 +15601,28 @@
<funcdef>
<function>plstransform</function>
</funcdef>
- <paramdef><parameter>transform_fun</parameter></paramdef>
- <paramdef><parameter>data</parameter></paramdef>
+ <paramdef><parameter>coordinate_transform</parameter></paramdef>
+ <paramdef><parameter>coordinate_transform_data</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</para>
<para>
- This function can be used to define a coordinate transformation which
- affects all elements drawn within the current plot window. The
- transformation function is similar to that provided for the &plmap;
- and &plmeridians; functions. The
- <literal><parameter>data</parameter></literal> parameter may be used to
- pass extra data to
- <literal><parameter>transform_fun</parameter></literal>.
+ This function can be used to define a coordinate transformation
+ which affects all elements drawn within the current plot window.
+ The <literal><parameter>coordinate_transform</parameter></literal>
+ function is similar to that provided for the &plmap; and
+ &plmeridians; functions. The
+ <literal><parameter>coordinate_transform_data</parameter></literal>
+ parameter may be used to pass extra data to
+ <literal><parameter>coordinate_transform</parameter></literal>.
</para>
<variablelist>
<varlistentry>
<term>
- <parameter>transform_fun</parameter>
- (<literal>void (*) (PLFLT, PLFLT, PLFLT*, PLFLT*, PLPointer)
+ <parameter>coordinate_transform</parameter>
+ (<literal>void (*) (PLFLT, PLFLT, PLFLT *, PLFLT *, PLPointer)
</literal>, input)
</term>
<listitem>
@@ -15610,13 +15635,13 @@
</varlistentry>
<varlistentry>
<term>
- <parameter>data</parameter>
+ <parameter>coordinate_transform_data</parameter>
(<literal>PLPointer</literal>, input)
</term>
<listitem>
<para>
Optional extra data for
- <parameter><literal>transform_fun</literal></parameter>.
+ <parameter><literal>coordinate_transform</literal></parameter>.
</para>
</listitem>
</varlistentry>
@@ -15627,7 +15652,7 @@
<itemizedlist>
<listitem>
<para>
- General: <function>plstransform(transform_fun, data)</function>
+ General: <function>plstransform(coordinate_transform, coordinate_transform_data)</function>
</para>
</listitem>
</itemizedlist>
@@ -15687,7 +15712,7 @@
<varlistentry>
<term>
<parameter>x</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -15698,7 +15723,7 @@
<varlistentry>
<term>
<parameter>y</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -15782,7 +15807,7 @@
<varlistentry>
<term>
<parameter>x</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -15793,7 +15818,7 @@
<varlistentry>
<term>
<parameter>y</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -15804,7 +15829,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -15849,7 +15874,7 @@
<function>plstripa</function>
</funcdef>
<paramdef><parameter>id</parameter></paramdef>
- <paramdef><parameter>p</parameter></paramdef>
+ <paramdef><parameter>pen</parameter></paramdef>
<paramdef><parameter>x</parameter></paramdef>
<paramdef><parameter>y</parameter></paramdef>
</funcprototype>
@@ -15872,13 +15897,13 @@
</term>
<listitem>
<para>
- Identification number (set up in &plstripc;) of the strip chart.
+ Identification number of the strip chart (set up in &plstripc;).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <parameter>p</parameter>
+ <parameter>pen</parameter>
(<literal>PLINT</literal>, input)
</term>
<listitem>
@@ -15912,7 +15937,7 @@
</variablelist>
<para>
- Redacted form: <function>plstripa(id, p, x, y)</function>
+ Redacted form: <function>plstripa(id, pen, x, y)</function>
</para>
<para>
@@ -15975,7 +16000,7 @@
<varlistentry>
<term>
<parameter>xspec</parameter>
- (<literal>char *</literal>, input)
+ (<literal>const char *</literal>, input)
</term>
<listitem>
<para>
@@ -15986,7 +16011,7 @@
<varlistentry>
<term>
<parameter>yspec</parameter>
- (<literal>char *</literal>, input)
+ (<literal>const char *</literal>, input)
</term>
<listitem>
<para>
@@ -16128,7 +16153,7 @@
<varlistentry>
<term>
<parameter>colline</parameter>
- (<literal>PLINT *</literal>, input)
+ (<literal>const PLINT *</literal>, input)
</term>
<listitem>
<para>
@@ -16139,7 +16164,7 @@
<varlistentry>
<term>
<parameter>styline</parameter>
- (<literal>PLINT *</literal>, input)
+ (<literal>const PLINT *</literal>, input)
</term>
<listitem>
<para>
@@ -16150,7 +16175,7 @@
<varlistentry>
<term>
<parameter>legline</parameter>
- (<literal>char **</literal>, input)
+ (<literal>const char **</literal>, input)
</term>
<listitem>
<para>
@@ -16161,7 +16186,7 @@
<varlistentry>
<term>
<parameter>labx</parameter>
- (<literal>char *</literal>, input)
+ (<literal>const char *</literal>, input)
</term>
<listitem>
<para>
@@ -16172,7 +16197,7 @@
<varlistentry>
<term>
<parameter>laby</parameter>
- (<literal>char *</literal>, input)
+ (<literal>const char *</literal>, input)
</term>
<listitem>
<para>
@@ -16183,7 +16208,7 @@
<varlistentry>
<term>
<parameter>labtop</parameter>
- (<literal>char *</literal>, input)
+ (<literal>const char *</literal>, input)
</term>
<listitem>
<para>
@@ -16271,7 +16296,7 @@
<funcdef>
<function>plstyl</function>
</funcdef>
- <paramdef><parameter>nels</parameter></paramdef>
+ <paramdef><parameter>nms</parameter></paramdef>
<paramdef><parameter>mark</parameter></paramdef>
<paramdef><parameter>space</parameter></paramdef>
</funcprototype>
@@ -16285,16 +16310,16 @@
<literal><parameter>mark</parameter></literal> and
<literal><parameter>space</parameter></literal> respectively. The
number of mark-space pairs is specified by
- <literal><parameter>nels</parameter></literal>. In order to return
+ <literal><parameter>nms</parameter></literal>. In order to return
the line style to the default continuous line, &plstyl; should be
- called with <literal><parameter>nels</parameter>=0</literal>.(see
+ called with <literal><parameter>nms</parameter>=0</literal>.(see
also &pllsty;)
</para>
<variablelist>
<varlistentry>
<term>
- <parameter>nels</parameter>
+ <parameter>nms</parameter>
(<literal>PLINT</literal>, input)
</term>
<listitem>
@@ -16302,16 +16327,16 @@
The number of <literal><parameter>mark</parameter></literal>
and <literal><parameter>space</parameter></literal> elements in
a line. Thus a simple broken line can be obtained by setting
- <literal><parameter>nels</parameter>=1</literal>. A continuous
+ <literal><parameter>nms</parameter>=1</literal>. A continuous
line is specified by setting
- <literal><parameter>nels</parameter>=0</literal>.
+ <literal><parameter>nms</parameter>=0</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mark</parameter>
- (<literal>PLINT *</literal>, input)
+ (<literal>const PLINT *</literal>, input)
</term>
<listitem>
<para>
@@ -16323,7 +16348,7 @@
<varlistentry>
<term>
<parameter>space</parameter>
- (<literal>PLINT *</literal>, input)
+ (<literal>const PLINT *</literal>, input)
</term>
<listitem>
<para>
@@ -16384,7 +16409,7 @@
<varlistentry>
<term>
<parameter>x</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16396,7 +16421,7 @@
<varlistentry>
<term>
<parameter>y</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16408,7 +16433,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>PLFLT **</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -16496,7 +16521,7 @@
<varlistentry>
<term>
<parameter>clevel</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16574,7 +16599,7 @@
<varlistentry>
<term>
<parameter>x</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16586,7 +16611,7 @@
<varlistentry>
<term>
<parameter>y</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16598,7 +16623,7 @@
<varlistentry>
<term>
<parameter>z</parameter>
- (<literal>PLFLT **</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
@@ -16685,7 +16710,7 @@
<varlistentry>
<term>
<parameter>clevel</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16735,7 +16760,7 @@
<varlistentry>
<term>
<parameter>indexymin</parameter>
- (<literal>PLINT *</literal>, input)
+ (<literal>const PLINT *</literal>, input)
</term>
<listitem>
<para>
@@ -16754,7 +16779,7 @@
<varlistentry>
<term>
<parameter>indexymax</parameter>
- (<literal>PLINT *</literal>, input)
+ (<literal>const PLINT *</literal>, input)
</term>
<listitem>
<para>
@@ -16812,7 +16837,7 @@
<para>
Plots a three dimensional shaded surface plot within the environment set up
by &plw3d;. The surface is defined by the data contained in the 2D
- <literal>PLFLT **</literal> matrix or the <literal>PLfGrid2</literal> structure
+ <literal>const PLFLT * const *</literal> matrix or the <literal>PLfGrid2</literal> structure
<literal><parameter>zp</parameter></literal>. How the data in
<literal><parameter>zp</parameter></literal> is rendered is determined by the
<literal><parameter>zops</parameter></literal> parameter.
@@ -16821,7 +16846,7 @@
PLplot core will return an appropriate function pointer:
<literal>plf2ops_c()</literal> (use when
<literal><parameter>zp</parameter></literal> is of type
- <literal>PLFLT **</literal>),
+ <literal>const PLFLT * const *</literal>),
<literal>plf2ops_grid_c()</literal> (use when
<literal><parameter>zp</parameter></literal>
is a pointer to a row-major <literal>PLfGrid2</literal> structure),
@@ -16842,7 +16867,7 @@
<varlistentry>
<term>
<parameter>x</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16854,7 +16879,7 @@
<varlistentry>
<term>
<parameter>y</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -16866,7 +16891,7 @@
<varlistentry>
<term>
<parameter>zops</parameter>
- (<literal>void (*) (?)</literal>, input)
+ (<literal>PLF2OPS</literal>, input)
</term>
<listitem>
<para>
@@ -16877,13 +16902,13 @@
<varlistentry>
<term>
<parameter>zp</parameter>
- (<literal>PLFLT ** or PLfGrid2 *</literal>, input)
+ (<literal>PLPointer</literal>, input)
</term>
<listitem>
<para>
Pointer to the data to be plotted, either as a vectored
- two-dimensional array with set of function values, or as
- PLfGrid2 structure.
+ two-dimensional array with set of function values or as
+ a PLfGrid2 structure.
</para>
</listitem>
</varlistentry>
@@ -16966,7 +16991,7 @@
<varlistentry>
<term>
<parameter>clevel</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -17024,7 +17049,7 @@
<varlistentry>
<term>
<parameter>arrowx, arrowy</parameter>
- (<literal>PLFLT *</literal>,input)
+ (<literal>const PLFLT *</literal>,input)
</term>
<listitem>
<para>
@@ -17334,7 +17359,7 @@
<varlistentry>
<term>
<parameter>x</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -17345,7 +17370,7 @@
<varlistentry>
<term>
<parameter>y</parameter>
- (<literal>PLFLT *</literal>, input)
+ (<literal>const PLFLT *</literal>, input)
</term>
<listitem>
<para>
@@ -17669,7 +17694,7 @@
<varlistentry>
<term>
<parameter>u, v</parameter>
- (<literal>PLFLT **</literal>, input)
+ (<literal>const PLFLT * const *</literal>, input)
</term>
<listitem>
<para>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-29 02:23:42 UTC (rev 12970)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-29 02:27:57 UTC (rev 12971)
@@ -187,7 +187,9 @@
<!ENTITY plscmap0n '<link linkend="plscmap0n"><function>plscmap0n</function></link>'>
<!ENTITY plscmap1_range '<link linkend="plscmap1_range"><function>plgsmap1_range</function></link>'>
<!ENTITY plscmap1 '<link linkend="plscmap1"><function>plscmap1</function></link>'>
+<!ENTITY plscmap1a '<link linkend="plscmap1a"><function>plscmap1a</function></link>'>
<!ENTITY plscmap1l '<link linkend="plscmap1l"><function>plscmap1l</function></link>'>
+<!ENTITY plscmap1la '<link linkend="plscmap1la"><function>plscmap1la</function></link>'>
<!ENTITY plscmap1n '<link linkend="plscmap1n"><function>plscmap1n</function></link>'>
<!ENTITY plscol0 '<link linkend="plscol0"><function>plscol0</function></link>'>
<!ENTITY plscolbg '<link linkend="plscolbg"><function>plscolbg</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <and...@us...> - 2008-11-19 12:08:55
|
Revision: 8994
http://plplot.svn.sourceforge.net/plplot/?rev=8994&view=rev
Author: andrewross
Date: 2008-11-19 12:08:49 +0000 (Wed, 19 Nov 2008)
Log Message:
-----------
Further documentation tweaks for C functions not in the API.
Modified Paths:
--------------
trunk/doc/docbook/src/api-c.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api-c.xml
===================================================================
--- trunk/doc/docbook/src/api-c.xml 2008-11-19 11:02:32 UTC (rev 8993)
+++ trunk/doc/docbook/src/api-c.xml 2008-11-19 12:08:49 UTC (rev 8994)
@@ -201,8 +201,10 @@
<para>
Allocates a block of memory for use as a 2-d grid of type
- PLFLT. The grid is vectored 2d C style grid and so can be accessed
- using syntax like <literal>f[i][j]</literal>.
+ PLFLT. The grid is a vectored 2-d C-style array and so can be accessed
+ using syntax like <literal>*f[i][j]</literal>. The memory associated
+ with the grid must be freed by
+ calling &plFree2dGrid; once it is no longer required.
</para>
<variablelist>
@@ -232,9 +234,9 @@
</listitem>
</varlistentry>
</variablelist>
-
+
</sect1>
-
+
<sect1 id="plexit" renderas="sect3">
<title>
<function>plexit</function>: Error exit
@@ -276,13 +278,13 @@
</variablelist>
</sect1>
-
+
<sect1 id="plFree2dGrid" renderas="sect3">
<title>
- <function>plFree2dGrid</function>: Free the memory associated
- with a 2-d grid allocated using &plAlloc2dGrid.
+ <function>plFree2dGrid</function>: Free the memory associated
+ with a 2-d grid allocated using &plAlloc2dGrid;.
</title>
-
+
<para>
<funcsynopsis>
<funcprototype>
@@ -297,7 +299,7 @@
</para>
<para>
- Frees a block of memory allocated using &plAlloc2dGrid.
+ Frees a block of memory allocated using &plAlloc2dGrid;.
</para>
<variablelist>
@@ -366,7 +368,7 @@
<sect1 id="plMinMax2dGrid" renderas="sect3">
<title>
<function>plMinMax2dGrid</function>: Find the minimum and
- maximum of a 2d grid allocated using &plAlloc2dGrid.
+ maximum of a 2d grid allocated using &plAlloc2dGrid;.
</title>
<para>
@@ -385,7 +387,7 @@
</para>
<para>
- Find the minimum and maximum of a 2d grid allocated using &plAlloc2dGrid.
+ Find the minimum and maximum of a 2d grid allocated using &plAlloc2dGrid;.
</para>
<variablelist>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-19 11:02:32 UTC (rev 8993)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-19 12:08:49 UTC (rev 8994)
@@ -76,6 +76,7 @@
<!ENTITY pl_setcontlabelparam '<link linkend="pl_setcontlabelparam"><function>pl_setcontlabelparam</function></link>'>
<!ENTITY plabort '<link linkend="plabort"><function>plabort</function></link>'>
<!ENTITY pladv '<link linkend="pladv"><function>pladv</function></link>'>
+<!ENTITY plAlloc2dGrid '<link linkend="plAlloc2dGrid"><function>plAlloc2dGrid</function></link>'>
<!ENTITY plaxes '<link linkend="plaxes"><function>plaxes</function></link>'>
<!ENTITY plbin '<link linkend="plbin"><function>plbin</function></link>'>
<!ENTITY plbop '<link linkend="plbop"><function>plbop</function></link>'>
@@ -107,6 +108,7 @@
<!ENTITY plflush '<link linkend="plflush"><function>plflush</function></link>'>
<!ENTITY plfont '<link linkend="plfont"><function>plfont</function></link>'>
<!ENTITY plfontld '<link linkend="plfontld"><function>plfontld</function></link>'>
+<!ENTITY plFree2dGrid '<link linkend="plFree2dGrid"><function>plFree2dGrid</function></link>'>
<!ENTITY plgch '<link linkend="plgch"><function>plgch</function></link>'>
<!ENTITY plgcol0 '<link linkend="plgcol0"><function>plgcol0</function></link>'>
<!ENTITY plgcolbg '<link linkend="plgcolbg"><function>plgcolbg</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <and...@us...> - 2008-11-24 16:43:38
|
Revision: 9016
http://plplot.svn.sourceforge.net/plplot/?rev=9016&view=rev
Author: andrewross
Date: 2008-11-24 16:43:30 +0000 (Mon, 24 Nov 2008)
Log Message:
-----------
Update documentation to include plGetCursor and to indicate which
examples the non common API functions appear in.
Modified Paths:
--------------
trunk/doc/docbook/src/api-c.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api-c.xml
===================================================================
--- trunk/doc/docbook/src/api-c.xml 2008-11-24 16:13:13 UTC (rev 9015)
+++ trunk/doc/docbook/src/api-c.xml 2008-11-24 16:43:30 UTC (rev 9016)
@@ -6,6 +6,7 @@
Copyright (C) 1999, 2000, 2001, 2002, 2003 Alan W. Irwin
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere
Copyright (C) 2003 Joao Cardoso
+Copyright (C) 2008 Andrew Ross
Redistribution and use in source (XML DocBook) and "compiled" forms
(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -52,6 +53,14 @@
is whatever C-explicit code we are trying to understand at the time.
</para>
+ <para>
+ The functions currently documented here are either C specific utility
+ functions (e.g. &plAlloc2dGrid;, &plFree2dGrid;) or internal functions
+ which might of use to developers (e.g. &plP_checkdriverinit;). Some of
+ the utility functions are also implemented in some other languages (e.g.
+ &plGetCursor;).
+ </para>
+
<sect1 id="plP_checkdriverinit" renderas="sect3">
<title>
<function>plP_checkdriverinit</function>: Checks to see if any
@@ -97,6 +106,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plP_getinitdriverlist" renderas="sect3">
@@ -138,6 +151,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plabort" renderas="sect3">
@@ -178,6 +195,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in example 20.
+ </para>
+
</sect1>
<sect1 id="plAlloc2dGrid" renderas="sect3">
@@ -234,6 +255,10 @@
</listitem>
</varlistentry>
</variablelist>
+
+ <para>
+ This function is used in examples 8, 9, 11, 14, 16, 20, 21, 22, 28, 30.
+ </para>
</sect1>
@@ -277,6 +302,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plFree2dGrid" renderas="sect3">
@@ -327,8 +356,57 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in examples 8, 9, 11, 14, 16, 20, 21, 22, 28, 30.
+ </para>
+
</sect1>
+
+
+ <sect1 id="plGetCursor" renderas="sect3">
+ <title>
+ <function>plGetCursor</function>: Wait for graphics input event and translate to world coordinates.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plGetCursor</function>
+ </funcdef>
+ <paramdef><parameter>gin</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Wait for graphics input event and translate to world coordinates.
+ Returns 0 if no translation to world coordinates is possible.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>gin</parameter>
+ (<literal>PLGraphicsIn *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to PLGraphicsIn structure which will contain the
+ output. The structure is not allocated by the routine
+ and must exist before the function is called.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ This function is used in examples 1 and 20.
+ </para>
+
+ </sect1>
+
<sect1 id="plgfile" renderas="sect3">
<title>
<function>plgfile</function>: Get output file handle
@@ -363,6 +441,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plMinMax2dGrid" renderas="sect3">
@@ -427,6 +509,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in examples 8, 11, 20 and 21.
+ </para>
+
</sect1>
<sect1 id="plsabort" renderas="sect3">
@@ -463,6 +549,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plsexit" renderas="sect3">
@@ -499,6 +589,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plsfile" renderas="sect3">
@@ -541,6 +635,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="pltr0" renderas="sect3">
@@ -631,6 +729,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="pltr1" renderas="sect3">
@@ -722,6 +824,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in examples 9 and 16.
+ </para>
+
</sect1>
<sect1 id="pltr2" renderas="sect3">
@@ -814,6 +920,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in example 22.
+ </para>
+
</sect1>
</chapter>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-24 16:13:13 UTC (rev 9015)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-24 16:43:30 UTC (rev 9016)
@@ -117,6 +117,7 @@
<!ENTITY plgdidev '<link linkend="plgdidev"><function>plgdidev</function></link>'>
<!ENTITY plgdiori '<link linkend="plgdiori"><function>plgdiori</function></link>'>
<!ENTITY plgdiplt '<link linkend="plgdiplt"><function>plgdiplt</function></link>'>
+<!ENTITY plGetCursor '<link linkend="plGetCursor"><function>plGetCursor</function></link>'>
<!ENTITY plgfam '<link linkend="plgfam"><function>plgfam</function></link>'>
<!ENTITY plgfci '<link linkend="plgfci"><function>plgfci</function></link>'>
<!ENTITY plgfnam '<link linkend="plgfnam"><function>plgfnam</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <and...@us...> - 2008-11-26 18:47:52
|
Revision: 9020
http://plplot.svn.sourceforge.net/plplot/?rev=9020&view=rev
Author: andrewross
Date: 2008-11-26 18:47:40 +0000 (Wed, 26 Nov 2008)
Log Message:
-----------
Update documentation of non-common API functions. Change the api-c.xml
file to include only files intended for external use. Internal
functions are now documented in api-internal.xml. Also document which
languages these non-common API functions are available in.
Newly documented functions include those related command line options
and the usage message. Also include documentation of the PLGraphicsIn
and PLOptionTable structures.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
trunk/doc/docbook/src/api-c.xml
trunk/doc/docbook/src/plplotdoc.xml.in
trunk/doc/docbook/src/schemas.xml
Added Paths:
-----------
trunk/doc/docbook/src/api-internal.xml
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2008-11-26 08:32:25 UTC (rev 9019)
+++ trunk/doc/docbook/src/CMakeLists.txt 2008-11-26 18:47:40 UTC (rev 9020)
@@ -38,6 +38,7 @@
${CMAKE_CURRENT_SOURCE_DIR}/api-compat.xml
${CMAKE_CURRENT_SOURCE_DIR}/api-fortran77.xml
${CMAKE_CURRENT_SOURCE_DIR}/api-fortran95.xml
+${CMAKE_CURRENT_SOURCE_DIR}/api-internal.xml
${CMAKE_CURRENT_SOURCE_DIR}/api-obsolete.xml
${CMAKE_CURRENT_SOURCE_DIR}/bibliography.xml
${CMAKE_CURRENT_SOURCE_DIR}/c.xml
Modified: trunk/doc/docbook/src/api-c.xml
===================================================================
--- trunk/doc/docbook/src/api-c.xml 2008-11-26 08:32:25 UTC (rev 9019)
+++ trunk/doc/docbook/src/api-c.xml 2008-11-26 18:47:40 UTC (rev 9020)
@@ -40,123 +40,19 @@
<title>The Specialized C API for PLplot</title>
<para>
- The purpose of this chapter is to document the API for every C function
- in PLplot (other than language bindings) that
- is <emphasis>not</emphasis> part of the common API that has already been
- documented in <xref linkend="API"/>.
+ The purpose of this chapter is to document the PLPlot C functions that are
+ currently not part of the common API,
+ either because they are C/C++ specific utility
+ functions (e.g. &plAlloc2dGrid;, &plFree2dGrid;) or because they are not
+ easily implemented in other languages (e.g. &plGetCursor;). Some of these
+ functions are used in the examples and may be helpful for other users of
+ plplot.
</para>
-
<para>
- This chapter is a work that is just starting. There are many C functions
- in the code base that are not part of the common API, and we haven't even
- gotten to the point of listing them all. What gets documented here now
- is whatever C-explicit code we are trying to understand at the time.
+ This chapter also documents some of the data types and structures
+ defined by plplot and used by the functions.
</para>
- <para>
- The functions currently documented here are either C specific utility
- functions (e.g. &plAlloc2dGrid;, &plFree2dGrid;) or internal functions
- which might of use to developers (e.g. &plP_checkdriverinit;). Some of
- the utility functions are also implemented in some other languages (e.g.
- &plGetCursor;).
- </para>
-
- <sect1 id="plP_checkdriverinit" renderas="sect3">
- <title>
- <function>plP_checkdriverinit</function>: Checks to see if any
- of the specified drivers have been initialized
- </title>
-
- <para>
- <funcsynopsis>
- <funcprototype>
- <funcdef>
- <function>plP_checkdriverinit</function>
- </funcdef>
- <paramdef><parameter>list</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </para>
-
- <para> Checks to see if any of the specified drivers have been
- initialized. Function tests a space-delimited list of driver names to
- see how many of the given drivers have been initialized, and how often.
- The return code of the function is: <literal>0</literal> if no matching
- drivers were found to have been initialized; <literal>-1</literal> if
- an error occurred allocating the internal buffer; or, a positive number
- indicating the number of streams encountered that belong to drivers on
- the provided list. This function invokes &plP_getinitdriverlist;
- internally to get a <emphasis>complete</emphasis> list of drivers that have been initialized
- in order to compare with the driver names specified in the argument list
- to &plP_checkdriverinit;.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>
- <parameter>list</parameter>
- (<literal>char *</literal>, input)
- </term>
- <listitem>
- <para>
- Pointer to character string specifying a space-delimited
- list of driver names, e.g., <literal>"bmp jpeg tiff"</literal>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- This function is not used in any examples.
- </para>
-
- </sect1>
-
- <sect1 id="plP_getinitdriverlist" renderas="sect3">
- <title>
- <function>plP_getinitdriverlist</function>: Get the initialized-driver
- list
- </title>
-
- <para>
- <funcsynopsis>
- <funcprototype>
- <funcdef>
- <function>plP_getinitdriverlist</function>
- </funcdef>
- <paramdef><parameter>text_buffer</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- </para>
-
- <para> Get the initialized-driver list. Function returns a
- space-delimited list of the currently initialized drivers or streams. If more
- than one stream is using the same driver, then its name will be returned
- more than once. The function can be analogously thought of as also
- returning the names of the active streams. Invoked internally by
- &plP_checkdriverinit;. </para>
-
- <variablelist>
- <varlistentry>
- <term>
- <parameter>text_buffer</parameter>
- (<literal>char *</literal>, output)
- </term>
- <listitem>
- <para>
- Pointer to a user-allocated buffer to hold the result. The user
- must ensure the buffer is big enough to hold the result.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>
- This function is not used in any examples.
- </para>
-
- </sect1>
-
<sect1 id="plabort" renderas="sect3">
<title>
<function>plabort</function>: Error abort
@@ -196,6 +92,10 @@
</variablelist>
<para>
+ This function is currently available in C, f77, f95 and python.
+ </para>
+
+ <para>
This function is used in example 20.
</para>
@@ -257,6 +157,10 @@
</variablelist>
<para>
+ This function is currently available in C, C++, perl and tk.
+ </para>
+
+ <para>
This function is used in examples 8, 9, 11, 14, 16, 20, 21, 22, 28, 30.
</para>
@@ -281,7 +185,7 @@
<para>
This routine is called in case an error is encountered during
execution of a PLplot routine. It prints the error message, tries to
- release allocated resources, calls the handler prvided by &plsexit;
+ release allocated resources, calls the handler provided by &plsexit;
and then exits. If cleanup needs to be done in the driver program
then the user may want to supply his/her own exit handler and pass it
in via &plsexit;. This function should either call &plend; before
@@ -302,6 +206,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C and ada.
+ </para>
+
<para>
This function is not used in any examples.
</para>
@@ -357,6 +265,10 @@
</variablelist>
<para>
+ This function is currently available in C, C++, perl and tk.
+ </para>
+
+ <para>
This function is used in examples 8, 9, 11, 14, 16, 20, 21, 22, 28, 30.
</para>
@@ -389,11 +301,11 @@
<varlistentry>
<term>
<parameter>gin</parameter>
- (<literal>PLGraphicsIn *</literal>, output)
+ (<literal>&PLGraphicsIn; *</literal>, output)
</term>
<listitem>
<para>
- Pointer to PLGraphicsIn structure which will contain the
+ Pointer to &PLGraphicsIn; structure which will contain the
output. The structure is not allocated by the routine
and must exist before the function is called.
</para>
@@ -401,10 +313,17 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently only available with the C, C++, Ocaml,
+ Octave, Perl, Python and Ada language bindings.
+ </para>
+
<para>
This function is used in examples 1 and 20.
</para>
+
+
</sect1>
<sect1 id="plgfile" renderas="sect3">
@@ -441,12 +360,90 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C, C++ and Ocaml.
+ </para>
+
<para>
This function is not used in any examples.
</para>
</sect1>
+ <sect1 id="plMergeOpts" renderas="sect3">
+ <title>
+ <function>plMergeOpts</function>: Merge use option table into
+ internal info structure.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plMergeOpts</function>
+ </funcdef>
+ <paramdef><parameter>options</parameter></paramdef>
+ <paramdef><parameter>name</parameter></paramdef>
+ <paramdef><parameter>notes</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Merges in a set of user supplied command line options with the
+ internal options table. This allows use options to be used along
+ with the built-in plplot options to set device driver, output file
+ etc. See &plparseopts; for details of how to parse these options in
+ a program.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>options</parameter>
+ (<literal>PLOptionTable *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ User option table to merge.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>name</parameter>
+ (<literal>const char *name</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Label to preface the options in the program help.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>notes</parameter>
+ (<literal>const char **</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ A null-terminated array of notes which appear after
+ the options in the program help.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ This function is currently available in C, C++ and Ocaml.
+ </para>
+
+ <para>
+ This function is used in examples 1, 8, 16, 20 and 21.
+ </para>
+
+ </sect1>
+
<sect1 id="plMinMax2dGrid" renderas="sect3">
<title>
<function>plMinMax2dGrid</function>: Find the minimum and
@@ -510,11 +507,111 @@
</variablelist>
<para>
+ This function is currently available in C, C++, Java, Ocaml
+ and Python.
+ </para>
+
+ <para>
This function is used in examples 8, 11, 20 and 21.
</para>
</sect1>
+ <sect1 id="plOptUsage" renderas="sect3">
+ <title>
+ <function>plOptUsage</function>: Print usage and syntax message.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plOptUsage</function>
+ </funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Prints the usage and syntax message. The message can also be
+ display using the -h command line option. There is a default
+ message describing the default plplot options. The usage
+ message is also modified by &plSetUsage; and &plMergeOpts;.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>program_string</parameter>
+ (<literal>const char *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ String to appear as the name of program.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>usage_string</parameter>
+ (<literal>const char *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ String to appear as the usage text.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ This function is currently available in C, C++, Java, Ocaml, Octave
+ and Python.
+ </para>
+
+ <para>
+ This function is not used in any examples.
+ </para>
+
+ </sect1>
+
+ <sect1 id="plResetOpts" renderas="sect3">
+ <title>
+ <function>plMergeOpts</function>: Reset internal option table
+ info structure.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plResetOpts</function>
+ </funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Resets the internal command line options table to the default
+ builtin value. Any user options added with &plMergeOpts; will be
+ cleared. See &plparseopts; for details of how to parse these
+ options in a program.
+ </para>
+
+ <para>
+ This function is currently available in C, C++, Java, Ocaml and
+ Octave, although it is not much use in Java or Octave since they
+ don't have plMergeOpts.
+ </para>
+
+ <para>
+ This function is not used in any examples.
+ </para>
+
+ </sect1>
+
<sect1 id="plsabort" renderas="sect3">
<title>
<function>plsabort</function>: Set abort handler
@@ -549,12 +646,75 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C and Ocaml.
+ </para>
+
<para>
This function is not used in any examples.
</para>
</sect1>
+ <sect1 id="plSetUsage" renderas="sect3">
+ <title>
+ <function>plSetUsage</function>: Set the strings used in usage
+ and syntax messages.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plSetUsage</function>
+ </funcdef>
+ <paramdef><parameter>program_string</parameter></paramdef>
+ <paramdef><parameter>usage_string</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Sets the program string and usage string displayed by the command
+ line help option (-h) and by &plOptUsage;.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>program_string</parameter>
+ (<literal>const char *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ String to appear as the name of program.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>usage_string</parameter>
+ (<literal>const char *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ String to appear as the usage text.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ This function is currently available in C, C++, Java, Ocaml, Octave
+ and Python.
+ </para>
+
+ <para>
+ This function is not used in any examples.
+ </para>
+
+ </sect1>
+
<sect1 id="plsexit" renderas="sect3">
<title>
<function>plsexit</function>: Set exit handler
@@ -589,6 +749,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C, C++ and Ocaml.
+ </para>
+
<para>
This function is not used in any examples.
</para>
@@ -635,6 +799,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C, C++ and Ocaml.
+ </para>
+
<para>
This function is not used in any examples.
</para>
@@ -729,6 +897,11 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C, C++, Ocaml, Perl, Python
+ and Tcl.
+ </para>
+
<para>
This function is not used in any examples.
</para>
@@ -824,6 +997,11 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C, C++, Ocaml, Perl, Python
+ and Tcl.
+ </para>
+
<para>
This function is used in examples 9 and 16.
</para>
@@ -920,10 +1098,225 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is currently available in C, C++, Ocaml, Perl, Python
+ and Tcl.
+ </para>
+
<para>
This function is used in example 22.
</para>
</sect1>
+ <sect1 id="PLGraphicsIn" renderas="sect3">
+ <title><structname>PLGraphicsIn</structname>: PLplot Graphics Input structure</title>
+
+ <para>
+ The <structname>PLGraphicsIn</structname> structure is used by
+ &plGetCursor; to return information
+ on the current cursor position and key / button state for
+ interactive drivers. The structure contains the following fields:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <structfield>type</structfield>
+ (<literal>int</literal>)
+ </term>
+ <listitem>
+ <para>
+ Type of event (currently unused?).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>state</structfield>
+ (<literal>unsigned int</literal>)
+ </term>
+ <listitem>
+ <para>
+ Key or button mask.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>keysym</structfield>
+ (<literal>unsigned int</literal>)
+ </term>
+ <listitem>
+ <para>
+ Key selected.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>button</structfield>
+ (<literal>unsigned int</literal>)
+ </term>
+ <listitem>
+ <para>
+ Mouse button selected.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>subwindow</structfield>
+ (<literal>PLINT</literal>)
+ </term>
+ <listitem>
+ <para>
+ Subwindow (or subpage / subplot) number.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>string</structfield>
+ (<literal>char [PL_MAXKEY]</literal>)
+ </term>
+ <listitem>
+ <para>
+ Translated string.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>pX, pY</structfield>
+ (<literal>int</literal>)
+ </term>
+ <listitem>
+ <para>
+ Absolute device coordinates of pointer.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>dX, dY</structfield>
+ (<literal>PLFLT</literal>)
+ </term>
+ <listitem>
+ <para>
+ relative device coordinates of pointer.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>wX, wY</structfield>
+ (<literal>PLFLT</literal>)
+ </term>
+ <listitem>
+ <para>
+ World coordinates of pointer.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </sect1>
+
+ <sect1 id="PLOptionTable" renderas="sect3">
+ <title><structname>PLOptionTable</structname>: PLplot command line options table structure</title>
+
+ <para>
+ The <structname>PLOptionTable</structname> structure is used by
+ &plMergeOpts; to pass information on user-defined command line
+ options to plplot. The structure contains the following fields:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <structfield>opt</structfield>
+ (<literal>const char*</literal>)
+ </term>
+ <listitem>
+ <para>
+ Name of option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>handler</structfield>
+ (<literal>int (*func) (const char *, const char *, void *)</literal>)
+ </term>
+ <listitem>
+ <para>
+ User-defined handler function to be called when option is set. A
+ NULL value indicates that no user-defined handler is required.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>client_data</structfield>
+ (<literal>void *</literal>)
+ </term>
+ <listitem>
+ <para>
+ Pointer to client data. A
+ NULL value indicates that no client data is required.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>var</structfield>
+ (<literal>void *</literal>)
+ </term>
+ <listitem>
+ <para>
+ Pointer to variable to set to the value specified on the
+ command line option.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>mode</structfield>
+ (<literal>long</literal>)
+ </term>
+ <listitem>
+ <para>
+ Type of variable <parameter>var</parameter>. Allowed values
+ are PL_OPT_FUNC, PL_OPT_BOOL, PL_OPT_INT, PL_OPT_FLOAT,
+ PL_OPT_STRING.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>syntax</structfield>
+ (<literal>const char *</literal>)
+ </term>
+ <listitem>
+ <para>
+ Syntax for option (used in the usage message).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <structfield>desc</structfield>
+ (<literal>const char *</literal>)
+ </term>
+ <listitem>
+ <para>
+ Description of the option (used in the usage message).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </sect1>
+
</chapter>
Added: trunk/doc/docbook/src/api-internal.xml
===================================================================
--- trunk/doc/docbook/src/api-internal.xml (rev 0)
+++ trunk/doc/docbook/src/api-internal.xml 2008-11-26 18:47:40 UTC (rev 9020)
@@ -0,0 +1,147 @@
+<!-- -*- mode: nxml -*- -->
+<!--
+ api-internal.xml: "Internal C function in PLplot" chapter
+
+Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun
+Copyright (C) 1999, 2000, 2001, 2002, 2003 Alan W. Irwin
+Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere
+Copyright (C) 2003 Joao Cardoso
+Copyright (C) 2008 Andrew Ross
+
+Redistribution and use in source (XML DocBook) and "compiled" forms
+(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of source code (XML DocBook) must retain the
+above copyright notice, this list of conditions and the following
+disclaimer as the first lines of this file unmodified.
+
+2. Redistributions in compiled form (transformed to other DTDs,
+converted to HTML, PDF, PostScript, and other formats) must
+reproduce the above copyright notice, this list of conditions and
+the following disclaimer in the documentation and/or other
+materials provided with the distribution.
+
+Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+-->
+
+<chapter id="API-Internal">
+ <title>Internal C functions in PLplot</title>
+
+ <para>
+ The purpose of this chapter is to document the API for every internal
+ C function in PLplot (other than language bindings) that
+ is <emphasis>not</emphasis> part of the common API that has already been
+ documented in <xref linkend="API"/> or elsewhere. The functions documented
+ here are internal plplot functions. They are not intended for external use
+ and may change between releases.
+ </para>
+
+ <para>
+ This chapter is a work that is just starting. There are many C functions
+ in the code base that are not part of the common API, and we haven't even
+ gotten to the point of listing them all. What gets documented here now
+ is whatever C-explicit code we are trying to understand at the time.
+ </para>
+
+ <sect1 id="plP_checkdriverinit" renderas="sect3">
+ <title>
+ <function>plP_checkdriverinit</function>: Checks to see if any
+ of the specified drivers have been initialized
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plP_checkdriverinit</function>
+ </funcdef>
+ <paramdef><parameter>list</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para> Checks to see if any of the specified drivers have been
+ initialized. Function tests a space-delimited list of driver names to
+ see how many of the given drivers have been initialized, and how often.
+ The return code of the function is: <literal>0</literal> if no matching
+ drivers were found to have been initialized; <literal>-1</literal> if
+ an error occurred allocating the internal buffer; or, a positive number
+ indicating the number of streams encountered that belong to drivers on
+ the provided list. This function invokes &plP_getinitdriverlist;
+ internally to get a <emphasis>complete</emphasis> list of drivers that have been initialized
+ in order to compare with the driver names specified in the argument list
+ to &plP_checkdriverinit;.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>list</parameter>
+ (<literal>char *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Pointer to character string specifying a space-delimited
+ list of driver names, e.g., <literal>"bmp jpeg tiff"</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </sect1>
+
+ <sect1 id="plP_getinitdriverlist" renderas="sect3">
+ <title>
+ <function>plP_getinitdriverlist</function>: Get the initialized-driver
+ list
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plP_getinitdriverlist</function>
+ </funcdef>
+ <paramdef><parameter>text_buffer</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para> Get the initialized-driver list. Function returns a
+ space-delimited list of the currently initialized drivers or streams. If more
+ than one stream is using the same driver, then its name will be returned
+ more than once. The function can be analogously thought of as also
+ returning the names of the active streams. Invoked internally by
+ &plP_checkdriverinit;. </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>text_buffer</parameter>
+ (<literal>char *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to a user-allocated buffer to hold the result. The user
+ must ensure the buffer is big enough to hold the result.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </sect1>
+
+
+</chapter>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-26 08:32:25 UTC (rev 9019)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-26 18:47:40 UTC (rev 9020)
@@ -67,6 +67,7 @@
<!ENTITY chap-api-fortran77 SYSTEM "api-fortran77.xml">
<!ENTITY chap-api-compat SYSTEM "api-compat.xml">
<!ENTITY chap-api-obsolete SYSTEM "api-obsolete.xml">
+<!ENTITY chap-api-internal SYSTEM "api-internal.xml">
<!ENTITY plplot-symbols SYSTEM "plplot-symbols.txt">
<!ENTITY plplot-structs SYSTEM "plplot-structs.txt">
<!ENTITY chap-os-notes SYSTEM "os_notes.xml">
@@ -144,12 +145,14 @@
<!ENTITY plline '<link linkend="plline"><function>plline</function></link>'>
<!ENTITY plline3 '<link linkend="plline3"><function>plline3</function></link>'>
<!ENTITY pllsty '<link linkend="pllsty"><function>pllsty</function></link>'>
+<!ENTITY plMergeOpts '<link linkend="plMergeOpts"><function>plMergeOpts</function></link>'>
<!ENTITY plmesh '<link linkend="plmesh"><function>plmesh</function></link>'>
<!ENTITY plmeshc '<link linkend="plmeshc"><function>plmeshc</function></link>'>
<!ENTITY plmeshfortran95 '<link linkend="plmeshfortran95"><function>plmeshfortran95</function></link>'>
<!ENTITY plmeshfortran77 '<link linkend="plmeshfortran77"><function>plmeshfortran77</function></link>'>
<!ENTITY plmkstrm '<link linkend="plmkstrm"><function>plmkstrm</function></link>'>
<!ENTITY plmtex '<link linkend="plmtex"><function>plmtex</function></link>'>
+<!ENTITY plOptUsage '<link linkend="plOptUsage"><function>plOptUsage</function></link>'>
<!ENTITY plot3d '<link linkend="plot3d"><function>plot3d</function></link>'>
<!ENTITY plot3dc '<link linkend="plot3dc"><function>plot3dc</function></link>'>
<!ENTITY plot3dfortran95 '<link linkend="plot3dfortran95"><function>plot3dfortran95</function></link>'>
@@ -165,6 +168,7 @@
<!ENTITY plpsty '<link linkend="plpsty"><function>plpsty</function></link>'>
<!ENTITY plptex '<link linkend="plptex"><function>plptex</function></link>'>
<!ENTITY plreplot '<link linkend="plreplot"><function>plreplot</function></link>'>
+<!ENTITY plResetOpts '<link linkend="plResetOpts"><function>plResetOpts</function></link>'>
<!ENTITY plrgbhls '<link linkend="plrgbhls"><function>plrgbhls</function></link>'>
<!ENTITY plsabort '<link linkend="plsabort"><function>plsabort</function></link>'>
<!ENTITY plschr '<link linkend="plschr"><function>plschr</function></link>'>
@@ -187,6 +191,7 @@
<!ENTITY plsescfortran95 '<link linkend="plsescfortran95"><function>plsescfortran95</function></link>'>
<!ENTITY plsescfortran77 '<link linkend="plsescfortran77"><function>plsescfortran77</function></link>'>
<!ENTITY plsetopt '<link linkend="plsetopt"><function>plsetopt</function></link>'>
+<!ENTITY plSetUsage '<link linkend="plSetUsage"><function>plSetUsage</function></link>'>
<!ENTITY plsexit '<link linkend="plsexit"><function>plsexit</function></link>'>
<!ENTITY plsfam '<link linkend="plsfam"><function>plsfam</function></link>'>
<!ENTITY plsfci '<link linkend="plsfci"><function>plsfci</function></link>'>
@@ -233,6 +238,7 @@
<!ENTITY plw3d '<link linkend="plw3d"><function>plw3d</function></link>'>
<!ENTITY plwid '<link linkend="plwid"><function>plwid</function></link>'>
<!ENTITY plwind '<link linkend="plwind"><function>plwind</function></link>'>
+<!ENTITY PLGraphicsIn '<link linkend="PLGraphicsIn"><function>PLGraphicsIn</function></link>'>
<!ENTITY PLplot-website '@PLPLOT_WEBSITE@'>
<!ENTITY % Math-Entities SYSTEM "math.ent">
%Math-Entities;
@@ -297,7 +303,7 @@
<holder>Andrew Roach</holder>
</copyright>
<copyright>
- <year>2004</year>
+ <year>2004,2008</year>
<holder>Andrew Ross</holder>
</copyright>
<copyright>
@@ -397,6 +403,7 @@
&chap-api-fortran77;
&chap-api-compat;
&chap-api-obsolete;
+ &chap-api-internal;
&chap-os-notes;
</part>
Modified: trunk/doc/docbook/src/schemas.xml
===================================================================
--- trunk/doc/docbook/src/schemas.xml 2008-11-26 08:32:25 UTC (rev 9019)
+++ trunk/doc/docbook/src/schemas.xml 2008-11-26 18:47:40 UTC (rev 9020)
@@ -7,6 +7,7 @@
<uri resource="api-compat.xml" typeId="DocBook"/>
<uri resource="api-fortran77.xml" typeId="DocBook"/>
<uri resource="api-fortran95.xml" typeId="DocBook"/>
+ <uri resource="api-internal.xml" typeId="DocBook"/>
<uri resource="api-obsolete.xml" typeId="DocBook"/>
<uri resource="api.xml" typeId="DocBook"/>
<uri resource="bibliography.xml" typeId="DocBook"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2008-12-05 20:39:55
|
Revision: 9044
http://plplot.svn.sourceforge.net/plplot/?rev=9044&view=rev
Author: airwin
Date: 2008-12-05 20:39:52 +0000 (Fri, 05 Dec 2008)
Log Message:
-----------
AWI for Hezekiah M. Carty. DocBook documentation of the OCaml bindings and
examples. It validates and builds without obvious problems.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
trunk/doc/docbook/src/plplotdoc.xml.in
trunk/doc/docbook/src/schemas.xml
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2008-12-05 20:11:08 UTC (rev 9043)
+++ trunk/doc/docbook/src/CMakeLists.txt 2008-12-05 20:39:52 UTC (rev 9044)
@@ -51,6 +51,7 @@
${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
${CMAKE_CURRENT_SOURCE_DIR}/intro.xml
+${CMAKE_CURRENT_SOURCE_DIR}/ocaml.xml
${CMAKE_CURRENT_SOURCE_DIR}/os_notes.xml
${CMAKE_CURRENT_SOURCE_DIR}/perl.xml
${CMAKE_CURRENT_SOURCE_DIR}/python.xml
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-12-05 20:11:08 UTC (rev 9043)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-12-05 20:39:52 UTC (rev 9044)
@@ -55,6 +55,7 @@
<!ENTITY chap-cplus SYSTEM "cplus.xml">
<!ENTITY chap-fortran77 SYSTEM "fortran77.xml">
<!ENTITY chap-fortran95 SYSTEM "fortran95.xml">
+<!ENTITY chap-ocaml SYSTEM "ocaml.xml">
<!ENTITY chap-perl SYSTEM "perl.xml">
<!ENTITY chap-python SYSTEM "python.xml">
<!ENTITY chap-tcl SYSTEM "tcl.xml">
@@ -387,6 +388,7 @@
&chap-cplus;
&chap-fortran77;
&chap-fortran95;
+ &chap-ocaml;
&chap-perl;
&chap-python;
&chap-tcl;
Modified: trunk/doc/docbook/src/schemas.xml
===================================================================
--- trunk/doc/docbook/src/schemas.xml 2008-12-05 20:11:08 UTC (rev 9043)
+++ trunk/doc/docbook/src/schemas.xml 2008-12-05 20:39:52 UTC (rev 9044)
@@ -19,6 +19,7 @@
<uri resource="fortran95.xml" typeId="DocBook"/>
<uri resource="gui.xml" typeId="DocBook"/>
<uri resource="intro.xml" typeId="DocBook"/>
+ <uri resource="ocaml.xml" typeId="DocBook"/>
<uri resource="os_notes.xml" typeId="DocBook"/>
<uri resource="perl.xml" typeId="DocBook"/>
<uri resource="python.xml" typeId="DocBook"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <and...@us...> - 2008-12-10 10:20:38
|
Revision: 9075
http://plplot.svn.sourceforge.net/plplot/?rev=9075&view=rev
Author: andrewross
Date: 2008-12-10 10:20:33 +0000 (Wed, 10 Dec 2008)
Log Message:
-----------
Update documentation to describe return values from plparseopt (and a
few other command line argument related functions).
Modified Paths:
--------------
trunk/doc/docbook/src/api-c.xml
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api-c.xml
===================================================================
--- trunk/doc/docbook/src/api-c.xml 2008-12-10 10:08:05 UTC (rev 9074)
+++ trunk/doc/docbook/src/api-c.xml 2008-12-10 10:20:33 UTC (rev 9075)
@@ -166,6 +166,42 @@
</sect1>
+ <sect1 id="plClearOpts" renderas="sect3">
+ <title>
+ <function>plClearOpts</function>: Clear internal option table info
+ structure.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plClearOpts</function>
+ </funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Clear the internal options table info structure. This removes any
+ option added with &plMergeOpts; as well as all default entries.
+ </para>
+
+ <para>
+ This function returns 0 on success.
+ </para>
+
+ <para>
+ This function is currently available in C, C++ and Ocaml.
+ </para>
+
+ <para>
+ This function is not used in any examples.
+ </para>
+
+ </sect1>
+
<sect1 id="plexit" renderas="sect3">
<title>
<function>plexit</function>: Error exit
@@ -284,7 +320,7 @@
<para>
<funcsynopsis>
<funcprototype>
- <funcdef>
+ <funcdef>int
<function>plGetCursor</function>
</funcdef>
<paramdef><parameter>gin</parameter></paramdef>
@@ -314,6 +350,11 @@
</variablelist>
<para>
+ This function returns 1 on success and 0 if no translation to world
+ coordinates is possible.
+ </para>
+
+ <para>
This function is currently only available with the C, C++, Ocaml,
Octave, Perl, Python and Ada language bindings.
</para>
@@ -379,7 +420,7 @@
<para>
<funcsynopsis>
<funcprototype>
- <funcdef>
+ <funcdef>int
<function>plMergeOpts</function>
</funcdef>
<paramdef><parameter>options</parameter></paramdef>
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2008-12-10 10:08:05 UTC (rev 9074)
+++ trunk/doc/docbook/src/api.xml 2008-12-10 10:20:33 UTC (rev 9075)
@@ -7499,7 +7499,7 @@
<para>
<funcsynopsis>
<funcprototype>
- <funcdef>
+ <funcdef>int
<function>plparseopts</function>
</funcdef>
<paramdef><parameter>p_argc</parameter></paramdef>
@@ -7592,7 +7592,50 @@
</varlistentry>
</variablelist>
+ <para>
+ &plparseopts; removes all recognized flags
+ (decreasing argc accordingly), so that invalid input may be readily
+ detected. It can also be used to process user command line flags. The
+ user can merge an option table of type PLOptionTable into the internal
+ option table info structure using &plMergeOpts;. Or, the user can
+ specify that ONLY the external table(s) be parsed by calling
+ &plClearOpts; before &plMergeOpts;.
+ </para>
+
<para>
+ The default action taken by &plparseopts; is as follows:
+ <simplelist columns="1">
+ <member>
+ Returns with an error if an unrecognized option or badly formed
+ option-value pair are encountered.
+ </member>
+ <member>
+ Returns immediately (return code 0) when the first non-option
+ command line argument is found.
+ </member>
+ <member>
+ Returns with the return code of the option handler, if one
+ was called.
+ </member>
+ <member>
+ Deletes command line arguments from argv list as they are found,
+ and decrements argc accordingly.
+ </member>
+ <member>
+ Does not show "invisible" options in usage or help messages.
+ </member>
+ <member>
+ Assumes the program name is contained in argv[0].
+ </member>
+ </simplelist>
+ </para>
+
+ <para>
+ These behaviors may be controlled through the
+ <parameter>mode</parameter> argument.
+ </para>
+
+ <para>
Redacted form:
<itemizedlist>
<listitem>
@@ -10480,7 +10523,7 @@
<para>
<funcsynopsis>
<funcprototype>
- <funcdef>
+ <funcdef>int
<function>plsetopt</function>
</funcdef>
<paramdef><parameter>opt</parameter></paramdef>
@@ -10493,7 +10536,7 @@
Set any command-line option internally from a program before it invokes
&plinit;. <literal>opt</literal> is the name of the command-line
option and <literal>optarg</literal> is the corresponding command-line
- option argument.
+ option argument.
</para>
<variablelist>
@@ -10523,6 +10566,10 @@
</variablelist>
<para>
+ This function returns 0 on success.
+ </para>
+
+ <para>
Redacted form: <function>plsetopt(opt, optarg)</function>
</para>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-12-10 10:08:05 UTC (rev 9074)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-12-10 10:20:33 UTC (rev 9075)
@@ -86,6 +86,7 @@
<!ENTITY plbox3 '<link linkend="plbox3"><function> plbox3</function></link>'>
<!ENTITY plcalc_world '<link linkend="plcalc_world"><function> plcalc_world</function></link>'>
<!ENTITY plclear '<link linkend="plclear"><function>plclear</function></link>'>
+<!ENTITY plClearOpts '<link linkend="plClearOpts"><function>plClearOpts</function></link>'>
<!ENTITY plcol0 '<link linkend="plcol0"><function>plcol0</function></link>'>
<!ENTITY plcol1 '<link linkend="plcol1"><function>plcol1</function></link>'>
<!ENTITY plcon0 '<link linkend="plcon0"><function>plcon0</function></link>'>
@@ -239,7 +240,8 @@
<!ENTITY plw3d '<link linkend="plw3d"><function>plw3d</function></link>'>
<!ENTITY plwid '<link linkend="plwid"><function>plwid</function></link>'>
<!ENTITY plwind '<link linkend="plwind"><function>plwind</function></link>'>
-<!ENTITY PLGraphicsIn '<link linkend="PLGraphicsIn"><function>PLGraphicsIn</function></link>'>
+<!ENTITY PLGraphicsIn '<link linkend="PLGraphicsIn"><structname>PLGraphicsIn</structname></link>'>
+<!ENTITY PLOptionTable '<link linkend="PLOptionTable"><structname>PLOptionTable</structname></link>'>
<!ENTITY PLplot-website '@PLPLOT_WEBSITE@'>
<!ENTITY % Math-Entities SYSTEM "math.ent">
%Math-Entities;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <and...@us...> - 2009-01-08 14:49:19
|
Revision: 9279
http://plplot.svn.sourceforge.net/plplot/?rev=9279&view=rev
Author: andrewross
Date: 2009-01-08 14:49:09 +0000 (Thu, 08 Jan 2009)
Log Message:
-----------
Update documentation to include plrandd and plseed.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2009-01-08 14:30:16 UTC (rev 9278)
+++ trunk/doc/docbook/src/api.xml 2009-01-08 14:49:09 UTC (rev 9279)
@@ -8528,6 +8528,43 @@
</sect1>
+ <sect1 id="plrandd" renderas="sect3">
+ <title>
+ <function>plrandd</function>: Random number generator
+ returning a real random number in the range [0,1].
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plrandd</function>
+ </funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Random number generator returning a real random number in the
+ range [0,1]. The generator is based on the Mersenne Twister.
+ Most languages / compilers provide their own random number generator,
+ and so this is provided purely for convenience and to give a
+ consistent random number generator across all languages supported
+ by PLplot. This is particularly useful for comparing results
+ from the test suite of examples.
+ </para>
+
+ <para>
+ Redacted form: <function>plrandd()</function>
+ </para>
+
+ <para>
+ This function is used in examples 17,21.
+ </para>
+
+ </sect1>
+
<sect1 id="plreplot" renderas="sect3">
<title>
<function>plreplot</function>: Replays contents of plot buffer to
@@ -10416,6 +10453,50 @@
</sect1>
+ <sect1 id="plseed" renderas="sect3">
+ <title>
+ <function>plseed</function>: Set seed for internal random
+ number generator.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plseed</function>
+ </funcdef>
+ <paramdef><parameter>seed</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Set the seed for the internal random number generator. See &plrandd;
+ for further details.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>seed</parameter>
+ (<literal>unsigned int</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Seed for random number generator.
+ </para>
+ </listitem>
+ </varlistentry>
+ <para>
+ Redacted form: <function>plseed(seed)</function>
+ </para>
+
+ <para>
+ This function is used in example 21.
+ </para>
+
+ </sect1>
+
<sect1 id="plsesc" renderas="sect3">
<title>
<function>plsesc</function>: Set the escape character for text strings
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2009-01-08 14:30:16 UTC (rev 9278)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2009-01-08 14:49:09 UTC (rev 9279)
@@ -169,6 +169,7 @@
<!ENTITY plprec '<link linkend="plprec"><function>plprec</function></link>'>
<!ENTITY plpsty '<link linkend="plpsty"><function>plpsty</function></link>'>
<!ENTITY plptex '<link linkend="plptex"><function>plptex</function></link>'>
+<!ENTITY plrandd '<link linkend="plrandd"><function>plrandd</function></link>'>
<!ENTITY plreplot '<link linkend="plreplot"><function>plreplot</function></link>'>
<!ENTITY plResetOpts '<link linkend="plResetOpts"><function>plResetOpts</function></link>'>
<!ENTITY plrgbhls '<link linkend="plrgbhls"><function>plrgbhls</function></link>'>
@@ -189,6 +190,7 @@
<!ENTITY plsdiori '<link linkend="plsdiori"><function>plsdiori</function></link>'>
<!ENTITY plsdiplt '<link linkend="plsdiplt"><function>plsdiplt</function></link>'>
<!ENTITY plsdiplz '<link linkend="plsdiplz"><function>plsdiplz</function></link>'>
+<!ENTITY plseed '<link linkend="plseed"><function>plseed</function></link>'>
<!ENTITY plsesc '<link linkend="plsesc"><function>plsesc</function></link>'>
<!ENTITY plsescfortran95 '<link linkend="plsescfortran95"><function>plsescfortran95</function></link>'>
<!ENTITY plsescfortran77 '<link linkend="plsescfortran77"><function>plsescfortran77</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2009-04-05 20:03:53
|
Revision: 9792
http://plplot.svn.sourceforge.net/plplot/?rev=9792&view=rev
Author: airwin
Date: 2009-04-05 20:03:48 +0000 (Sun, 05 Apr 2009)
Log Message:
-----------
Support added libraries.xml chapter.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
trunk/doc/docbook/src/schemas.xml
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2009-04-05 20:02:35 UTC (rev 9791)
+++ trunk/doc/docbook/src/CMakeLists.txt 2009-04-05 20:03:48 UTC (rev 9792)
@@ -51,6 +51,7 @@
${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
${CMAKE_CURRENT_SOURCE_DIR}/intro.xml
+${CMAKE_CURRENT_SOURCE_DIR}/libraries.xml
${CMAKE_CURRENT_SOURCE_DIR}/ocaml.xml
${CMAKE_CURRENT_SOURCE_DIR}/os_notes.xml
${CMAKE_CURRENT_SOURCE_DIR}/perl.xml
Modified: trunk/doc/docbook/src/schemas.xml
===================================================================
--- trunk/doc/docbook/src/schemas.xml 2009-04-05 20:02:35 UTC (rev 9791)
+++ trunk/doc/docbook/src/schemas.xml 2009-04-05 20:03:48 UTC (rev 9792)
@@ -19,6 +19,7 @@
<uri resource="fortran95.xml" typeId="DocBook"/>
<uri resource="gui.xml" typeId="DocBook"/>
<uri resource="intro.xml" typeId="DocBook"/>
+ <uri resource="libraries.xml" typeId="DocBook"/>
<uri resource="ocaml.xml" typeId="DocBook"/>
<uri resource="os_notes.xml" typeId="DocBook"/>
<uri resource="perl.xml" typeId="DocBook"/>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <hez...@us...> - 2009-09-02 16:55:23
|
Revision: 10365
http://plplot.svn.sourceforge.net/plplot/?rev=10365&view=rev
Author: hezekiahcarty
Date: 2009-09-02 16:54:52 +0000 (Wed, 02 Sep 2009)
Log Message:
-----------
More complete documentation for plslabelfunc and related options.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2009-09-02 16:28:52 UTC (rev 10364)
+++ trunk/doc/docbook/src/api.xml 2009-09-02 16:54:52 UTC (rev 10365)
@@ -8,6 +8,7 @@
Copyright (C) 2003 Joao Cardoso
Copyright (C) 2004, 2007 Andrew Ross
Copyright (C) 2007 Hazen Babcock
+Copyright (C) 2008, 2009 Hezekiah M. Carty
Redistribution and use in source (XML DocBook) and "compiled" forms
(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -490,6 +491,13 @@
</listitem>
<listitem>
<para>
+ <literal>o</literal>: Use custom labeling function to
+ generate axis label text. The custom labeling function
+ can be defined with the plslabelfuncplslabelfunc; command.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<literal>s</literal>: Enables subticks between major
ticks, only valid if <literal>t</literal> is also
specified.
@@ -906,6 +914,13 @@
</listitem>
<listitem>
<para>
+ <literal>o</literal>: Use custom labeling function to
+ generate axis label text. The custom labeling function
+ can be defined with the plslabelfuncplslabelfunc; command.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<literal>s</literal>: Enables subticks between major
ticks, only valid if <literal>t</literal> is also
specified.
@@ -1100,6 +1115,13 @@
</listitem>
<listitem>
<para>
+ <literal>o</literal>: Use custom labeling function to
+ generate axis label text. The custom labeling function
+ can be defined with the plslabelfuncplslabelfunc; command.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<literal>s</literal>: Enables subticks between major
ticks, only valid if <literal>t</literal> is also
specified.
@@ -1275,6 +1297,13 @@
</listitem>
<listitem>
<para>
+ <literal>o</literal>: Use custom labeling function to
+ generate axis label text. The custom labeling function
+ can be defined with the plslabelfuncplslabelfunc; command.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<literal>s</literal>: Enables subticks between major
ticks, only valid if <literal>t</literal> is also
specified.
@@ -2300,6 +2329,30 @@
<literal>x</literal> and <literal>y</literal> labels.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>70</literal>: same as 0 except custom
+ <literal>x</literal> and <literal>y</literal> labels.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>71</literal>: same as 1 except custom
+ <literal>x</literal> and <literal>y</literal> labels.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>72</literal>: same as 2 except custom
+ <literal>x</literal> and <literal>y</literal> labels.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>73</literal>: same as 3 except custom
+ <literal>x</literal> and <literal>y</literal> labels.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -2632,19 +2685,19 @@
<listitem>
<para>
<literal>70</literal>: same as 0 except custom
- <literal>x</literal> and <literal>y</literal> labels.
+ <literal>x</literal> and <literal>y</literal> labels.
</para>
</listitem>
<listitem>
<para>
<literal>71</literal>: same as 1 except custom
- <literal>x</literal> and <literal>y</literal> labels.
+ <literal>x</literal> and <literal>y</literal> labels.
</para>
</listitem>
<listitem>
<para>
<literal>72</literal>: same as 2 except custom
- <literal>x</literal> and <literal>y</literal> labels.
+ <literal>x</literal> and <literal>y</literal> labels.
</para>
</listitem>
<listitem>
@@ -11923,6 +11976,7 @@
<function>plslabelfunc</function>
</funcdef>
<paramdef><parameter>label_func</parameter></paramdef>
+ <paramdef><parameter>label_data</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</para>
@@ -11931,7 +11985,8 @@
This function allows a user to provide their own function to provide
axis label text. The user function is given the numeric value for a
point on an axis and returns a string label to correspond with that
- value.
+ value. Custom axis labels can be enabled by passing appropriate
+ arguments to &plenv;, &plbox;, &plbox3; and similar functions.
</para>
<variablelist>
@@ -11943,9 +11998,47 @@
<listitem>
<para>
This is the custom label function. In order to reset to the
- default labeling, set this to <literal>NULL</literal>. The
- <literal>char*</literal> argument should be set to the appropriate
- label text.
+ default labeling, set this to <literal>NULL</literal>.
+ The labeling function parameters are, in order:
+ <variablelist>
+ <varlistentry>
+ <term><parameter>axis</parameter></term>
+ <listitem>
+ <para>
+ This indicates which axis a label is being requested for.
+ The value will be one of <literal>PL_X_AXIS</literal>,
+ <literal>PL_Y_AXIS</literal> or
+ <literal>PL_Z_AXIS</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ This is the value along the axis which is being labeled.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>label_text</parameter></term>
+ <listitem>
+ <para>
+ The string representation of the label
+ <literal>value</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ The maximum length in characters allowed for
+ <literal>label_text</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
</listitem>
</varlistentry>
@@ -11956,15 +12049,15 @@
</term>
<listitem>
<para>
- This parameter may be used to pass data to the label_func
- function.
+ This parameter may be used to pass data to the
+ <literal>label_func</literal> function.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
- This function is used in examples 1 and 19.
+ This function is used in example 19.
</para>
</sect1>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2009-09-02 16:28:52 UTC (rev 10364)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2009-09-02 16:54:52 UTC (rev 10365)
@@ -10,6 +10,7 @@
Copyright (C) 2004 Andrew Ross
Copyright (C) 2004 Arjen Markus
Copyright (C) 2005 Thomas J. Duck
+Copyright (C) 2009 Hezekiah M. Carty
Redistribution and use in source (XML DocBook) and "compiled" forms
(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -207,6 +208,7 @@
<!ENTITY plshades '<link linkend="plshades"><function>plshades</function></link>'>
<!ENTITY plshade '<link linkend="plshade"><function>plshade</function></link>'>
<!ENTITY plshade1 '<link linkend="plshade1"><function>plshade1</function></link>'>
+<!ENTITY plslabelfunc '<link linkend="plslabelfunc"><function>plslabelfunc</function></link>'>
<!ENTITY plsmaj '<link linkend="plsmaj"><function>plsmaj</function></link>'>
<!ENTITY plsmem '<link linkend="plsmem"><function>plsmem</function></link>'>
<!ENTITY plsmin '<link linkend="plsmin"><function>plsmin</function></link>'>
@@ -324,6 +326,10 @@
<year>2005</year>
<holder>Thomas J. Duck</holder>
</copyright>
+ <copyright>
+ <year>2008, 2009</year>
+ <holder>Hezekiah M. Carty</holder>
+ </copyright>
<legalnotice>
<para>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2009-12-02 20:38:36
|
Revision: 10671
http://plplot.svn.sourceforge.net/plplot/?rev=10671&view=rev
Author: airwin
Date: 2009-12-02 20:38:28 +0000 (Wed, 02 Dec 2009)
Log Message:
-----------
Add documentation for plgradient.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2009-12-02 17:20:42 UTC (rev 10670)
+++ trunk/doc/docbook/src/api.xml 2009-12-02 20:38:28 UTC (rev 10671)
@@ -4511,6 +4511,105 @@
</sect1>
+ <sect1 id="plgradient" renderas="sect3">
+ <title>
+ <function>plgradient</function>: Draw linear gradient inside polygon
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plgradient</function>
+ </funcdef>
+ <paramdef><parameter>n</parameter></paramdef>
+ <paramdef><parameter>x</parameter></paramdef>
+ <paramdef><parameter>y</parameter></paramdef>
+ <paramdef><parameter>angle</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Draw a linear gradient using colour map 1 inside the polygon
+ defined by the <literal><parameter>n</parameter></literal> points
+ <literal>(<parameter>x</parameter>[i],
+ <parameter>y</parameter>[i])</literal>. Interpretation of the polygon
+ is the same as for &plfill;. The polygon coordinates and the gradient
+ angle are all expressed in world coordinates. The angle from the
+ <literal><parameter>x</parameter></literal> axis for both the rotated
+ coordinate system and the gradient vector is specified by
+ <literal><parameter>angle</parameter></literal>. The magnitude of the
+ gradient vector is the difference between the maximum and minimum
+ values of <literal><parameter>x</parameter></literal> for the vertices
+ in the rotated coordinate system. The origin of the gradient vector
+ can be interpreted as being anywhere on the line corresponding to the
+ minimum <literal><parameter>x</parameter></literal> value for the
+ vertices in the rotated coordinate system. The distance along the gradient
+ vector is linearly transformed to the independent variable of colour
+ map 1 which ranges from 0. at the tail of the gradient vector to 1. at
+ the head of the gradient vector. What is drawn is the RGBA colour
+ corresponding to the independent variable of colour map 1. For more
+ information about colour map 1 (see <xref linkend="color-map-1"/>).
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>n</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Number of vertices in polygon.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>x</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Pointer to array with x coordinates of vertices.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>y</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Pointer to array with y coordinates of vertices.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>angle</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Angle (degrees) of gradient vector from x axis.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plgradient(x,y,angle)</function>
+ </para>
+
+ <para>
+ This function is used in examples 25,30.
+ </para>
+
+ </sect1>
+
<sect1 id="plgriddata" renderas="sect3">
<title>
<function>plgriddata</function>: Grid data from irregularly sampled
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2009-12-02 17:20:42 UTC (rev 10670)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2009-12-02 20:38:28 UTC (rev 10671)
@@ -132,6 +132,7 @@
<!ENTITY plglevel '<link linkend="plglevel"><function>plglevel</function></link>'>
<!ENTITY plgpage '<link linkend="plgpage"><function>plgpage</function></link>'>
<!ENTITY plgra '<link linkend="plgra"><function>plgra</function></link>'>
+<!ENTITY plgradient '<link linkend="plgradient"><function>plgradient</function></link>'>
<!ENTITY plgriddata '<link linkend="plgriddata"><function>plgriddata</function></link>'>
<!ENTITY plgspa '<link linkend="plgspa"><function>plgspa</function></link>'>
<!ENTITY plgstrm '<link linkend="plgstrm"><function>plgstrm</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <and...@us...> - 2012-07-04 20:27:26
|
Revision: 12195
http://plplot.svn.sourceforge.net/plplot/?rev=12195&view=rev
Author: andrewross
Date: 2012-07-04 20:27:19 +0000 (Wed, 04 Jul 2012)
Log Message:
-----------
Fix some dated mentions of ./configure in the documentation and update details on setting freetype fonts.
Modified Paths:
--------------
trunk/doc/docbook/src/advanced.xml
trunk/doc/docbook/src/api-compat.xml
trunk/doc/docbook/src/deploying.xml
Modified: trunk/doc/docbook/src/advanced.xml
===================================================================
--- trunk/doc/docbook/src/advanced.xml 2012-05-08 01:37:27 UTC (rev 12194)
+++ trunk/doc/docbook/src/advanced.xml 2012-07-04 20:27:19 UTC (rev 12195)
@@ -1731,11 +1731,14 @@
and the TrueType fonts that are actually used.
</para>
<para>
- On Unix/Linux systems, the TrueType fonts corresponding to the 30 possible
- valid FCIs can be specified using ./configure options. (Use
- ./configure --help to see the possibilities and also the default
- values for the fonts.) These ./configure defaults for the 30
- possibilites are taken from fonts available from the ttf-freefont font
+ The TrueType fonts corresponding to the 30 possible
+ valid FCIs can be specified using cmake options. The defaults for the
+ 30 cmake variables PL_FREETYPE_FONT[_MODIFIER] (where FONT is one of
+ MONO, SANS, SCRIPT, SERIF or SYMBOL and the optional MODIFIER is one
+ of BOLD, BOLD_ITALIC, BOLD_OBLIQUE, ITALIC or OBLIQUE) are documented
+ in cmake/modules/freetype.cmake. On Windows these defaults use standard
+ Windows fonts. On all other platforms defaults
+ are taken from fonts available from the ttf-freefont font
package. We recommend this font package because it has a rather
complete set of glyphs for most unicode blocks. (We also recommend
the gucharmap application for determining other unicode font
@@ -1743,11 +1746,6 @@
library.)
</para>
<para>
- On Windows systems, the fixed default TrueType fonts are specified in the
- include/plfci.h file. (NOT PROGRAMMED YET, so this statement
- will probably NEED REVISION.)
- </para>
- <para>
For all systems, the 30 possible TrueType fonts can be specified at run
time using the following environment variables:
<itemizedlist>
@@ -1904,9 +1902,8 @@
</itemizedlist>
On Unix/Linux systems if these environment variables are not specified
with an absolute path starting with "/", then the absolute path is
- specified by the configured default (see ./configure --help) or at
- run time with the
- environment variable PLPLOT_FREETYPE_FONT_DIR.
+ specified by the cmake variable PL_FREETYPE_FONT_PATH or at
+ run time with the environment variable PLPLOT_FREETYPE_FONT_DIR.
</para>
</sect2>
Modified: trunk/doc/docbook/src/api-compat.xml
===================================================================
--- trunk/doc/docbook/src/api-compat.xml 2012-05-08 01:37:27 UTC (rev 12194)
+++ trunk/doc/docbook/src/api-compat.xml 2012-07-04 20:27:19 UTC (rev 12195)
@@ -106,11 +106,9 @@
<filename>plplot.h</filename>. If no prototype is changed,
then the chances are high that no backwards compatibilities
have been introduced. If new functions has been added, then
- the library soname will be kept, although the libtool soversion
- string in <filename>configure.ac</filename> must be changed
- from <literal>x:y:z</literal> to
- <literal>(x+1):0:(z+1)</literal>. See the
- <application>libtool</application> manual for details.
+ the library soname will be kept, although the soversion
+ strings in <filename>cmake/module/plplot_version.cmake</filename>
+ must be changed following the instructions in that file.
</para>
</listitem>
<listitem>
Modified: trunk/doc/docbook/src/deploying.xml
===================================================================
--- trunk/doc/docbook/src/deploying.xml 2012-05-08 01:37:27 UTC (rev 12194)
+++ trunk/doc/docbook/src/deploying.xml 2012-07-04 20:27:19 UTC (rev 12195)
@@ -103,8 +103,8 @@
<itemizedlist>
<listitem>
<para>
- Use the <command>./configure</command> option
- <userinput>--prefix=/usr/local/plplot</userinput> (or some other
+ Use the <command>cmake</command> option
+ <userinput>-DCMAKE_INSTALL_PREFIX=/usr/local/plplot</userinput> (or some other
unique but consistent directory that is available on the build
machine and all users' machines).
</para>
@@ -128,9 +128,10 @@
</listitem>
<listitem>
<para>
- Build the application(s) on the build machine using the results
- of the <userinput>pkg-config --cflags --libs plplotd</userinput>
- command, and copy the resulting executable(s) to the users'
+ Build the application(s) on the build machine using either the
+ make or cmake based build system in
+ /usr/local/plplot/share/plplotX.Y.Z/examples where X.Y.Z is
+ the plplot version, and copy the resulting executable(s) to the users'
machines. Since the PLplot install location is consistent on all
machines, the application should work the same way on all
machines.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-08-18 05:56:56
|
Revision: 12486
http://sourceforge.net/p/plplot/code/12486
Author: airwin
Date: 2013-08-18 05:56:52 +0000 (Sun, 18 Aug 2013)
Log Message:
-----------
Improve CMake logic for building DocBook documentation.
Replace destroying and creating the inline.ent symlink idea for
various forms of the inline entities with properly configured info,
print, and html variants of plplotdoc-?.xml. This change removes the
dependencies of the various backend documentation between each other
since there is no longer the parallel build race condition to be
avoided for the various kinds of inline.ent symlinks.
Non-configured *.xml and *.ent files are referred to directly in the
source tree rather than as symlinks in the build tree. This makes
establishing file dependencies much more straightforward.
Drop if(PERL_FOUND) logic since that is redundant. (Earlier in build
process, BUILD_DOC is set to OFF if perl cannot be found.)
Use actual Linux filesystem commands (like mv) rather than relying on
FindUnixCommands.cmake to define the ${MV} equivalent of mv. (ToDo,
replace Linux filesystem commmands used for the documentation build
such as "mv" with their cmake -E equivalents just on general
principles.)
Use slightly improved naming conventions for intermediate files created by info
target.
Tested by Alan W. Irwin <ai...@us...> using the
-DBUILD_DOC cmake option and the "all" target in doc/docbook/src.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2013-08-16 19:36:39 UTC (rev 12485)
+++ trunk/doc/docbook/src/CMakeLists.txt 2013-08-18 05:56:52 UTC (rev 12486)
@@ -19,15 +19,15 @@
# You should have received a copy of the GNU Library General Public License
# along with PLplot; if not, write to the Free Software
-set(MASTER_XML plplotdoc.xml)
-set(MASTER_XML_IN ${MASTER_XML}.in)
-
set(BINDIR ${CMAKE_CURRENT_SOURCE_DIR}/../bin)
-configure_file(
-${CMAKE_CURRENT_SOURCE_DIR}/${MASTER_XML_IN}
-${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
-)
+foreach(suffix info html print)
+ set(inline_entities ${CMAKE_CURRENT_SOURCE_DIR}/inline-${suffix}.ent)
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/plplotdoc.xml.in
+ ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-${suffix}.xml
+ )
+endforeach(suffix info html print)
set(
SOURCE_FILES
@@ -48,8 +48,6 @@
${CMAKE_CURRENT_SOURCE_DIR}/cplus.xml
${CMAKE_CURRENT_SOURCE_DIR}/drivers.xml
${CMAKE_CURRENT_SOURCE_DIR}/gui.xml
-${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
-${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
${CMAKE_CURRENT_SOURCE_DIR}/intro.xml
${CMAKE_CURRENT_SOURCE_DIR}/libraries.xml
${CMAKE_CURRENT_SOURCE_DIR}/ocaml.xml
@@ -62,27 +60,12 @@
${CMAKE_CURRENT_SOURCE_DIR}/math.ent
)
-if(NOT CMAKE_BINARY_DIR STREQUAL "${CMAKE_SOURCE_DIR}")
- foreach(
- file
- ${SOURCE_FILES}
+execute_process(
+ COMMAND
+ ${CMAKE_COMMAND} -E copy_if_different
${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg
- )
- get_filename_component(filename ${file} NAME)
- if(NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/${filename})
- execute_process(
- COMMAND
- ${CMAKE_COMMAND} -E create_symlink
- ${CMAKE_CURRENT_SOURCE_DIR}/${filename}
- ${CMAKE_CURRENT_BINARY_DIR}/${filename}
- )
- endif(NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/${filename})
- endforeach(
- file
- ${SOURCE_FILES}
- ${CMAKE_CURRENT_SOURCE_DIR}/jadetex.cfg
- )
-endif(NOT CMAKE_BINARY_DIR STREQUAL "${CMAKE_SOURCE_DIR}")
+ ${CMAKE_CURRENT_BINARY_DIR}/jadetex.cfg
+)
if(
PREBUILT_DOC
@@ -112,14 +95,7 @@
# Custom target for validating xml file
add_custom_target(validate
- ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${CMAKE_COMMAND} -E create_symlink
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
- ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${ONSGMLS} ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML} > ${VALIDATE_OUTPUT}
- DEPENDS
- ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
+ COMMAND ${ONSGMLS} ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-html.xml > ${VALIDATE_OUTPUT}
)
add_dependencies(validate copy_prebuiltdoc)
endif(ONSGMLS)
@@ -141,75 +117,69 @@
# used to help build the documentation. Of course, these files are
# required for validation as well.
# N.B. if PERL_FOUND is false, then BUILD_DOC is false.
- if(PERL_FOUND)
- add_custom_command(
+ add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/plplot-symbols.txt
COMMAND ${PERL_EXECUTABLE}
${BINDIR}/get-library-symbols.pl > ${CMAKE_CURRENT_BINARY_DIR}/plplot-symbols.txt ${CMAKE_BINARY_DIR}/src/libplplot${LIB_TAG}.so ${CMAKE_SOURCE_DIR}/include/plplot.h 3
DEPENDS ${CMAKE_SOURCE_DIR}/include/plplot.h
)
- # For parallel builds to work must have all file dependency chains of
- # targets independent of each other. Thus, since several targets
- # need plplot-symbols.txt, must create the target
- # docbook_plplot-symbols_txt and have the targets depend on that target
- # rather than have each target file depend directly on
- # ${CMAKE_CURRENT_BINARY_DIR}/plplot-symbols.txt.
- add_custom_target(
+ # For parallel builds to work must have all file dependency chains of
+ # targets independent of each other. Thus, since several targets
+ # need plplot-symbols.txt, must create the target
+ # docbook_plplot-symbols_txt and have the targets depend on that target
+ # rather than have each target file depend directly on
+ # ${CMAKE_CURRENT_BINARY_DIR}/plplot-symbols.txt.
+ add_custom_target(
docbook_plplot-symbols_txt
DEPENDS
${CMAKE_CURRENT_BINARY_DIR}/plplot-symbols.txt
)
- # libplplot should be created before plplot-symbols.txt since
- # get-library-symbols.pl depends upon libplplot.
- add_dependencies(docbook_plplot-symbols_txt plplot${LIB_TAG})
- file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+ # libplplot should be created before plplot-symbols.txt since
+ # get-library-symbols.pl depends upon libplplot.
+ add_dependencies(docbook_plplot-symbols_txt plplot${LIB_TAG})
+ file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
"plplot-symbols.txt\n"
)
- add_custom_command(
+ add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/plplot-structs.txt
COMMAND ${PERL_EXECUTABLE}
${BINDIR}/get-library-structs.pl > ${CMAKE_CURRENT_BINARY_DIR}/plplot-structs.txt ${CMAKE_SOURCE_DIR}/include/plplot.h
DEPENDS ${CMAKE_SOURCE_DIR}/include/plplot.h
)
- # For parallel builds to work must have all file dependency chains of
- # targets independent of each other. Thus, since several targets
- # need plplot-structs.txt, must use target dependencies rather than
- # file dependencies to build this file.
- add_custom_target(
+ # For parallel builds to work must have all file dependency chains of
+ # targets independent of each other. Thus, since several targets
+ # need plplot-structs.txt, must use target dependencies rather than
+ # file dependencies to build this file.
+ add_custom_target(
docbook_plplot-structs_txt
DEPENDS
${CMAKE_CURRENT_BINARY_DIR}/plplot-structs.txt
)
- file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
+ file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
"plplot-structs.txt\n"
)
- endif(PERL_FOUND)
# Custom command for validating xml file
- if(PERL_FOUND AND ONSGMLS)
+ # This one different from alternative above used in PREBUILT_DOC case
+ # because this one has dependencies which have to be built first.
+ if(ONSGMLS)
set(VALIDATE_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/validate.out)
add_custom_target(validate
- ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${CMAKE_COMMAND} -E create_symlink
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
- ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${ONSGMLS} ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML} > ${VALIDATE_OUTPUT}
- DEPENDS
- ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
+ COMMAND ${ONSGMLS} ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-html.xml > ${VALIDATE_OUTPUT}
)
add_dependencies(validate
docbook_plplot-symbols_txt
docbook_plplot-structs_txt
)
- else(PERL_FOUND AND ONSGMLS)
+ else(ONSGMLS)
add_custom_target(validate
${CMAKE_COMMAND} -E echo "Unable to validate xml file - missing dependencies"
)
- endif(PERL_FOUND AND ONSGMLS)
+ endif(ONSGMLS)
+
# N.B. if PERL_FOUND is false, then BUILD_DOC is false.
if(BUILD_DOC)
set(STYLESHEET_HTML plplotdoc-html.dsl)
@@ -234,17 +204,13 @@
# Custom commands for building print version of documentation
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex
- COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${CMAKE_COMMAND} -E create_symlink
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
- ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
COMMAND ${OPENJADE} -b utf-8
${SGML_CATALOGS} -d ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
-t tex -o ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.jadetex
- ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
+ ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.xml
DEPENDS
${SOURCE_FILES}
- ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
+ ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-print.xml
${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_PRINT}
${CMAKE_CURRENT_SOURCE_DIR}/inline-print.ent
)
@@ -324,8 +290,6 @@
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.dvi
)
- # Use this variable to serialize inline.ent use in parallel builds.
- set(SERIALIZE_INLINE_DEPENDS)
if(BUILD_PRINT)
add_custom_target(
print ALL
@@ -345,32 +309,25 @@
add_dependencies(print
docbook_plplot-symbols_txt
docbook_plplot-structs_txt
- ${SERIALIZE_INLINE_DEPENDS}
)
- list(APPEND SERIALIZE_INLINE_DEPENDS print)
endif(BUILD_PRINT)
# Custom commands for building info version of documentation
add_custom_command(
- OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.xml-info
- COMMAND ${CMAKE_COMMAND}
- -E remove ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${CMAKE_COMMAND} -E create_symlink
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-info.ent
- ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
+ OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-clean.xml
COMMAND ${PERL_EXECUTABLE}
- ${BINDIR}/info-clean.pl ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML} > ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.xml-info
+ ${BINDIR}/info-clean.pl ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-info.xml > ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-clean.xml
DEPENDS
${SOURCE_FILES}
- ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
+ ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-info.xml
${CMAKE_CURRENT_SOURCE_DIR}/inline-info.ent
)
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.txml
COMMAND ${DB2X_XSLTPROC}
- -s texi -o ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.txml ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.xml-info
- DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.xml-info
+ -s texi -o ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.txml ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-clean.xml
+ DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-clean.xml
)
add_custom_command(
@@ -395,9 +352,10 @@
--force -o ${INFO_TMPDIR}/plplotdoc.info ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.texi
COMMAND ${CMAKE_COMMAND}
-E chdir ${INFO_TMPDIR} ls |cat > ${CMAKE_CURRENT_BINARY_DIR}/${INFO_MANIFEST}
- COMMAND ${MV}
+ COMMAND mv
${INFO_TMPDIR}/* ${CMAKE_CURRENT_BINARY_DIR}
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc.texi
+ COMMAND rmdir ${INFO_TMPDIR}
)
if(BUILD_INFO)
@@ -405,7 +363,7 @@
info ALL
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${INFO_MANIFEST})
file(APPEND ${CMAKE_CURRENT_BINARY_DIR}/static_built_files
- "plplotdoc.xml-info\n"
+ "plplotdoc-clean.xml\n"
"plplotdoc.txml\n"
"plplotdoc.texi\n"
"${INFO_MANIFEST}\n"
@@ -416,9 +374,7 @@
add_dependencies(info
docbook_plplot-symbols_txt
docbook_plplot-structs_txt
- ${SERIALIZE_INLINE_DEPENDS}
)
- list(APPEND SERIALIZE_INLINE_DEPENDS info)
endif(BUILD_INFO)
# Custom commands for building man version of documentation
@@ -426,8 +382,11 @@
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${MAN_MANIFEST}
COMMAND ${PERL_EXECUTABLE}
- ${CMAKE_CURRENT_BINARY_DIR}/../bin/api2man.pl ${MASTER_XML} api.xml ${MANVOL} > ${CMAKE_CURRENT_BINARY_DIR}/${MAN_MANIFEST}
- DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML} api.xml
+ ${CMAKE_CURRENT_BINARY_DIR}/../bin/api2man.pl plplotdoc-info.xml ${CMAKE_CURRENT_SOURCE_DIR}/api.xml ${MANVOL} > ${CMAKE_CURRENT_BINARY_DIR}/${MAN_MANIFEST}
+ DEPENDS
+ ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-info.xml
+ ${CMAKE_CURRENT_SOURCE_DIR}/inline-info.ent
+ ${CMAKE_CURRENT_SOURCE_DIR}/api.xml
)
if(BUILD_MAN)
@@ -443,18 +402,13 @@
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
- COMMAND ${CMAKE_COMMAND}
- -E remove ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
- COMMAND ${CMAKE_COMMAND} -E create_symlink
- ${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
- ${CMAKE_CURRENT_BINARY_DIR}/inline.ent
COMMAND ${OPENJADE} -b utf-8
- ${SGML_CATALOGS} -d ${STYLESHEET_HTML} -t sgml ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
+ ${SGML_CATALOGS} -d ${STYLESHEET_HTML} -t sgml ${XML_DECL} ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-html.xml
COMMAND ${PERL_EXECUTABLE}
-pi -e 's/&\#13;//g' `cat ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}`
DEPENDS
${SOURCE_FILES}
- ${CMAKE_CURRENT_BINARY_DIR}/${MASTER_XML}
+ ${CMAKE_CURRENT_BINARY_DIR}/plplotdoc-html.xml
${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
)
@@ -471,9 +425,7 @@
add_dependencies(html
docbook_plplot-symbols_txt
docbook_plplot-structs_txt
- ${SERIALIZE_INLINE_DEPENDS}
)
- list(APPEND SERIALIZE_INLINE_DEPENDS html)
endif(BUILD_HTML)
endif(BUILD_DOC)
endif(
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2013-08-16 19:36:39 UTC (rev 12485)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2013-08-18 05:56:52 UTC (rev 12486)
@@ -46,34 +46,34 @@
<!ENTITY Project-Date "$Date$">
<!ENTITY Release-Date "@RELEASE_DATE@">
-<!ENTITY chap-intro SYSTEM "intro.xml">
-<!ENTITY chap-simple SYSTEM "simple.xml">
-<!ENTITY chap-advanced SYSTEM "advanced.xml">
-<!ENTITY chap-deploying SYSTEM "deploying.xml">
-<!ENTITY chap-drivers SYSTEM "drivers.xml">
-<!ENTITY chap-ada SYSTEM "ada.xml">
-<!ENTITY chap-c SYSTEM "c.xml">
-<!ENTITY chap-cplus SYSTEM "cplus.xml">
-<!ENTITY chap-fortran77 SYSTEM "fortran77.xml">
-<!ENTITY chap-fortran95 SYSTEM "fortran95.xml">
-<!ENTITY chap-ocaml SYSTEM "ocaml.xml">
-<!ENTITY chap-perl SYSTEM "perl.xml">
-<!ENTITY chap-python SYSTEM "python.xml">
-<!ENTITY chap-tcl SYSTEM "tcl.xml">
-<!ENTITY chap-wish SYSTEM "wish.xml">
-<!ENTITY chap-gui SYSTEM "gui.xml">
-<!ENTITY chap-bibliography SYSTEM "bibliography.xml">
-<!ENTITY chap-api SYSTEM "api.xml">
-<!ENTITY chap-api-c SYSTEM "api-c.xml">
-<!ENTITY chap-api-fortran95 SYSTEM "api-fortran95.xml">
-<!ENTITY chap-api-fortran77 SYSTEM "api-fortran77.xml">
-<!ENTITY chap-api-compat SYSTEM "api-compat.xml">
-<!ENTITY chap-api-obsolete SYSTEM "api-obsolete.xml">
-<!ENTITY chap-api-internal SYSTEM "api-internal.xml">
-<!ENTITY chap-libraries SYSTEM "libraries.xml">
+<!ENTITY chap-intro SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/intro.xml">
+<!ENTITY chap-simple SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/simple.xml">
+<!ENTITY chap-advanced SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/advanced.xml">
+<!ENTITY chap-deploying SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/deploying.xml">
+<!ENTITY chap-drivers SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/drivers.xml">
+<!ENTITY chap-ada SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/ada.xml">
+<!ENTITY chap-c SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/c.xml">
+<!ENTITY chap-cplus SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/cplus.xml">
+<!ENTITY chap-fortran77 SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/fortran77.xml">
+<!ENTITY chap-fortran95 SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/fortran95.xml">
+<!ENTITY chap-ocaml SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/ocaml.xml">
+<!ENTITY chap-perl SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/perl.xml">
+<!ENTITY chap-python SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/python.xml">
+<!ENTITY chap-tcl SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/tcl.xml">
+<!ENTITY chap-wish SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/wish.xml">
+<!ENTITY chap-gui SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/gui.xml">
+<!ENTITY chap-bibliography SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/bibliography.xml">
+<!ENTITY chap-api SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api.xml">
+<!ENTITY chap-api-c SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api-c.xml">
+<!ENTITY chap-api-fortran95 SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api-fortran95.xml">
+<!ENTITY chap-api-fortran77 SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api-fortran77.xml">
+<!ENTITY chap-api-compat SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api-compat.xml">
+<!ENTITY chap-api-obsolete SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api-obsolete.xml">
+<!ENTITY chap-api-internal SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/api-internal.xml">
+<!ENTITY chap-libraries SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/libraries.xml">
<!ENTITY plplot-symbols SYSTEM "plplot-symbols.txt">
<!ENTITY plplot-structs SYSTEM "plplot-structs.txt">
-<!ENTITY chap-os-notes SYSTEM "os_notes.xml">
+<!ENTITY chap-os-notes SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/os_notes.xml">
<!ENTITY plP_checkdriverinit '<link linkend="plP_checkdriverinit"><function>plP_checkdriverinit</function></link>'>
<!ENTITY plP_getinitdriverlist '<link linkend="plP_getinitdriverlist"><function>plP_getinitdriverlist</function></link>'>
<!ENTITY pl_setcontlabelformat '<link linkend="pl_setcontlabelformat"><function>pl_setcontlabelformat</function></link>'>
@@ -259,9 +259,9 @@
<!ENTITY PLGraphicsIn '<link linkend="PLGraphicsIn"><structname>PLGraphicsIn</structname></link>'>
<!ENTITY PLOptionTable '<link linkend="PLOptionTable"><structname>PLOptionTable</structname></link>'>
<!ENTITY PLplot-website '@PLPLOT_WEBSITE@'>
-<!ENTITY % Math-Entities SYSTEM "math.ent">
+<!ENTITY % Math-Entities SYSTEM "@CMAKE_CURRENT_SOURCE_DIR@/math.ent">
%Math-Entities;
-<!ENTITY % Inline-Entities SYSTEM "inline.ent">
+<!ENTITY % Inline-Entities SYSTEM "@inline_entities@">
%Inline-Entities;
]
>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-08-20 17:16:32
|
Revision: 12491
http://sourceforge.net/p/plplot/code/12491
Author: airwin
Date: 2013-08-20 17:16:26 +0000 (Tue, 20 Aug 2013)
Log Message:
-----------
Initial XSL customization of docbook html backend output following
ideas in http://www.sagehill.net/docbookxsl.
The meaningful (rather than numerical) HTML chunk filenames are now
(quietly) formed from the DocBook id using the chunk.quietly and
use.id.as.filename parameters.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
Added Paths:
-----------
trunk/doc/docbook/src/plplotdoc-html.xsl.in
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2013-08-20 02:41:28 UTC (rev 12490)
+++ trunk/doc/docbook/src/CMakeLists.txt 2013-08-20 17:16:26 UTC (rev 12491)
@@ -297,11 +297,19 @@
if(DOCBOOK_XML_BACKEND)
if(BUILD_HTML)
+ # Custom commands for building html version of documentation
+ set(STYLESHEET_HTML ${PLPLOTDOC}-html.xsl)
+ set(STYLESHEET_HTML_IN ${STYLESHEET_HTML}.in)
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_HTML_IN}
+ ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
+ @ONLY
+ )
set(HTML_TMPDIR ${CMAKE_CURRENT_BINARY_DIR}/html)
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
COMMAND ${CMAKE_COMMAND} -E remove_directory ${HTML_TMPDIR}
- COMMAND ${XMLTO} -vv -o ${HTML_TMPDIR} html ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
+ COMMAND ${XMLTO} -vv -x ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML} -o ${HTML_TMPDIR} html ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
COMMAND ${CMAKE_COMMAND}
-E chdir ${HTML_TMPDIR} ls |cat > ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
COMMAND mv ${HTML_TMPDIR}/* ${CMAKE_CURRENT_BINARY_DIR}
@@ -310,6 +318,7 @@
${SOURCE_FILES}
${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-html.xml
${CMAKE_CURRENT_SOURCE_DIR}/inline-html.ent
+ ${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
)
add_custom_target(
html ALL
@@ -395,7 +404,6 @@
else(DOCBOOK_XML_BACKEND)
if(BUILD_HTML)
# Custom commands for building html version of documentation
-
set(STYLESHEET_HTML ${PLPLOTDOC}-html.dsl)
set(STYLESHEET_HTML_IN ${STYLESHEET_HTML}.in)
configure_file(
Added: trunk/doc/docbook/src/plplotdoc-html.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-html.xsl.in (rev 0)
+++ trunk/doc/docbook/src/plplotdoc-html.xsl.in 2013-08-20 17:16:26 UTC (rev 12491)
@@ -0,0 +1,49 @@
+<?xml version='1.0'?>
+<!--
+ plplotdoc-html.xsl.in: XSL customization for the HTML PLplot docs
+
+ Copyright (C) 2013 Alan W. Irwin
+
+ Redistribution and use in source (XML DocBook) and "compiled" forms
+ (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ 1. Redistributions of source code (XML DocBook) must retain the
+ above copyright notice, this list of conditions and the following
+ disclaimer as the first lines of this file unmodified.
+
+ 2. Redistributions in compiled form (transformed to other DTDs,
+ converted to HTML, PDF, PostScript, and other formats) must
+ reproduce the above copyright notice, this list of conditions and
+ the following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+ Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+-->
+<!--
+These ideas for customizing the PLplot html documentation are adapted
+from
+http://www.sagehill.net/docbookxsl/CustomMethods.html#CustomizationLayer
+http://www.sagehill.net/docbookxsl/Chunking.html#ChunkFilenames
+....
+-->
+<xsl:stylesheet
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
+<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
+
+<xsl:param name="chunk.quietly" select="1"/>
+<xsl:param name="use.id.as.filename" select="1"/>
+
+</xsl:stylesheet>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-08-20 19:10:11
|
Revision: 12492
http://sourceforge.net/p/plplot/code/12492
Author: airwin
Date: 2013-08-20 19:10:05 +0000 (Tue, 20 Aug 2013)
Log Message:
-----------
Make stylesheet.css configurable with a separate template file for
the -DDOCBOOK_XML_BACKEND=OFF and (default) -DDOCBOOK_XML_BACKEND=ON
cases. The -DDOCBOOK_XML_BACKEND=OFF case is untested but should work
since the changes are pretty trivial. The -DDOCBOOK_XML_BACKEND=ON
case has been tested and shows the desired coloured output for
the TABLE.funcprototype-table and .variablelist parts of the
api documentation that occurs in the many links from the API chapter.
Tested by Alan W. Irwin <ai...@us...> using the
scripts/generate_website.sh scripts.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
trunk/doc/docbook/src/plplotdoc-html.xsl.in
Added Paths:
-----------
trunk/doc/docbook/src/stylesheet.css.dsssl.in
trunk/doc/docbook/src/stylesheet.css.xsl.in
Removed Paths:
-------------
trunk/doc/docbook/src/stylesheet.css
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2013-08-20 17:16:26 UTC (rev 12491)
+++ trunk/doc/docbook/src/CMakeLists.txt 2013-08-20 19:10:05 UTC (rev 12492)
@@ -305,6 +305,12 @@
${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
@ONLY
)
+
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css.xsl.in
+ ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css
+ )
+
set(HTML_TMPDIR ${CMAKE_CURRENT_BINARY_DIR}/html)
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
@@ -410,6 +416,12 @@
${CMAKE_CURRENT_SOURCE_DIR}/${STYLESHEET_HTML_IN}
${CMAKE_CURRENT_BINARY_DIR}/${STYLESHEET_HTML}
)
+
+ configure_file(
+ ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css.dsssl.in
+ ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css
+ )
+
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST}
COMMAND ${OPENJADE} -b utf-8
@@ -652,7 +664,7 @@
endif(BUILD_MAN OR PREBUILT_DOC)
if(BUILD_HTML OR PREBUILT_DOC)
- install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST} stylesheet.css DESTINATION ${DOC_DIR}/html )
+ install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${HTML_MANIFEST} ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css DESTINATION ${DOC_DIR}/html )
install(CODE "
# Suppress empty element warning.
cmake_policy(SET CMP0007 NEW)
@@ -713,10 +725,12 @@
COMMAND rm -rf ${BASE_HTML}
COMMAND mkdir ${BASE_HTML}
COMMAND cp `cat ${HTML_MANIFEST}` ${BASE_HTML}
- COMMAND cp ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css ${BASE_HTML}
+ COMMAND cp ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css ${BASE_HTML}
COMMAND tar cfz ${HTML_TARBALL} ${BASE_HTML}
COMMAND rm -rf ${BASE_HTML}
- DEPENDS ${HTML_MANIFEST} ${CMAKE_CURRENT_SOURCE_DIR}/stylesheet.css
+ DEPENDS
+ ${HTML_MANIFEST}
+ ${CMAKE_CURRENT_BINARY_DIR}/stylesheet.css
)
set(tarball_list
Modified: trunk/doc/docbook/src/plplotdoc-html.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-html.xsl.in 2013-08-20 17:16:26 UTC (rev 12491)
+++ trunk/doc/docbook/src/plplotdoc-html.xsl.in 2013-08-20 19:10:05 UTC (rev 12492)
@@ -45,5 +45,6 @@
<xsl:param name="chunk.quietly" select="1"/>
<xsl:param name="use.id.as.filename" select="1"/>
+<xsl:param name="html.stylesheet" select="'stylesheet.css'"/>
</xsl:stylesheet>
Deleted: trunk/doc/docbook/src/stylesheet.css
===================================================================
--- trunk/doc/docbook/src/stylesheet.css 2013-08-20 17:16:26 UTC (rev 12491)
+++ trunk/doc/docbook/src/stylesheet.css 2013-08-20 19:10:05 UTC (rev 12492)
@@ -1,68 +0,0 @@
-/*
- HTML Cascade Style Sheet file for the PLplot documentation in Docbook
-
- Copyright (C) 2004 Rafael Laboissiere
-
- Redistribution and use in source (XML DocBook) and "compiled" forms
- (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
- modification, are permitted provided that the following conditions are
- met:
-
- 1. Redistributions of source code (XML DocBook) must retain the
- above copyright notice, this list of conditions and the following
- disclaimer as the first lines of this file unmodified.
-
- 2. Redistributions in compiled form (transformed to other DTDs,
- converted to HTML, PDF, PostScript, and other formats) must
- reproduce the above copyright notice, this list of conditions and
- the following disclaimer in the documentation and/or other
- materials provided with the distribution.
-
- Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
- EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-*/
-
-SPAN.underline { text-decoration: underline }
-SPAN.overline { text-decoration: overline }
-
-TABLE.funcprototype {
- width: 90%;
- margin-top: 5px;
- margin-bottom: 5px;
- margin-left: 5%;
- margin-right: 5%;
- border: solid 1px;
- background: #D6E8FF;
- padding: 5px;
-}
-
-TABLE.variablelist {
- width: 90%;
- margin-top: 5px;
- margin-bottom: 5px;
- margin-left: 5%;
- margin-right: 5%;
- border: solid 1px;
- background: #FFF0D0;
- padding: 5px;
-}
-
-.verbatim {
- width: 90%;
- margin-top: 5px;
- margin-bottom: 5px;
- margin-left: 5%;
- margin-right: 5%;
- border: solid 1px;
- background: #E0FFE0;
- padding: 5px;
-}
Copied: trunk/doc/docbook/src/stylesheet.css.dsssl.in (from rev 12482, trunk/doc/docbook/src/stylesheet.css)
===================================================================
--- trunk/doc/docbook/src/stylesheet.css.dsssl.in (rev 0)
+++ trunk/doc/docbook/src/stylesheet.css.dsssl.in 2013-08-20 19:10:05 UTC (rev 12492)
@@ -0,0 +1,68 @@
+/*
+ HTML Cascade Style Sheet file for the PLplot documentation in Docbook
+
+ Copyright (C) 2004 Rafael Laboissiere
+
+ Redistribution and use in source (XML DocBook) and "compiled" forms
+ (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ 1. Redistributions of source code (XML DocBook) must retain the
+ above copyright notice, this list of conditions and the following
+ disclaimer as the first lines of this file unmodified.
+
+ 2. Redistributions in compiled form (transformed to other DTDs,
+ converted to HTML, PDF, PostScript, and other formats) must
+ reproduce the above copyright notice, this list of conditions and
+ the following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+ Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+SPAN.underline { text-decoration: underline }
+SPAN.overline { text-decoration: overline }
+
+TABLE.funcprototype {
+ width: 90%;
+ margin-top: 5px;
+ margin-bottom: 5px;
+ margin-left: 5%;
+ margin-right: 5%;
+ border: solid 1px;
+ background: #D6E8FF;
+ padding: 5px;
+}
+
+TABLE.variablelist {
+ width: 90%;
+ margin-top: 5px;
+ margin-bottom: 5px;
+ margin-left: 5%;
+ margin-right: 5%;
+ border: solid 1px;
+ background: #FFF0D0;
+ padding: 5px;
+}
+
+.verbatim {
+ width: 90%;
+ margin-top: 5px;
+ margin-bottom: 5px;
+ margin-left: 5%;
+ margin-right: 5%;
+ border: solid 1px;
+ background: #E0FFE0;
+ padding: 5px;
+}
Added: trunk/doc/docbook/src/stylesheet.css.xsl.in
===================================================================
--- trunk/doc/docbook/src/stylesheet.css.xsl.in (rev 0)
+++ trunk/doc/docbook/src/stylesheet.css.xsl.in 2013-08-20 19:10:05 UTC (rev 12492)
@@ -0,0 +1,68 @@
+/*
+ HTML Cascade Style Sheet file for the PLplot documentation in Docbook
+
+ Copyright (C) 2004 Rafael Laboissiere
+
+ Redistribution and use in source (XML DocBook) and "compiled" forms
+ (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ 1. Redistributions of source code (XML DocBook) must retain the
+ above copyright notice, this list of conditions and the following
+ disclaimer as the first lines of this file unmodified.
+
+ 2. Redistributions in compiled form (transformed to other DTDs,
+ converted to HTML, PDF, PostScript, and other formats) must
+ reproduce the above copyright notice, this list of conditions and
+ the following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+ Important: THIS DOCUMENTATION IS PROVIDED BY THE PLPLOT PROJECT "AS IS"
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PLPLOT PROJECT BE LIABLE
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+ BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION,
+ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+SPAN.underline { text-decoration: underline }
+SPAN.overline { text-decoration: overline }
+
+TABLE.funcprototype-table {
+ width: 90%;
+ margin-top: 5px;
+ margin-bottom: 5px;
+ margin-left: 5%;
+ margin-right: 5%;
+ border: solid 1px;
+ background: #D6E8FF;
+ padding: 5px;
+}
+
+.variablelist {
+ width: 90%;
+ margin-top: 5px;
+ margin-bottom: 5px;
+ margin-left: 5%;
+ margin-right: 5%;
+ border: solid 1px;
+ background: #FFF0D0;
+ padding: 5px;
+}
+
+.verbatim {
+ width: 90%;
+ margin-top: 5px;
+ margin-bottom: 5px;
+ margin-left: 5%;
+ margin-right: 5%;
+ border: solid 1px;
+ background: #E0FFE0;
+ padding: 5px;
+}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-08-21 21:18:40
|
Revision: 12493
http://sourceforge.net/p/plplot/code/12493
Author: airwin
Date: 2013-08-21 21:18:36 +0000 (Wed, 21 Aug 2013)
Log Message:
-----------
Change funcsynopsis style to ansi and configure widths of the
resulting html table to auto (which gives nice looking spacing for the
arguments). These changes make the new XML/XSL backend tools produce
the html form of the API chapter with a style comparable to what was
produced with the deprecated SGML/DSSSL backend tools.
Make some progress toward the goal of representing the overlined "S" and
underlined "freq" in S(freq) correctly represented in html. However,
the final step of inserting the correct form of html needs additional
XSLT expertise that I currently don't have as mentioned in the
/plplotdoc-html.xsl.in comments. So the result validates
fine but is currently rendered as a blank.
So aside from this one overline/underline issue (which appears just
before the Table of Greek letters), the complete html
results for the new XML/XSL backend tools are better (Table of Greek
letters) or similar (API chapter) to what they were before for the
deprecated SGML/DSSSL backend tools.
Tested by Alan W. Irwin <ai...@us...> using
the -DBUILD_DOC=ON cmake option and the "html" target.
Modified Paths:
--------------
trunk/doc/docbook/src/plplotdoc-html.xsl.in
trunk/doc/docbook/src/stylesheet.css.xsl.in
Modified: trunk/doc/docbook/src/plplotdoc-html.xsl.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc-html.xsl.in 2013-08-20 19:10:05 UTC (rev 12492)
+++ trunk/doc/docbook/src/plplotdoc-html.xsl.in 2013-08-21 21:18:36 UTC (rev 12493)
@@ -35,16 +35,40 @@
These ideas for customizing the PLplot html documentation are adapted
from
http://www.sagehill.net/docbookxsl/CustomMethods.html#CustomizationLayer
+http://www.sagehill.net/docbookxsl/SettingParams.html
http://www.sagehill.net/docbookxsl/Chunking.html#ChunkFilenames
+http://www.sagehill.net/docbookxsl/UsingCSS.html
+http://www.sagehill.net/docbookxsl/Parameters.html
+http://docbook.sourceforge.net/release/xsl/current/doc/html/
....
-->
<xsl:stylesheet
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:fo="http://www.w3.org/1999/XSL/Format"
+ version="1.0">
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
<xsl:param name="chunk.quietly" select="1"/>
<xsl:param name="use.id.as.filename" select="1"/>
<xsl:param name="html.stylesheet" select="'stylesheet.css'"/>
+<xsl:param name="funcsynopsis.style" select="'ansi'"/>
+<!-- For this case (anchor tag with a name attribute of
+"over-under") we want the html result to be
+
+<span class="overline">S</span>(<span class="underline">freq</span>)
+
+which the configured stylesheet.css will overline and underline
+as specified. However (AWI comment), don't know how to produce
+that html yet from xslt so we do essentially nothing for this case
+at the moment.
+-->
+<xsl:template match="anchor[@name = 'over-under']">
+ <fo:block xsl:use-attribute-sets="normal.para.spacing">
+ <xsl:call-template name="anchor"/>
+ <xsl:apply-templates/>
+ </fo:block>
+</xsl:template>
+
</xsl:stylesheet>
Modified: trunk/doc/docbook/src/stylesheet.css.xsl.in
===================================================================
--- trunk/doc/docbook/src/stylesheet.css.xsl.in 2013-08-20 19:10:05 UTC (rev 12492)
+++ trunk/doc/docbook/src/stylesheet.css.xsl.in 2013-08-21 21:18:36 UTC (rev 12493)
@@ -1,7 +1,7 @@
/*
HTML Cascade Style Sheet file for the PLplot documentation in Docbook
- Copyright (C) 2004 Rafael Laboissiere
+ Copyright (C) 2013 Alan W. Irwin
Redistribution and use in source (XML DocBook) and "compiled" forms
(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -35,7 +35,7 @@
SPAN.overline { text-decoration: overline }
TABLE.funcprototype-table {
- width: 90%;
+ width: auto;
margin-top: 5px;
margin-bottom: 5px;
margin-left: 5%;
@@ -46,7 +46,7 @@
}
.variablelist {
- width: 90%;
+ width: auto;
margin-top: 5px;
margin-bottom: 5px;
margin-left: 5%;
@@ -57,7 +57,7 @@
}
.verbatim {
- width: 90%;
+ width: auto;
margin-top: 5px;
margin-bottom: 5px;
margin-left: 5%;
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-09-18 07:26:13
|
Revision: 12507
http://sourceforge.net/p/plplot/code/12507
Author: airwin
Date: 2013-09-18 07:26:10 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
Update API documentation of pllegend and plcolorbar consistent with
the corresponding doxygen documentation of the same functions. I plan
no further changes in this API documentation at the present time.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2013-09-18 07:23:49 UTC (rev 12506)
+++ trunk/doc/docbook/src/api.xml 2013-09-18 07:26:10 UTC (rev 12507)
@@ -3,7 +3,7 @@
api.xml: "The Common API for PLplot" chapter
Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun
-Copyright (C) 1999-2011 Alan W. Irwin
+Copyright (C) 1999-2013 Alan W. Irwin
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere
Copyright (C) 2003 Joao Cardoso
Copyright (C) 2004, 2007 Andrew Ross
@@ -649,6 +649,23 @@
<literal>t</literal>: Draws major ticks.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>u</literal>: Exactly like "b" except don't draw edge line.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>w</literal>: Exactly like "c" except don't draw edge line.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>x</literal>: Exactly like "t" (including the side effect of
+ the numerical labels for the major ticks) except exclude drawing the
+ major and minor tick marks.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -1082,6 +1099,13 @@
<literal>w</literal>: Exactly like "c" except don't draw edge line.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>x</literal>: Exactly like "t" (including the side effect of
+ the numerical labels for the major ticks) except exclude drawing the
+ major and minor tick marks.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -1843,6 +1867,458 @@
</sect1>
+ <sect1 id="plcolorbar" renderas="sect3">
+ <title>
+ <function>plcolorbar</function>: Plot color bar for image, shade or gradient plots
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plcolorbar</function>
+ </funcdef>
+ <paramdef><parameter>p_colorbar_width</parameter></paramdef>
+ <paramdef><parameter>p_colorbar_height</parameter></paramdef>
+ <paramdef><parameter>opt</parameter></paramdef>
+ <paramdef><parameter>position</parameter></paramdef>
+ <paramdef><parameter>x</parameter></paramdef>
+ <paramdef><parameter>y</parameter></paramdef>
+ <paramdef><parameter>x_length</parameter></paramdef>
+ <paramdef><parameter>y_length</parameter></paramdef>
+ <paramdef><parameter>bg_color</parameter></paramdef>
+ <paramdef><parameter>bb_color</parameter></paramdef>
+ <paramdef><parameter>bb_style</parameter></paramdef>
+ <paramdef><parameter>low_cap_color</parameter></paramdef>
+ <paramdef><parameter>high_cap_color</parameter></paramdef>
+ <paramdef><parameter>cont_color</parameter></paramdef>
+ <paramdef><parameter>cont_width</parameter></paramdef>
+ <paramdef><parameter>n_labels</parameter></paramdef>
+ <paramdef><parameter>label_opts</parameter></paramdef>
+ <paramdef><parameter>labels</parameter></paramdef>
+ <paramdef><parameter>naxes</parameter></paramdef>
+ <paramdef><parameter>axis_opts</parameter></paramdef>
+ <paramdef><parameter>ticks</parameter></paramdef>
+ <paramdef><parameter>sub_ticks</parameter></paramdef>
+ <paramdef><parameter>n_values</parameter></paramdef>
+ <paramdef><parameter>values</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Routine for creating a continuous color bar for image, shade, or gradient plots.
+ (See &pllegend; for similar functionality for creating legends with discrete elements).
+ The arguments of plcolorbar provide control over the location
+ and size of the color bar as well as the location and characteristics of
+ the elements (most of which are optional) within that color bar. The
+ resulting color bar is clipped at the boundaries of the current subpage.
+ (N.B. the adopted coordinate system used for some of the parameters is
+ defined in the documentation of the
+ <literal><parameter>position</parameter></literal> parameter.)
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>p_colorbar_width</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to a location which contains (after the call) the
+ labelled and decorated color bar width in adopted coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>p_colorbar_height</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to a location which contains (after the call) the
+ labelled and decorated color bar height in adopted coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>opt</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <literal><parameter>opt</parameter></literal> contains
+ bits controlling the overall color bar. The orientation (direction of
+ the maximum value) of the color bar is specified with
+ <literal>PL_ORIENT_RIGHT</literal>, <literal>PL_ORIENT_TOP</literal>,
+ <literal>PL_ORIENT_LEFT</literal>, or
+ <literal>PL_ORIENT_BOTTOM</literal>. If none of those bits are
+ specified, the default orientation is toward the top, i.e., a vertical
+ color bar. If the <literal>PL_COLORBAR_BACKGROUND</literal> bit is
+ set, plot a (semi-transparent) background for the color bar. If the
+ <literal>PL_COLORBAR_BOUNDING_BOX</literal> bit is set, plot a
+ bounding box for the color bar. The type of color bar must be
+ specified with one of <literal>PL_COLORBAR_IMAGE</literal>,
+ <literal>PL_COLORBAR_SHADE</literal>, or
+ <literal>PL_COLORBAR_GRADIENT</literal>. If more than one of those
+ bits is set only the first one in the above list is honored. The
+ position of the (optional) label/title can be specified with
+ <literal>PL_LABEL_RIGHT</literal>, <literal>PL_LABEL_TOP</literal>,
+ <literal>PL_LABEL_LEFT</literal>, or
+ <literal>PL_LABEL_BOTTOM</literal>. If no label position bit is set
+ then no label will be drawn. If more than one of this list of bits is
+ specified, only the first one on the list is honored. End-caps for the
+ color bar can added with <literal>PL_COLORBAR_CAP_LOW</literal> and
+ <literal>PL_COLORBAR_CAP_HIGH</literal>. If a particular color bar cap
+ option is not specified then no cap will be drawn for that end. As a
+ special case for <literal>PL_COLORBAR_SHADE</literal>, the option
+ <literal>PL_COLORBAR_SHADE_LABEL</literal> can be specified. If this
+ option is provided then any tick marks and tick labels will be placed
+ at the breaks between shaded segments. TODO: This should be expanded
+ to support custom placement of tick marks and tick labels at custom
+ value locations for any color bar type.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>position</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <literal><parameter>position</parameter></literal>
+ contains bits which control the overall position of the
+ color bar and the definition of the adopted coordinates used for
+ positions just like what is done for the position argument for
+ &pllegend;. However, note that the defaults for the position bits
+ (see below) are different than the &pllegend; case. The combination of
+ the <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>,
+ <literal>PL_POSITION_BOTTOM</literal>,
+ <literal>PL_POSITION_INSIDE</literal>, and
+ <literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16
+ possible standard positions (the 4 corners and centers of the 4 sides
+ for both the inside and outside cases) of the color bar relative to
+ the adopted coordinate system. The corner positions are specified by
+ the appropriate combination of two of the
+ <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>, and
+ <literal>PL_POSITION_BOTTOM</literal> bits while the sides are
+ specified by a single value of one of those bits. The adopted
+ coordinates are normalized viewport coordinates if the
+ <literal>PL_POSITION_VIEWPORT</literal> bit is set or normalized
+ subpage coordinates if the <literal>PL_POSITION_SUBPAGE</literal> bit
+ is set. Default position bits: If none of
+ <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>, or
+ <literal>PL_POSITION_BOTTOM</literal> are set, then use
+ <literal>PL_POSITION_RIGHT</literal>. If neither of
+ <literal>PL_POSITION_INSIDE</literal> or
+ <literal>PL_POSITION_OUTSIDE</literal> is set, use
+ <literal>PL_POSITION_OUTSIDE</literal>. If neither of
+ <literal>PL_POSITION_VIEWPORT</literal> or
+ <literal>PL_POSITION_SUBPAGE</literal> is set, use
+ <literal>PL_POSITION_VIEWPORT</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>x</parameter>
+ (<literal> PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ X offset of the color bar position in adopted coordinates from the
+ specified standard position of the color bar. For positive x, the
+ direction of motion away from the standard position is inward/outward
+ from the standard corner positions or standard left or right positions
+ if the
+ <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
+ bit is set in <literal><parameter>position</parameter></literal>. For
+ the standard top or bottom positions, the direction of motion is
+ toward positive X.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>y</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Y offset of the color bar position in adopted coordinates from the
+ specified standard position of the color bar. For positive y, the
+ direction of motion away from the standard position is inward/outward
+ from the standard corner positions or standard top or bottom positions
+ if the
+ <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
+ bit is set in <literal><parameter>position</parameter></literal>. For
+ the standard left or right positions, the direction of motion is
+ toward positive Y.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>x_length</parameter>
+ (<literal> PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Length of the body of the color bar in the X direction in
+ adopted coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>y_length</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Length of the body of the color bar in the Y direction in adopted
+ coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>bg_color</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap0 color of the background for the color bar
+ (<literal>PL_COLORBAR_BACKGROUND</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>bb_color</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap0 color of the bounding-box line for the color bar
+ (<literal>PL_COLORBAR_BOUNDING_BOX</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>bb_style</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The &pllsty; style number for the bounding-box line for the color bar
+ (<literal>PL_COLORBAR_BACKGROUND</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>low_cap_color</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap1 color of the low-end color bar cap, if it is drawn
+ (<literal>PL_COLORBAR_CAP_LOW</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>high_cap_color</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap1 color of the high-end color bar cap, if it is drawn
+ (<literal>PL_COLORBAR_CAP_HIGH</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>cont_color</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap0 contour color for <literal>PL_COLORBAR_SHADE</literal>
+ plots. This is passed directly to &plshades;, so it will be
+ interpreted according to the design of &plshades;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>cont_width</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Contour width for <literal>PL_COLORBAR_SHADE</literal>
+ plots. This is passed directly to &plshades;, so it will be
+ interpreted according to the design of &plshades;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>n_labels</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Number of labels to place around the color bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>label_opts</parameter>
+ (<literal>const PLINT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Options for each of <parameter>n_labels</parameter> labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>labels</parameter>
+ (<literal>const char *const *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <parameter>n_labels</parameter> text labels for the color bar. No
+ label is drawn if no label position is specified with one of the
+ <literal>PL_COLORBAR_LABEL_RIGHT</literal>,
+ <literal>PL_COLORBAR_LABEL_TOP</literal>,
+ <literal>PL_COLORBAR_LABEL_LEFT</literal>, or
+ <literal>PL_COLORBAR_LABEL_BOTTOM</literal> bits in the corresponding
+ label_opts field.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>n_axes</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Number of axis definitions provided. This value must be greater than
+ 0. It is typically 1 (numerical axis labels are provided for one of
+ the long edges of the color bar), but it can be larger if multiple
+ numerical axis labels for the long edges of the color bar are desired.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>axis_opts</parameter>
+ (<literal>const char *const *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array of n_axes axis options (interpreted as for &plbox;) for the
+ color bar's axis definitions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>ticks</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array of n_axes values of the spacing of the major tick marks
+ (interpreted as for &plbox;) for the color bar's axis definitions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>sub_ticks</parameter>
+ (<literal>PLINT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array of n_axes values of the number of subticks (interpreted as
+ for &plbox;) for the color bar's axis definitions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>n_values</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array containing the number of elements in each of the
+ <literal><parameter>n_axes</parameter></literal> rows of the
+ two-dimensional <literal><parameter>values</parameter></literal> array.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>values</parameter>
+ (<literal>PLFLT *const *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ A two-dimensional array containing the numeric values for the data
+ range represented by the color bar. For a row index of
+ <literal><parameter>i_axis</parameter></literal> (where 0 <
+ <literal><parameter>i_axis</parameter></literal> <
+ <literal><parameter>n_axes</parameter></literal>), the number of
+ elements in the row is specified by
+ <literal><parameter>n_values</parameter></literal>[<literal><parameter>i_axis</parameter></literal>]. For <literal>PL_COLORBAR_IMAGE</literal> and
+ <literal>PL_COLORBAR_GRADIENT</literal> the number of elements is 2,
+ and the corresponding row elements of the
+ <literal><parameter>values</parameter></literal> array are the minimum
+ and maximum value represented by the colorbar. For
+ <literal>PL_COLORBAR_SHADE</literal>, the number and values of the
+ elements of a row of the
+ <literal><parameter>values</parameter></literal> array is interpreted
+ the same as the <literal><parameter>nlevel</parameter></literal> and
+ <literal><parameter>clevel</parameter></literal> arguments of
+ &plshades;.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plcolorbar(p_legend_width, p_legend_height,
+ opt, position, x, y, x_length, y_length, bg_color,
+ bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, label_opts, labels, axis_opts, ticks, sub_ticks, values)</function>
+ </para>
+
+ <para>
+ This function is used in examples 16 and 33.
+ </para>
+
+ </sect1>
+
<sect1 id="plcont" renderas="sect3">
<title>
<function>plcont</function>: Contour plot
@@ -6375,12 +6851,13 @@
<para>
Routine for creating a discrete plot legend with a plotted
filled box, line, and/or line of symbols for each annotated legend
- entry. The arguments of pllegend provide control over the location
- and size of the legend as well as the location and characteristics of
- the elements (most of which are optional) within that legend. The
- resulting legend is clipped at the boundaries of the current subpage.
- (N.B. the adopted coordinate system used for some of the parameters is
- defined in the documentation of the
+ entry. (See &plcolorbar; for similar functionality for creating
+ continuous color bars.) The arguments of pllegend provide control
+ over the location and size of the legend as well as the location and
+ characteristics of the elements (most of which are optional) within
+ that legend. The resulting legend is clipped at the boundaries of the
+ current subpage. (N.B. the adopted coordinate system used for some of
+ the parameters is defined in the documentation of the
<literal><parameter>position</parameter></literal> parameter.)
</para>
<variablelist>
@@ -6454,22 +6931,32 @@
<listitem>
<para>
<literal><parameter>position</parameter></literal>
- contains bits controlling the overall position of the legend and the
- definition of the adopted coordinates used for positions. The
- combination of the <literal>PL_POSITION_LEFT</literal>,
+ contains bits which control the overall position of the legend and the
+ definition of the adopted coordinates used for positions just like
+ what is done for the position argument for &plcolorbar;. However,
+ note that the defaults for the position bits (see below) are
+ different than the &plcolorbar; case. The combination of the
+ <literal>PL_POSITION_LEFT</literal>,
<literal>PL_POSITION_RIGHT</literal>,
<literal>PL_POSITION_TOP</literal>,
<literal>PL_POSITION_BOTTOM</literal>,
<literal>PL_POSITION_INSIDE</literal>, and
<literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16
- possible standard positions (the 4 corners and 4 side centers for both
- the inside and outside cases) of the legend relative to the adopted
- coordinate system. The adopted coordinates are normalized viewport
- coordinates if the <literal>PL_POSITION_VIEWPORT</literal> bit is set
- or normalized subpage coordinates if the
- <literal>PL_POSITION_SUBPAGE</literal> bit is set. Default position
- bits: If none of <literal>PL_POSITION_LEFT</literal>,
+ possible standard positions (the 4 corners and centers of the 4 sides
+ for both the inside and outside cases) of the legend relative to the
+ adopted coordinate system. The corner positions are specified by the
+ appropriate combination of two of the
+ <literal>PL_POSITION_LEFT</literal>,
<literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>, and
+ <literal>PL_POSITION_BOTTOM</literal> bits while the sides are
+ specified by a single value of one of those bits. The adopted
+ coordinates are normalized viewport coordinates if the
+ <literal>PL_POSITION_VIEWPORT</literal> bit is set or normalized
+ subpage coordinates if the <literal>PL_POSITION_SUBPAGE</literal> bit
+ is set. Default position bits: If none of
+ <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
<literal>PL_POSITION_TOP</literal>, or
<literal>PL_POSITION_BOTTOM</literal> are set, then use the
combination of <literal>PL_POSITION_RIGHT</literal> and
@@ -6493,12 +6980,12 @@
X offset of the legend position in adopted coordinates
from the specified standard position of the legend. For positive x,
the direction of motion away from the standard position is
- inward/outward from the standard corner positions or standard left or
- right positions if the
+ inward/outward from the standard corner positions or
+ standard left or right positions if the
<literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
bit is set in <literal><parameter>position</parameter></literal>. For
- the standard top or bottom positions, the direction of motion is toward
- positive X.
+ the standard top or bottom positions, the direction of motion is
+ toward positive X.
</para>
</listitem>
</varlistentry>
@@ -6541,7 +7028,7 @@
</term>
<listitem>
<para>
- The cmap0 index of the background color for the legend
+ The cmap0 color of the background for the legend
(<literal>PL_LEGEND_BACKGROUND</literal>).
</para>
</listitem>
@@ -6553,7 +7040,7 @@
</term>
<listitem>
<para>
- The cmap0 index of the color of the bounding-box line for the legend
+ The cmap0 color of the bounding-box line for the legend
(<literal>PL_LEGEND_BOUNDING_BOX</literal>).
</para>
</listitem>
@@ -6565,7 +7052,7 @@
</term>
<listitem>
<para>
- The cmap0 index of the background color for the legend
+ The pllsty style number for the bounding-box line for the legend
(<literal>PL_LEGEND_BACKGROUND</literal>).
</para>
</listitem>
@@ -6696,14 +7183,14 @@
</term>
<listitem>
<para>
- Array of nlegend text colors (cmap0 indices).
+ Array of nlegend cmap0 text colors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>text</parameter>
- (<literal>const char **</literal>, input)
+ (<literal>const char *const *</literal>, input)
</term>
<listitem>
<para>
@@ -6718,7 +7205,7 @@
</term>
<listitem>
<para>
- Array of nlegend colors (cmap0 indices) for the discrete colored boxes
+ Array of nlegend cmap0 colors for the discrete colored boxes
(<parameter>PL_LEGEND_COLOR_BOX</parameter>).
</para>
</listitem>
@@ -6767,7 +7254,7 @@
</term>
<listitem>
<para>
- Array of nlegend line colors (cmap0 indices)
+ Array of nlegend cmap0 line colors
(<parameter>PL_LEGEND_LINE</parameter>).
</para>
</listitem>
@@ -6803,7 +7290,7 @@
</term>
<listitem>
<para>
- Array of nlegend symbol colors (cmap0 indices)
+ Array of nlegend cmap0 symbol colors
(<parameter>PL_LEGEND_SYMBOL</parameter>).
</para>
</listitem>
@@ -6835,7 +7322,7 @@
<varlistentry>
<term>
<parameter>symbols</parameter>
- (<literal>const char **</literal>, input)
+ (<literal>const char *const *</literal>, input)
</term>
<listitem>
<para>
@@ -6862,7 +7349,7 @@
</para>
<para>
- This function is used in examples 4 and 26.
+ This function is used in examples 4, 26, and 33.
</para>
</sect1>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2013-09-18 07:23:49 UTC (rev 12506)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2013-09-18 07:26:10 UTC (rev 12507)
@@ -92,6 +92,7 @@
<!ENTITY plClearOpts '<link linkend="plClearOpts"><function>plClearOpts</function></link>'>
<!ENTITY plcol0 '<link linkend="plcol0"><function>plcol0</function></link>'>
<!ENTITY plcol1 '<link linkend="plcol1"><function>plcol1</function></link>'>
+<!ENTITY plcolorbar '<link linkend="plcolorbar"><function>plcolorbar</function></link>'>
<!ENTITY plcon0 '<link linkend="plcon0"><function>plcon0</function></link>'>
<!ENTITY plcon1 '<link linkend="plcon1"><function>plcon1</function></link>'>
<!ENTITY plcon2 '<link linkend="plcon2"><function>plcon2</function></link>'>
@@ -149,6 +150,7 @@
<!ENTITY plinit '<link linkend="plinit"><function>plinit</function></link>'>
<!ENTITY pljoin '<link linkend="pljoin"><function>pljoin</function></link>'>
<!ENTITY pllab '<link linkend="pllab"><function>pllab</function></link>'>
+<!ENTITY pllegend '<link linkend="pllegend"><function>pllegend</function></link>'>
<!ENTITY pllightsource '<link linkend="pllightsource"><function>pllightsource</function></link>'>
<!ENTITY plline '<link linkend="plline"><function>plline</function></link>'>
<!ENTITY plline3 '<link linkend="plline3"><function>plline3</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-09-24 05:21:21
|
Revision: 12521
http://sourceforge.net/p/plplot/code/12521
Author: airwin
Date: 2013-09-24 05:21:15 +0000 (Tue, 24 Sep 2013)
Log Message:
-----------
A large number of spelling fixes generated by "aspell check <filename>".
Modified Paths:
--------------
trunk/doc/docbook/src/ada.xml
trunk/doc/docbook/src/advanced.xml
trunk/doc/docbook/src/api-c.xml
trunk/doc/docbook/src/api-compat.xml
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/bibliography.xml
trunk/doc/docbook/src/c.xml
trunk/doc/docbook/src/cplus.xml
trunk/doc/docbook/src/deploying.xml
trunk/doc/docbook/src/drivers.xml
trunk/doc/docbook/src/intro.xml
trunk/doc/docbook/src/libraries.xml
trunk/doc/docbook/src/ocaml.xml
trunk/doc/docbook/src/simple.xml
trunk/doc/docbook/src/tcl.xml
trunk/doc/docbook/src/wish.xml
Modified: trunk/doc/docbook/src/ada.xml
===================================================================
--- trunk/doc/docbook/src/ada.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/ada.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -100,7 +100,7 @@
<para>Many of the comments from the C source header file (similar in
purpose to an Ada specification file) have been retained in the thin
- binding, even when they are no longer sensical. These might be pruned at
+ binding, even when they are no longer make sense. These might be pruned at
some point to facilitate reading the Ada source.</para>
<para>Also included in the thin binding are some other declarations
@@ -229,7 +229,7 @@
<para>An important part of the Ada bindings is the examples, some 30 of
which demonstrate how to use many of the features of the PLplot package.
- These examples also serve as a testbed for the bindings in Ada and other
+ These examples also serve as a test bed for the bindings in Ada and other
languages by checking the Postscript files that are generated by each
example against those generated by the C versions. These examples have
been completely re-written in Ada (but retain a C flavor in the names that
@@ -326,11 +326,11 @@
requiring the user program to <literal>with</literal>
<literal>Ada.Numerics.Long_Real_Arrays</literal> simply to gain access
to these types and in the process require linking to the BLAS and LAPACK
- numerics libraries.</para>
+ numerical libraries.</para>
<para>For users who wish to either attain compatibility with Ada 2005
Annex G.3 or to access its features which actually depend on BLAS and
- LAPACK, there are two routes. One is to build PLpot normally and then to
+ LAPACK, there are two routes. One is to build PLplot normally and then to
edit <literal>PLplot_Auxiliary.ads</literal> as is indicated in that
file. This is a very simple process requiring commenting two lines and
uncommenting three lines. Then recompile only the Ada bindings and use
@@ -338,7 +338,7 @@
to type-convert the <literal>Real_Vector</literal> and
<literal>Real_Matrix</literal> objects in the user program so that they
are compatible with the declarations of Annex G.3 when accessing the
- numerics functionality in that annex. (In GNAT, the relevant file is
+ numerical functionality in that annex. (In GNAT, the relevant file is
<literal>a-nlrear.ads</literal>.)</para>
<para>This policy was changed in SVN version 11153. Before this, the
@@ -369,8 +369,8 @@
<para>Pragma Warnings (Off, "some text") and Pragma Warnings (On, "some
text") are used in the bindings to suppress warnings about a particular
- method used to intereface with C code. These pragmas are also used in
- Ada Exaamples 21 to suppress a particular warning. Pragma Warnings is a
+ method used to interface with C code. These pragmas are also used in
+ Ada Examples 21 to suppress a particular warning. Pragma Warnings is a
GNAT extension. Non-GNAT usage could simply remove these pragmas with
the resulting warnings ignored as they are benign.</para>
@@ -473,7 +473,7 @@
<literal>Draw_On_Black</literal>. Each of these manipulates color
map 0 by swapping black and white so that e.g.with
<literal>Draw_On_White</literal>, formerly white lines on a black
- background autotmatically become black lines on a white
+ background automatically become black lines on a white
background.</para>
</sect4>
</sect3>
@@ -490,7 +490,7 @@
<title>Multiplot_Pairs</title>
<para>Plot up to five <emphasis>x-y</emphasis> pairs with easy
- labeling, coloring, line width and styles, justification, and
+ labelling, coloring, line width and styles, justification, and
zooming.</para>
</sect4>
@@ -498,7 +498,7 @@
<title>Simple_Plot</title>
<para>Plot up to five <emphasis>y</emphasis>'s against a single
- <emphasis>x</emphasis> with easy labeling and automatic line colors
+ <emphasis>x</emphasis> with easy labelling and automatic line colors
and styles.</para>
</sect4>
@@ -527,7 +527,7 @@
<title>Simple_Plot_Pairs</title>
<para>Plot up to five <emphasis>x</emphasis>-<emphasis>y</emphasis>
- pairs with easy labeling and automatic line colors and
+ pairs with easy labelling and automatic line colors and
styles.</para>
</sect4>
@@ -566,7 +566,7 @@
<para>PLplot provides extensive manipulation and control of two
separate color maps, color map 0 and color map 1. The Ada binding
makes basic manipulations easier and also adds facilities for making
- snapshots of color map 0 so that any state of the map can easlily be
+ snapshots of color map 0 so that any state of the map can easily be
restored later. An initial snapshot is taken when the package is
initialized so that the default color settings can always be restored
after having been changed.</para>
@@ -803,7 +803,7 @@
<para>The custom label function <literal>Set_Custom_Label</literal>
(<literal>plslabelfunc</literal> in the traditional binding) can be
- called with null arguments to revert to using the default labeling
+ called with null arguments to revert to using the default labelling
scheme. Alternately, an Ada-only procedure with no arguments,
<literal>Use_Default_Labels</literal>, is provided. See Ada example 19
(<literal>x19a.adb</literal> or <literal>xthick19a.adb</literal>) for a
@@ -814,7 +814,7 @@
(<literal>plstransform</literal> in the traditional binding) can be
called with null arguments to clear any previous custom coordinate
transforms that the user has set, thus reverting to the default
- coordinate transform. Alternately, an Ada-only procdure with no
+ coordinate transform. Alternately, an Ada-only procedure with no
arguments, <literal>Clear_Custom_Coordinate_Transform</literal>, is
provided. See Ada example 19 (<literal>x19a.adb</literal> or
<literal>xthick19a.adb</literal>) for a usage example.</para>
@@ -887,7 +887,7 @@
<para>As discussed in Section 6.1, the bindings are made to work with
Ada 95 and Ada 2005, but special steps need to be taken in order to
- access the numerics capabilities of Ada 2005 to the extent that vectors
+ access the numerical capabilities of Ada 2005 to the extent that vectors
and arrays of the type defined in the Ada Reference Manual Annex G.3 are
required to be passed to PLplot routines.</para>
</sect2>
@@ -906,7 +906,7 @@
and <literal>PLplot_Auxiliary.adb</literal>. These files are currently
used to provide a few convenience subprograms that are used in the
examples. However, they are also associated with the above-mentioned
- facility to easily accommodate acessing the G.3 Annex vector-matrix
+ facility to easily accommodate accessing the G.3 Annex vector-matrix
manipulation facilities. If not for the desire for this easy "switching"
ability, the <literal>PLplot_Auxiliary</literal> package could be
removed from the <literal>with</literal> parts of the other binding
Modified: trunk/doc/docbook/src/advanced.xml
===================================================================
--- trunk/doc/docbook/src/advanced.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/advanced.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -664,7 +664,7 @@
</para>
<para>
- Additional startup routines &plstar; and &plstart; are available but
+ Additional start up routines &plstar; and &plstart; are available but
these are simply front-ends to &plinit;, and should be avoided. It
is preferable to call &plinit; directly, along with the appropriate
setup calls, for the greater amount of control this provides (see the
@@ -791,13 +791,13 @@
</sect2>
<sect2>
- <title>Initialise FreeType</title>
+ <title>Initialize FreeType</title>
- <para>Next, we have to initialise the FreeType library. For the
+ <para>Next, we have to initialize the FreeType library. For the
<filename>gd.c</filename> driver this is done via two separate functions due
- to the order that dependent information is initialised in the driver.</para>
+ to the order that dependent information is initialized in the driver.</para>
- <para>The "level 1" initialisation of FreeType does two things: 1) calls
+ <para>The "level 1" initialization of FreeType does two things: 1) calls
<literal>plD_FreeType_init(pls)</literal>, which in turn allocates memory to
the pls->FT structure; and 2) stores the location of the call back routine.
</para>
@@ -817,7 +817,7 @@
</programlisting>
</para>
- <para>This initialisation routine is called at the end of
+ <para>This initialization routine is called at the end of
<literal>plD_init_png_Dev(PLStream *pls)</literal> in the
<filename>gd.c</filename> driver:</para>
@@ -845,7 +845,7 @@
smoothing. Since there is nothing in PLStream to track smoothing, we have to
set the FT->smooth_text flag as well at this time.</para>
- <para>The "level 2" initialisation function initialises everything else
+ <para>The "level 2" initialization function initializes everything else
required for using the FreeType library but has to be called after the
screen resolution and dpi have been set. Therefore, it is called at the end
of <literal>plD_init_png()</literal>, where it looks like:
@@ -902,7 +902,7 @@
<para>Some coordinate systems have zero on the bottom, others have zero on
the top. FreeType does it one way, and most everything else does it the
- other. To make sure everything is working ok, we have to "flip" the
+ other. To make sure everything is working OK, we have to "flip" the
coordinates, and to do this we need to know how big in the Y dimension the
page is, and whether we have to invert the page or leave it alone.</para>
@@ -1416,7 +1416,7 @@
current color (as opposed to the background color) at any point in the
plot by selecting any of the colors from either color map 0 or 1 using
calls to &plcol0; or &plcol1;. When the current color is changed all
- subsequent drawing actions will utilise the new color until it is
+ subsequent drawing actions will utilize the new color until it is
changed again.
</para>
@@ -1479,7 +1479,7 @@
<para> There is a one-to-one correspondence between RGB and HLS color
spaces. RGB space is characterized by three 8-bit unsigned integers
corresponding to the intensity of the red, green, and blue colors. Thus,
- in hexidecimal notation with the 3 bytes concatanated together the RGB
+ in hexadecimal notation with the 3 bytes concatenated together the RGB
values of FF0000, FFFF00, 00FF00, 00FFFF, 0000FF, FF00FF, 000000, and
FFFFFF correspond to red, yellow, green, cyan, blue, magenta, black, and
white. </para>
@@ -1504,7 +1504,7 @@
<para> Here are some C-code fragments which use &plscmap1l; to set the
map1 color palette. This first example illustrates how to set up a
- gray-scale pallette using linear interpolation in RGB space.
+ gray-scale palette using linear interpolation in RGB space.
<programlisting> i[0] = 0.;
i[1] = 1.;
@@ -1537,7 +1537,7 @@
</para>
<para> This final example using &plscmap1l; illustrates how the default
- map1 color pallette is set with just 4 control points (taken from
+ map1 color palette is set with just 4 control points (taken from
<filename>src/plctrl.c</filename>).
<programlisting>/*--------------------------------------------------------------------------*\
@@ -1565,7 +1565,7 @@
i[3] = 1; /* right boundary */
/* For center control points, pick black or white, whichever is closer to bg */
- /* Be carefult to pick just short of top or bottom else hue info is lost */
+ /* Be careful to pick just short of top or bottom else hue info is lost */
if (plsc->cmap0 != NULL)
vertex = ((float) plsc->cmap0[0].r +
@@ -1607,7 +1607,7 @@
&plscmap1; so it is the programmer's responsibility to make sure that
the colors vary smoothly. Here is an example of the method taken from
<filename>examples/c/x08c.c</filename> which sets (yet again) the
- gray-scale color pallette.
+ gray-scale color palette.
<programlisting> for (i=0;i<n_col;i++)
rr[i] = gg[i] = bb[i] = i*256/n_col;
@@ -2455,11 +2455,11 @@
</para>
<para>
- Labeling a three-dimensional or mesh plot is somewhat more
+ Labelling a three-dimensional or mesh plot is somewhat more
complicated than a two dimensional plot due to the need for skewing
the characters in the label so that they are parallel to the
coordinate axes. The routine &plbox3; thus combines the functions of
- box drawing and labeling.
+ box drawing and labelling.
</para>
</sect1>
@@ -2778,7 +2778,7 @@
plot and typically identifying certain colors with certain numerical
values using an axis). &pllegend; is useful for visually annotating
most two-dimensional plots. See standard examples 4 and 26 for some
- examples. &plcolorbar; is especially useful for annotating continous
+ examples. &plcolorbar; is especially useful for annotating continuous
shade plots generated by &plshades;. See standard example 16 for an
example.
</para>
Modified: trunk/doc/docbook/src/api-c.xml
===================================================================
--- trunk/doc/docbook/src/api-c.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/api-c.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -40,7 +40,7 @@
<title>The Specialized C API for PLplot</title>
<para>
- The purpose of this chapter is to document the PLPlot C functions that are
+ The purpose of this chapter is to document the PLplot C functions that are
currently not part of the common API,
either because they are C/C++ specific utility
functions (e.g. &plAlloc2dGrid;, &plFree2dGrid;) or because they are not
@@ -636,7 +636,7 @@
<para>
Resets the internal command line options table to the default
- builtin value. Any user options added with &plMergeOpts; will be
+ built in value. Any user options added with &plMergeOpts; will be
cleared. See &plparseopts; for details of how to parse these
options in a program.
</para>
@@ -952,7 +952,7 @@
<sect1 id="pltr1" renderas="sect3">
<title>
<function>pltr1</function>: Linear interpolation for grid to world
- mapping using singly dimensioned coord arrays
+ mapping using singly dimensioned coordinate arrays
</title>
<para>
@@ -972,7 +972,7 @@
<para>
Linear interpolation for grid to world mapping using singly
- dimensioned coord arrays.
+ dimensioned coordinate arrays.
This routine can be used both for &plcont; and &plshade;.
See also <xref linkend="contour-plots-c"/> and
<xref linkend="shade-plots-c"/>.
@@ -1052,7 +1052,7 @@
<sect1 id="pltr2" renderas="sect3">
<title>
<function>pltr2</function>: Linear interpolation for grid to world
- mapping using doubly dimensioned coord arrays (column
+ mapping using doubly dimensioned coordinate arrays (column
dominant, as per normal C 2d arrays)
</title>
@@ -1073,7 +1073,7 @@
<para>
Linear interpolation for grid to world mapping using doubly
- dimensioned coord arrays (column dominant, as per normal C 2d arrays).
+ dimensioned coordinate arrays (column dominant, as per normal C 2d arrays).
This routine can be used both for &plcont; and &plshade;.
See also <xref linkend="contour-plots-c"/> and
<xref linkend="shade-plots-c"/>.
Modified: trunk/doc/docbook/src/api-compat.xml
===================================================================
--- trunk/doc/docbook/src/api-compat.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/api-compat.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -91,7 +91,7 @@
<para>
Since PLplot is developed by so many people, the task of checking for
- backwards compatiblity of the library is very hard. As for the 5.3.1
+ backwards compatibility of the library is very hard. As for the 5.3.1
release, we do not have any rigorous regression test for check
whether the library is really backwards compatible.
</para>
@@ -104,7 +104,7 @@
<para>
Check if there are any changes in
<filename>plplot.h</filename>. If no prototype is changed,
- then the chances are high that no backwards compatibilities
+ then the chances are high that no backwards incompatibilities
have been introduced. If new functions has been added, then
the library soname will be kept, although the soversion
strings in <filename>cmake/module/plplot_version.cmake</filename>
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/api.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -52,8 +52,8 @@
</para>
<para>
- What follows is a list of all common API functions of the current
- CVS HEAD with their arguments except for obsolete/deprecated API
+ What follows is a list of all common API functions of the latest
+ PLplot version with their arguments except for obsolete/deprecated API
functions which are listed in <xref linkend="API-OBSOLETE"/>. The
following information is provided for each function:
<orderedlist>
@@ -632,9 +632,9 @@
</listitem>
<listitem>
<para>
- <literal>o</literal>: Use custom labeling function to
- generate axis label text. The custom labeling function
- can be defined with the plslabelfuncplslabelfunc; command.
+ <literal>o</literal>: Use custom labelling function to
+ generate axis label text. The custom labelling function
+ can be defined with the &plslabelfunc; command.
</para>
</listitem>
<listitem>
@@ -1072,9 +1072,9 @@
</listitem>
<listitem>
<para>
- <literal>o</literal>: Use custom labeling function to
- generate axis label text. The custom labeling function
- can be defined with the plslabelfuncplslabelfunc; command.
+ <literal>o</literal>: Use custom labelling function to
+ generate axis label text. The custom labelling function
+ can be defined with the &plslabelfunc; command.
</para>
</listitem>
<listitem>
@@ -1290,9 +1290,9 @@
</listitem>
<listitem>
<para>
- <literal>o</literal>: Use custom labeling function to
- generate axis label text. The custom labeling function
- can be defined with the plslabelfuncplslabelfunc; command.
+ <literal>o</literal>: Use custom labelling function to
+ generate axis label text. The custom labelling function
+ can be defined with the &plslabelfunc; command.
</para>
</listitem>
<listitem>
@@ -1472,9 +1472,9 @@
</listitem>
<listitem>
<para>
- <literal>o</literal>: Use custom labeling function to
- generate axis label text. The custom labeling function
- can be defined with the plslabelfuncplslabelfunc; command.
+ <literal>o</literal>: Use custom labelling function to
+ generate axis label text. The custom labelling function
+ can be defined with the &plslabelfunc; command.
</para>
</listitem>
<listitem>
@@ -1676,7 +1676,7 @@
and possibly more than one window (set of world coordinates) per
viewport, <literal><parameter>window</parameter></literal>
and the corresponding output world coordinates
- corresponds to the last window created that fulfils the criterion
+ corresponds to the last window created that fulfills the criterion
that the relative device coordinates are inside it. Finally, in
all cases where the input relative device coordinates are not
inside any viewport/window, then
@@ -6557,7 +6557,7 @@
</term>
<listitem>
<para>
- Plot coordinates to strecth the image data to. idata[0][0]
+ Plot coordinates to stretch the image data to. idata[0][0]
corresponds to (xmin, ymin) and idata[nx - 1][ny - 1] corresponds
to (xmax, ymax).
</para>
@@ -8207,7 +8207,7 @@
<para>
<literal><parameter>opt</parameter>=MAG_COLOR</literal>: Each line
in the mesh is colored according to the z value being plotted. The
- color is used from the current colormap 1.
+ color is used from the current color map 1.
</para>
</listitem>
<listitem>
@@ -13434,8 +13434,8 @@
<listitem>
<para>
This is the custom label function. In order to reset to the
- default labeling, set this to <literal>NULL</literal>.
- The labeling function parameters are, in order:
+ default labelling, set this to <literal>NULL</literal>.
+ The labelling function parameters are, in order:
<variablelist>
<varlistentry>
<term><parameter>axis</parameter></term>
@@ -13452,7 +13452,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
- This is the value along the axis which is being labeled.
+ This is the value along the axis which is being labelled.
</para>
</listitem>
</varlistentry>
@@ -14325,7 +14325,7 @@
desired output device must be supplied as an argument. The device
keywords are the same as those printed out by &plstar;. If the
requested device is not available, or if the input string is empty or
- begins with ``?'', the prompted startup of &plstar; is used. This
+ begins with ``?'', the prompted start up of &plstar; is used. This
routine also divides the output device into
<literal><parameter>nx</parameter></literal> by
<literal><parameter>ny</parameter></literal> subpages, each of which
@@ -14343,7 +14343,7 @@
<para>
Device name (keyword) of the required output device. If NULL
or if the first character is a ``?'', the normal (prompted)
- startup is used.
+ start up is used.
</para>
</listitem>
</varlistentry>
@@ -14433,7 +14433,7 @@
<listitem>
<para>
Pointer to a function that defines a transformation from the
- input (x, y) coordinate to a new plot world coordiante.
+ input (x, y) coordinate to a new plot world coordinate.
</para>
</listitem>
</varlistentry>
@@ -14668,7 +14668,7 @@
<sect1 id="plstripa" renderas="sect3">
<title>
- <function>plstripa</function>: Add a point to a stripchart
+ <function>plstripa</function>: Add a point to a strip chart
</title>
<para>
@@ -14686,7 +14686,7 @@
</para>
<para>
- Add a point to a given pen of a given stripchart.
+ Add a point to a given pen of a given strip chart.
There is no need for all pens to have the same number of
points or to be equally sampled in the x coordinate.
Allocates memory and rescales as
@@ -14701,7 +14701,7 @@
</term>
<listitem>
<para>
- Identification number (set up in &plstripc;) of the stripchart.
+ Identification number (set up in &plstripc;) of the strip chart.
</para>
</listitem>
</varlistentry>
@@ -14752,7 +14752,7 @@
<sect1 id="plstripc" renderas="sect3">
<title>
- <function>plstripc</function>: Create a 4-pen stripchart
+ <function>plstripc</function>: Create a 4-pen strip chart
</title>
<para>
@@ -14786,7 +14786,7 @@
</para>
<para>
- Create a 4-pen stripchart, to be used afterwards by &plstripa;
+ Create a 4-pen strip chart, to be used afterwards by &plstripa;
</para>
<variablelist>
@@ -14797,7 +14797,7 @@
</term>
<listitem>
<para>
- Identification number of stripchart to use on &plstripa; and &plstripd;.
+ Identification number of strip chart to use on &plstripa; and &plstripd;.
</para>
</listitem>
</varlistentry>
@@ -15047,7 +15047,7 @@
<sect1 id="plstripd" renderas="sect3">
<title>
<function>plstripd</function>: Deletes and releases memory used by a
- stripchart
+ strip chart
</title>
<para>
@@ -15062,7 +15062,7 @@
</para>
<para>
- Deletes and releases memory used by a stripchart.
+ Deletes and releases memory used by a strip chart.
</para>
<variablelist>
@@ -15073,7 +15073,7 @@
</term>
<listitem>
<para>
- Identification number of stripchart to delete.
+ Identification number of strip chart to delete.
</para>
</listitem>
</varlistentry>
Modified: trunk/doc/docbook/src/bibliography.xml
===================================================================
--- trunk/doc/docbook/src/bibliography.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/bibliography.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -1,6 +1,6 @@
<!-- -*- mode: nxml -*- -->
<!--
- bilbiograpy.xml: "Bibliography" chapter
+ bibliography.xml: "Bibliography" chapter
Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun
Copyright (C) 1999, 2000, 2001, 2002, 2003 Alan W. Irwin and Rafael Laboissiere
Modified: trunk/doc/docbook/src/c.xml
===================================================================
--- trunk/doc/docbook/src/c.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/c.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -118,11 +118,11 @@
<para>
The one additional complicating factor concerns the use of stub routines to
interface with Fortran (see the following section for more explanation). On
- some systems, the Fortran and C namespaces are set up to clobber each other.
+ some systems, the Fortran and C name spaces are set up to clobber each other.
More reasonable (from our viewpoint) is to agree on a standard map between
- namespaces, such as the appending of an underscore to Fortran routine names
+ name spaces, such as the appending of an underscore to Fortran routine names
as is common on many Unix-like systems. The only case where the shared
- Fortran/C namespaces do any good is when passing a pointer to a like data
+ Fortran/C name spaces do any good is when passing a pointer to a like data
type, which represents only a small fraction of the cases that need to
be handled (which includes constant values passed on the stack, strings, and
two-dimensional arrays).
Modified: trunk/doc/docbook/src/cplus.xml
===================================================================
--- trunk/doc/docbook/src/cplus.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/cplus.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -190,7 +190,7 @@
<para>
The <literal>plstream</literal> class will provide an abstract interface to the
2-d drawing functions. Instead of forcing the C++ user to organize
- data in one of a small set of generally braindead data layouts with
+ data in one of a small set of generally brain dead data layouts with
poor memory management properties, potentially forcing the C++ user to
not use a superior method, or to copy data computed in one layout
format to another for plotting (with consequent bug production), the
Modified: trunk/doc/docbook/src/deploying.xml
===================================================================
--- trunk/doc/docbook/src/deploying.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/deploying.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -54,7 +54,7 @@
environment that you use, but that is in general only an option if your
user is comfortable with making programs themselves. A more common
situation is that your user just wants the executable programs and
- wants to get using them rightaway. We will focus on this particular
+ wants to get using them right away. We will focus on this particular
solution, as there are a few non-trivial issues.
</para>
@@ -306,7 +306,7 @@
</para>
<para>
- To summarise the case where you don't have a deb or rpm option, and
+ To summarize the case where you don't have a deb or rpm option, and
you must use inconsistent install locations on your users' machines:
<itemizedlist>
<listitem>
@@ -369,7 +369,7 @@
<envar>LD_LIBRARY_PATH</envar> and equivalents, can be set within
the program (by using a small configuration file or by determining the
position of the files relative to the program's location). They just
- have be set before PLplot is initialised.
+ have be set before PLplot is initialized.
</para>
</chapter>
Modified: trunk/doc/docbook/src/drivers.xml
===================================================================
--- trunk/doc/docbook/src/drivers.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/drivers.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -59,7 +59,7 @@
<para>
Plots are displayed one page at a time. The pager is advanced by
- pressing the Enter key, and may only be advanced in the foreward
+ pressing the Enter key, and may only be advanced in the forward
direction.
</para>
@@ -206,7 +206,7 @@
The available driver options are:
<itemizedlist>
<listitem><para>
- optimise: Optimise PNG palette when possible
+ optimize: Optimize PNG palette when possible
</para></listitem>
<listitem><para>
def_black15: Define idx 15 as black. If the background is
@@ -241,7 +241,7 @@
is based on the libharu library see:
<ulink url="http://libharu.sourceforge.net/">
http://libharu.sourceforge.net/</ulink>.
- At present only the hershey fonts are used and there is no support for
+ At present only the Hershey fonts are used and there is no support for
pdf or ttf fonts. Compression of the pdf output is not enabled and the
paper size can't be chosen. All these issues will be addressed in
later releases.
Modified: trunk/doc/docbook/src/intro.xml
===================================================================
--- trunk/doc/docbook/src/intro.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/intro.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -74,7 +74,7 @@
package. Sze Tan writes:
<blockquote>
<para>
- I'm rather amazed how far PLPLOT has traveled given its origins
+ I'm rather amazed how far PLPLOT has travelled given its origins
etc. I first used PGPLOT on the Starlink VAX computers while I was
a graduate student at the Mullard Radio Astronomy Observatory in
Cambridge from 1983-1987. At the beginning of 1986, I was to give a
@@ -86,7 +86,7 @@
able to draw a line or a dot on the screen in order to do arbitrary
graphics. The application programmer's interface was made as
similar as possible to PGPLOT so that I could easily port my
- programs from the VAX to the PC. The kernel of PLPLOT was modeled
+ programs from the VAX to the PC. The kernel of PLPLOT was modelled
on PGPLOT but the code is not derived from it.
</para>
</blockquote>
@@ -127,7 +127,7 @@
several new routines to enhance usage from Fortran and design of a
portable C to Fortran interface. Additional support was added for
coordinate mappings in contour plots and some bugs fixed. New
- labeling options were added. The font handling code was made more
+ labelling options were added. The font handling code was made more
flexible and portable. A portable PLplot metafile driver and
renderer was developed, allowing one to create a generic graphics
file and do the actual rendering later (even on a different
@@ -161,7 +161,7 @@
<para>
We welcome suggestions on how to improve this code, especially in
the form of user-contributed enhancements or bug fixes. If PLplot
- is used in any published papers, please include an acknowledgment
+ is used in any published papers, please include an acknowledgement
or citation of our work, which will help us to continue improving
PLplot. Please direct all communication to the general PLplot
mailing list, plp...@li....
@@ -175,7 +175,7 @@
the PLplot is by electronic transmission over the Internet. We
encourage others to make it available to users without Internet
access. PLplot is a SourceForge project and may be obtained by
- the usual SourceForge file release and anonymous cvs access that is made
+ the usual SourceForge file release and anonymous svn repository access that is made
available from links at
<ulink url="http://sourceforge.net/projects/plplot">http://sourceforge.net/projects/plplot</ulink>.
</para>
@@ -296,7 +296,7 @@
<sect2 id="additional-copyrights">
<title>Additional Copyrights</title>
<para>
- The startup code used in argument handling
+ The start up code used in argument handling
(<filename>utils/plrender.c</filename> and
<filename>src/plargs.c</filename>) is partially derived from
<filename>xterm.c</filename> of the X11R5 distribution, and its
Modified: trunk/doc/docbook/src/libraries.xml
===================================================================
--- trunk/doc/docbook/src/libraries.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/libraries.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -183,7 +183,7 @@
these limitations are not acceptable for plotting of scientific time
series and are addressed by the qsastime library which was originally
donated under the LGPL to the PLplot project in early 2009 by Anthony
- J. Allen of the QSAS team and substantially modifed after that by a
+ J. Allen of the QSAS team and substantially modified after that by a
PLplot developer, Alan W. Irwin (e.g., to add leap-second
functionality).
</para>
Modified: trunk/doc/docbook/src/ocaml.xml
===================================================================
--- trunk/doc/docbook/src/ocaml.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/ocaml.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -147,7 +147,7 @@
<para>
An important part of the OCaml bindings is the examples, some 31 of
which demonstrate how to use many of the features of the PLplot package.
- These examples also serve as a testbed for the bindings in OCaml and
+ These examples also serve as a test bed for the bindings in OCaml and
other languages by checking the Postscript files that are generated by
each example against those generated by the C versions. These examples
have been completely re-written in OCaml (but retain a C flavor in their
@@ -167,7 +167,7 @@
<title>Obtaining the OCaml compiler</title>
<para>
You will need the OCaml compiler in order to build and use the OCaml
- PLplot bindings. OCaml includes both a bytecode compiler (ocamlc) and
+ PLplot bindings. OCaml includes both a byte code compiler (ocamlc) and
a native code compiler (ocamlopt). Both of these are supported by
PLplot.
</para>
@@ -199,7 +199,7 @@
<ulink url="http://projects.camlcity.org/projects/findlib.html">
findlib
</ulink>
- and its associated tools (ie., ocamlfind) are installed in in your
+ and its associated tools (i.e., ocamlfind) are installed in in your
<literal>$PATH</literal>.
</para>
<para>
Modified: trunk/doc/docbook/src/simple.xml
===================================================================
--- trunk/doc/docbook/src/simple.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/simple.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -232,7 +232,7 @@
<listitem>
<para>
- <parameter>axis</parameter> = 0: Draw box, labeled with
+ <parameter>axis</parameter> = 0: Draw box, labelled with
coordinate values around edge.
</para>
</listitem>
@@ -304,15 +304,15 @@
</para>
<para>
- For greater control over the size of the plots, axis labeling and
+ For greater control over the size of the plots, axis labelling and
tick intervals, more complex graphs should make use of the functions
&plvpor;, &plvasp;, &plvpas;, &plwind;, &plbox;, and routines for
- manipulating axis labeling &plgxax; through &plszax;.
+ manipulating axis labelling &plgxax; through &plszax;.
</para>
</sect1>
<sect1 id="labelling">
- <title>Labeling the Graph</title>
+ <title>Labelling the Graph</title>
<para>
The function &pllab; may be called after &plenv; to write labels on
Modified: trunk/doc/docbook/src/tcl.xml
===================================================================
--- trunk/doc/docbook/src/tcl.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/tcl.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -860,7 +860,7 @@
</para>
<para>
- So, the point is, do your heavy numerics in a compiled language, and
+ So, the point is, do your heavy numerical calculations in a compiled language, and
feel free to use Tcl for the plotting, if you want to. You can of
course mix it up so that some plotting is done from Tcl and some from
a compiled language.
Modified: trunk/doc/docbook/src/wish.xml
===================================================================
--- trunk/doc/docbook/src/wish.xml 2013-09-23 22:07:57 UTC (rev 12520)
+++ trunk/doc/docbook/src/wish.xml 2013-09-24 05:21:15 UTC (rev 12521)
@@ -112,7 +112,7 @@
Having done this, you have essentially created a shell. That is, your
program can now execute shell scripts in the Tcl language. Tcl
provides support for basic control flow, variable substitution file
- i/o and subroutines. In addition to the builtin Tcl commands, you can
+ i/o and subroutines. In addition to the built in Tcl commands, you can
define your own subroutines as Tcl procedures which effectively
become new keywords.
</para>
@@ -480,10 +480,10 @@
/*
- * Specify a user-specific startup file to invoke if the
- * application is run interactively. Typically the startup
+ * Specify a user-specific start up file to invoke if the
+ * application is run interactively. Typically the start up
* file is "~/.apprc" where "app" is the name of the application.
- * If this line is deleted then no user-specific startup file
+ * If this line is deleted then no user-specific start up file
* will be run under any conditions.
*/
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-09-24 22:21:23
|
Revision: 12525
http://sourceforge.net/p/plplot/code/12525
Author: airwin
Date: 2013-09-24 22:21:20 +0000 (Tue, 24 Sep 2013)
Log Message:
-----------
Fix broken URL's contained inside ulink elements of our DocBook
documentation.
Modified Paths:
--------------
trunk/doc/docbook/src/ada.xml
trunk/doc/docbook/src/deploying.xml
trunk/doc/docbook/src/drivers.xml
trunk/doc/docbook/src/intro.xml
trunk/doc/docbook/src/os_notes.xml
trunk/doc/docbook/src/perl.xml
trunk/doc/docbook/src/wish.xml
Modified: trunk/doc/docbook/src/ada.xml
===================================================================
--- trunk/doc/docbook/src/ada.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/ada.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -957,10 +957,10 @@
using OS X and is supported by PLplot. It is a native Cocoa graphics
"terminal" that is highly recommended. All output is antialiased and is
easily cut-and-pasted in OS X's native PDF format. Get it <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=39915">here</ulink>.
+ url="http://sourceforge.net/projects/aquaterm/files">here</ulink>.
It can also be installed from either the <ulink
- url="http://www.finkproject.org/">Fink</ulink> or <ulink
- url="http://www.macports.org/projects.">MacPorts</ulink>
+ url="http://fink.thetis.ig42.org/">Fink</ulink> or <ulink
+ url="http://www.macports.org/">MacPorts</ulink>
projects.</para>
</sect2>
@@ -982,7 +982,7 @@
GNAT that comes packaged using the usual Apple software installer and is
strongly recommended. This compiler is available for both PowerPC and
Intel Macintoshes at <ulink
- url="http://www.macada.org/macada/Welcome.html.">www.macada.org</ulink>.
+ url="http://www.macada.org/macada/Welcome.html">www.macada.org</ulink>.
This site is traditionally rather confusing but the mailing list is
extremely helpful. The installer also includes an Ada-specific plug-in
for Apple's Xcode IDE which is strongly recommended if you plan to work
Modified: trunk/doc/docbook/src/deploying.xml
===================================================================
--- trunk/doc/docbook/src/deploying.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/deploying.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -88,7 +88,7 @@
user's machine is to use PLplot deb binary packages for the <ulink
url="http://www.debian.org">Debian</ulink> distribution, and PLplot rpm
binary packages for rpm-based distributions. (See the <ulink
- url="http://plplot.sourceforge.net/resources/index.html">Resources
+ url="http://plplot.sourceforge.net/download.php">download
area</ulink> of the PLplot web site for locations of debs and rpms.)
Build the application on the build machine using the results of the
<userinput>pkg-config --cflags --libs plplotd</userinput> command, and copy
Modified: trunk/doc/docbook/src/drivers.xml
===================================================================
--- trunk/doc/docbook/src/drivers.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/drivers.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -239,8 +239,8 @@
<para>
A basic version of a pdf driver has been added to PLplot. This driver
is based on the libharu library see:
- <ulink url="http://libharu.sourceforge.net/">
- http://libharu.sourceforge.net/</ulink>.
+ <ulink url="http://libharu.org/">
+ libharu.org</ulink>.
At present only the Hershey fonts are used and there is no support for
pdf or ttf fonts. Compression of the pdf output is not enabled and the
paper size can't be chosen. All these issues will be addressed in
@@ -312,8 +312,8 @@
to work. The pango and pangoft2 libraries are widely distributed
with most Linux distributions and give the psttf driver full complex
text layout (CTL) capability (see
- <ulink url="http://plplot.sourceforge.net/examples/demo24.php">
- http://plplot.sourceforge.net/examples/demo24.php</ulink>
+ <ulink url="http://plplot.sourceforge.net/examples.php?demo=24">
+ http://plplot.sourceforge.net/examples.php?demo=24</ulink>
for an example of this capability). The LASi library is not part of
most distributions at this time. The source code can be downloaded
from http://www.unifont.org/lasi/. The library is small and easy to
Modified: trunk/doc/docbook/src/intro.xml
===================================================================
--- trunk/doc/docbook/src/intro.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/intro.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -195,7 +195,7 @@
to make the desired PLplot calls. Example programs in C, C++,
Fortran77, Fortran95 and Java are included as a guide.
Plots generated from the example programs are shown
- <ulink url="http://&PLplot-website;/examples/index.html">here</ulink>.
+ <ulink url="http://&PLplot-website;/examples.php">here</ulink>.
</para>
<para>
You will then need to compile your program and link it with the
Modified: trunk/doc/docbook/src/os_notes.xml
===================================================================
--- trunk/doc/docbook/src/os_notes.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/os_notes.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -69,7 +69,7 @@
</para>
<para>
The longer (CMake) story is currently documented <ulink
- url="http://www.miscdebris.net/plplot_wiki/index.php?title=Main_Page#Building_PLplot_with_our_new_CBS">here</ulink>.
+ url="http://www.miscdebris.net/plplot_wiki/index.php?title=Building_PLplot">here</ulink>.
The eventual plan is to incorporate that material in this documentation,
but we haven't done it yet so this section NEEDS DOCUMENTATION.
</para>
@@ -92,8 +92,8 @@
<sect2>
<title>Windows Configure and Build</title>
<para>
- This (CMake) story currently documented <ulink
- url="http://www.miscdebris.net/plplot_wiki/index.php?title=Main_Page#Windows">here</ulink>.
+ This (CMake) story is currently documented <ulink
+ url="http://www.miscdebris.net/plplot_wiki/index.php?title=Specifics_for_various_platforms#Windows">here</ulink>.
The eventual plan is to incorporate that material into this documentation,
but we haven't done it yet so this section NEEDS DOCUMENTATION.
</para>
Modified: trunk/doc/docbook/src/perl.xml
===================================================================
--- trunk/doc/docbook/src/perl.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/perl.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -99,7 +99,7 @@
There is also a Perl PLplot interface on <ulink
url="http://www.cpan.org">CPAN</ulink> which is not dependent on PDL.
The Perl module is called <ulink
- url="http://search.cpan.org/%7Etjenness/">Graphics::PLplot</ulink> and is
+ url="http://search.cpan.org/~tjenness/Graphics-PLplot/">Graphics::PLplot</ulink> and is
appropriate for small data arrays. The API is very similar to the C
API except that if the number of elements in an array is required by
the C function the perl interface calculates it automatically. Also,
Modified: trunk/doc/docbook/src/wish.xml
===================================================================
--- trunk/doc/docbook/src/wish.xml 2013-09-24 16:51:13 UTC (rev 12524)
+++ trunk/doc/docbook/src/wish.xml 2013-09-24 22:21:20 UTC (rev 12525)
@@ -141,30 +141,13 @@
<para>
There are several important sources of info and code for Tcl.
- Definitely get the book mentioned above. The Tcl and Tk toolkits
- are distributed by anonymous <command>ftp</command> at <ulink
- url="ftp://sprite.berkeley.edu/tcl"><filename>sprite.berkeley.edu:/tcl</filename></ulink>.
- There are several files in there corresponding to Tcl, Tk, and
- various forms of documentation. At the time of this writing, the
- current versions of Tcl and Tk are 7.3 and 3.6 respectively.
- Retrieve those files, and install using the instructions provided
- therein.
+ Definitely get the book mentioned above, and the source code for the
+ Tcl and Tk toolkits can be downloaded from <ulink
+ url="http://www.tcl.tk/software/tcltk/download.html">The Tcl developer
+ Xchange</ulink>.
</para>
<para>
- The other major anonymous <command>ftp</command> site for Tcl is
- <ulink
- url="ftp://harbor.ecn.purdue.edu/pub/tcl"><filename>harbor.ecn.purdue.edu:/pub/tcl</filename></ulink>.
- Harbor contains a mirror of <literal>sprite</literal> as well as
- innumerable extensions, Tcl/Tk packages, tutorials, documentation,
- etc. The level of excitement in the Tcl community is
- extraordinarily high, and this is reflected by the great plethora
- of available, high quality, packages and extensions available for
- use with Tcl and Tk. Explore—there is definitely something
- for everyone.
- </para>
-
- <para>
Additionally there is a newsgroup, <literal>comp.lang.tcl</literal>
which is well read, and an excellent place for people to get
oriented, find help, etc. Highly recommended.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2013-10-05 19:00:40
|
Revision: 12579
http://sourceforge.net/p/plplot/code/12579
Author: airwin
Date: 2013-10-05 19:00:37 +0000 (Sat, 05 Oct 2013)
Log Message:
-----------
Use a dblatex stylesheet to set the FreeSans, FreeSerif, and
FreeMono fonts as the default for the PDF DocBook result.
These rather comprehensive fonts (in fact the most
comprehensive that I am aware of) allow a rather wide range
of unicode glyphs in the DocBook source to be correctly
rendered in the pdf results.
Modified Paths:
--------------
trunk/doc/docbook/src/CMakeLists.txt
Added Paths:
-----------
trunk/doc/docbook/src/dblatex_stylesheet.xsl
Modified: trunk/doc/docbook/src/CMakeLists.txt
===================================================================
--- trunk/doc/docbook/src/CMakeLists.txt 2013-10-05 12:06:48 UTC (rev 12578)
+++ trunk/doc/docbook/src/CMakeLists.txt 2013-10-05 19:00:37 UTC (rev 12579)
@@ -391,7 +391,7 @@
if(DOCBOOK_DBLATEX_BACKEND)
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf
- COMMAND ${DBLATEX} --verbose --backend=xetex --type=pdf -o ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
+ COMMAND ${DBLATEX} --xsl-user=${CMAKE_CURRENT_SOURCE_DIR}/dblatex_stylesheet.xsl --backend=xetex --type=pdf -o ${CMAKE_CURRENT_BINARY_DIR}/${BASE}.pdf ${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
DEPENDS
${SOURCE_FILES}
${CMAKE_CURRENT_BINARY_DIR}/${PLPLOTDOC}-print.xml
Added: trunk/doc/docbook/src/dblatex_stylesheet.xsl
===================================================================
--- trunk/doc/docbook/src/dblatex_stylesheet.xsl (rev 0)
+++ trunk/doc/docbook/src/dblatex_stylesheet.xsl 2013-10-05 19:00:37 UTC (rev 12579)
@@ -0,0 +1,11 @@
+<?xml version='1.0' encoding="UTF-8"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version='1.0'>
+ <xsl:param name="xetex.font">
+ <xsl:text>\setmainfont{FreeSerif}
+ </xsl:text>
+ <xsl:text>\setsansfont{FreeSans}
+ </xsl:text>
+ <xsl:text>\setmonofont{FreeMono}
+ </xsl:text>
+ </xsl:param>
+</xsl:stylesheet>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2014-01-24 05:11:58
|
Revision: 12956
http://sourceforge.net/p/plplot/code/12956
Author: airwin
Date: 2014-01-24 05:11:55 +0000 (Fri, 24 Jan 2014)
Log Message:
-----------
Implement long-overdue documentation for plbtime, plconfigtime, and
plctime. Thanks to H?\199?\142ili?\195?\160ng Wang for writing the plplot.h/api.xml
consistency checker that discovered these (and 6 other functions in our
public API) were missing documentation.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2014-01-23 14:07:07 UTC (rev 12955)
+++ trunk/doc/docbook/src/api.xml 2014-01-24 05:11:55 UTC (rev 12956)
@@ -1565,6 +1565,154 @@
</sect1>
+ <sect1 id="plbtime" renderas="sect3">
+ <title>
+ <function>plbtime</function>: Calculate broken-down time from
+ continuous time for the current stream
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plbtime</function>
+ </funcdef>
+ <paramdef><parameter>year</parameter></paramdef>
+ <paramdef><parameter>month</parameter></paramdef>
+ <paramdef><parameter>day</parameter></paramdef>
+ <paramdef><parameter>hour</parameter></paramdef>
+ <paramdef><parameter>min</parameter></paramdef>
+ <paramdef><parameter>sec</parameter></paramdef>
+ <paramdef><parameter>ctime</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+ <para>
+ Calculate broken-down time;
+ <literal><parameter>year</parameter></literal>,
+ <literal><parameter>month</parameter></literal>,
+ <literal><parameter>day</parameter></literal>,
+ <literal><parameter>hour</parameter></literal>,
+ <literal><parameter>min</parameter></literal>,
+ <literal><parameter>sec</parameter></literal>; from
+ continuous time, <literal><parameter>ctime</parameter></literal>
+ for the current stream. This function is the inverse
+ of &plctime;.
+ </para>
+ <para>
+ The PLplot definition of broken-down time is a calendar time
+ that completely ignores all time zone offsets, i.e., it is the
+ user's responsibility to apply those offsets (if so desired)
+ before using the PLplot time API. By default broken-down time
+ is defined using the proleptic Gregorian calendar without the
+ insertion of leap seconds and continuous time is defined as the
+ number of seconds since the Unix epoch of 1970-01-01T00:00:00Z.
+ However, other definitions of broken-down and continuous time
+ are possible, see &plconfigtime;.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>year</parameter>
+ (<literal>PLINT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Output year.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>month</parameter>
+ (<literal>PLINT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Output month in range from 0 (January) to 11 (December).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>day</parameter>
+ (<literal>PLINT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Output day in range from 1 to 31.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>hour</parameter>
+ (<literal>PLINT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Output hour in range from 0 to 23.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>min</parameter>
+ (<literal>PLINT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Output minute in range from 0 to 59
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>sec</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Output second in floating range from 0. to 60.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>ctime</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Continous time from which the broken-down time is calculated.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form:
+ <itemizedlist>
+ <listitem>
+ <para>
+ General: <function>plbtime(year, month, day, hour, min, sec, ctime)</function>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perl/PDL: Not available?
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ This function is used in example 29.
+ </para>
+
+ </sect1>
+
<sect1 id="plcalc_world" renderas="sect3">
<title>
<function>plcalc_world</function>: Calculate world coordinates and
@@ -2317,6 +2465,233 @@
</sect1>
+ <sect1 id="plconfigtime" renderas="sect3">
+ <title>
+ <function>plconfigtime</function>: Configure the transformation
+ between continuous and broken-down time for the current stream
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plconfigtime</function>
+ </funcdef>
+ <paramdef><parameter>scale</parameter></paramdef>
+ <paramdef><parameter>offset1</parameter></paramdef>
+ <paramdef><parameter>offset2</parameter></paramdef>
+ <paramdef><parameter>ccontrol</parameter></paramdef>
+ <paramdef><parameter>ifbtime_offset</parameter></paramdef>
+ <paramdef><parameter>year</parameter></paramdef>
+ <paramdef><parameter>month</parameter></paramdef>
+ <paramdef><parameter>day</parameter></paramdef>
+ <paramdef><parameter>hour</parameter></paramdef>
+ <paramdef><parameter>min</parameter></paramdef>
+ <paramdef><parameter>sec</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Configure the transformation
+ between continuous and broken-down time
+ for the current stream. This transformation is
+ used by both &plbtime; and &plctime;.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>scale</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The number of days per continuous time unit. As a special
+ case, if <parameter>scale</parameter> is 0., then all
+ other arguments are ignored, and the result (the default
+ used by PLplot) is the equivalent of a call to
+ plconfigtime(1./86400., 0., 0., 0x0, 1, 1970, 0, 1, 0, 0, 0.).
+ That is, for this special case broken-down time is
+ calculated with the proleptic Gregorian calendar with no
+ leap seconds inserted, and the continuous time is defined
+ as the number of seconds since the Unix epoch of
+ 1970-01-01T00:00:00Z.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>offset1</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ If <parameter>ifbtime_offset</parameter> is true, the
+ parameters <parameter>offset1</parameter> and
+ <parameter>offset2</parameter> are completely ignored.
+ Otherwise, the sum of these parameters (with units in
+ days) specify the epoch of the continuous time relative to
+ the MJD epoch corresponding to the Gregorian calendar date
+ of 1858-11-17T00:00:00Z or JD = 2400000.5. Two PLFLT numbers
+ are used to specify the origin to allow users (by
+ specifying <parameter>offset1</parameter> as an integer
+ that can be exactly represented by a
+ floating-point variable and specifying
+ <parameter>offset2</parameter> as a number in the range
+ from 0. to 1) the chance to minimize the numerical errors of
+ the continuous time representation.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>offset2</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ See documentation of <parameter>offset1</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>ccontrol</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <parameter>ccontrol</parameter> contains bits controlling
+ the transformation. If the 0x1 bit is set, then the
+ proleptic Julian calendar is used for broken-down time
+ rather than the proleptic Gregorian calendar. If the 0x2
+ bit is set, then leap seconds that have been historically
+ used to define UTC are inserted into the broken-down time.
+ Other possibilities for additional control bits for
+ ccontrol exist such as making the historical time
+ corrections in the broken-down time corresponding to ET
+ (ephemeris time) or making the (slightly non-constant)
+ corrections from international atomic time (TAI) to what
+ astronomers define as terrestrial time (TT). But those
+ additional possibilities have not been implemented yet in
+ the qsastime library (one of the PLplot utility
+ libraries).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>ifbzero_control</parameter>
+ (<literal>PLBOOL</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <parameter>ifbzero_control</parameter> controls how the
+ epoch of the continuous time scale is specified by the
+ user. If <parameter>ifbzero_control</parameter> is false,
+ then <parameter>offset1</parameter> and
+ <parameter>offset2</parameter> are used to specify the
+ epoch, and the following broken-down time parameters are
+ completely ignored. If
+ <parameter>ifbzero_control</parameter> is true, then
+ <parameter>offset1</parameter> and
+ <parameter>offset2</parameter> are completely ignored, and
+ the following broken-down time parameters are used to
+ specify the epoch.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>year</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Year of epoch.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>month</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Month of epoch in range from 0 (January) to 11 (December).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>day</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Day of epoch in range from 1 to 31.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>hour</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Hour of epoch in range from 0 to 23
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>min</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Minute of epoch in range from 0 to 59.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>sec</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Second of epoch in floating range from 0. to 60.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form:
+ <itemizedlist>
+ <listitem>
+ <para>
+ General: <function>plconfigtime(scale, offset1, offset2, ccontrol, ifbtime_offset, year, month, day, hour, min, sec)</function>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perl/PDL: Not available?
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ This function is used in example 29.
+ </para>
+
+ </sect1>
+
<sect1 id="plcont" renderas="sect3">
<title>
<function>plcont</function>: Contour plot
@@ -2578,6 +2953,156 @@
</sect1>
+ <sect1 id="plctime" renderas="sect3">
+ <title>
+ <function>plctime</function>: Calculate continuous time from
+ broken-down time for the current stream
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plctime</function>
+ </funcdef>
+ <paramdef><parameter>year</parameter></paramdef>
+ <paramdef><parameter>month</parameter></paramdef>
+ <paramdef><parameter>day</parameter></paramdef>
+ <paramdef><parameter>hour</parameter></paramdef>
+ <paramdef><parameter>min</parameter></paramdef>
+ <paramdef><parameter>sec</parameter></paramdef>
+ <paramdef><parameter>ctime</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+ <para>
+ Calculate continuous time, <literal><parameter>ctime</parameter></literal>,
+ from broken-down time for the current stream. The broken-down
+time is specified by the following parameters:
+ <literal><parameter>year</parameter></literal>,
+ <literal><parameter>month</parameter></literal>,
+ <literal><parameter>day</parameter></literal>,
+ <literal><parameter>hour</parameter></literal>,
+ <literal><parameter>min</parameter></literal>, and
+ <literal><parameter>sec</parameter></literal>.
+ This function is the inverse of &plbtime;.
+ </para>
+ <para>
+ The PLplot definition of broken-down time is a calendar time
+ that completely ignores all time zone offsets, i.e., it is the
+ user's responsibility to apply those offsets (if so desired)
+ before using the PLplot time API. By default broken-down time
+ is defined using the proleptic Gregorian calendar without the
+ insertion of leap seconds and continuous time is defined as the
+ number of seconds since the Unix epoch of 1970-01-01T00:00:00Z.
+ However, other definitions of broken-down and continuous time
+ are possible, see &plconfigtime; which specifies that
+ transformation for the current stream.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>year</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Input year.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>month</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Input month in range from 0 (January) to 11 (December).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>day</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Input day in range from 1 to 31.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>hour</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Input hour in range from 0 to 23
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>min</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Input minute in range from 0 to 59.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>sec</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Input second in floating range from 0. to 60.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>ctime</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Continous time calculated from the broken-down time
+ specified by the previous parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form:
+ <itemizedlist>
+ <listitem>
+ <para>
+ General: <function>plctime(year, month, day, hour, min, sec, ctime)</function>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Perl/PDL: Not available?
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ This function is used in example 29.
+ </para>
+
+ </sect1>
+
<sect1 id="plend" renderas="sect3">
<title>
<function>plend</function>: End plotting session
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-23 14:07:07 UTC (rev 12955)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-24 05:11:55 UTC (rev 12956)
@@ -84,7 +84,7 @@
<!ENTITY plbop '<link linkend="plbop"><function>plbop</function></link>'>
<!ENTITY plbox '<link linkend="plbox"><function>plbox</function></link>'>
<!ENTITY plbox3 '<link linkend="plbox3"><function> plbox3</function></link>'>
-<!ENTITY plbtime '<link linkend="plbox3"><function> plbox3</function></link>'>
+<!ENTITY plbtime '<link linkend="plbtime"><function> plbtime</function></link>'>
<!ENTITY plcalc_world '<link linkend="plcalc_world"><function> plcalc_world</function></link>'>
<!ENTITY plclear '<link linkend="plclear"><function>plclear</function></link>'>
<!ENTITY plClearOpts '<link linkend="plClearOpts"><function>plClearOpts</function></link>'>
@@ -95,11 +95,11 @@
<!ENTITY plcon1 '<link linkend="plcon1"><function>plcon1</function></link>'>
<!ENTITY plcon2 '<link linkend="plcon2"><function>plcon2</function></link>'>
<!ENTITY plconf '<link linkend="plconf"><function>plconf</function></link>'>
-<!ENTITY plconfigtime '<link linkend="plconfigtime"><function>plconf</function></link>'>
+<!ENTITY plconfigtime '<link linkend="plconfigtime"><function>plconfigtime</function></link>'>
<!ENTITY plcont '<link linkend="plcont"><function>plcont</function></link>'>
<!ENTITY plcontfortran95 '<link linkend="plcontfortran95"><function>plcontfortran95</function></link>'>
<!ENTITY plcpstrm '<link linkend="plcpstrm"><function>plcpstrm</function></link>'>
-<!ENTITY plctime '<link linkend="plctime"><function>plend</function></link>'>
+<!ENTITY plctime '<link linkend="plctime"><function>plctime</function></link>'>
<!ENTITY plend '<link linkend="plend"><function>plend</function></link>'>
<!ENTITY plend1 '<link linkend="plend1"><function>plend1</function></link>'>
<!ENTITY plenv0 '<link linkend="plenv0"><function>plenv0</function></link>'>
@@ -234,7 +234,7 @@
<!ENTITY plsym '<link linkend="plsym"><function>plsym</function></link>'>
<!ENTITY plszax '<link linkend="plszax"><function>plszax</function></link>'>
<!ENTITY pltext '<link linkend="pltext"><function>pltext</function></link>'>
-<!ENTITY pltimefmt '<link linkend="pltimefmt"><function>pltr0</function></link>'>
+<!ENTITY pltimefmt '<link linkend="pltimefmt"><function>pltimefmt</function></link>'>
<!ENTITY pltr0 '<link linkend="pltr0"><function>pltr0</function></link>'>
<!ENTITY pltr1 '<link linkend="pltr1"><function>pltr1</function></link>'>
<!ENTITY pltr2 '<link linkend="pltr2"><function>pltr2</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2014-01-24 08:34:56
|
Revision: 12957
http://sourceforge.net/p/plplot/code/12957
Author: airwin
Date: 2014-01-24 08:34:51 +0000 (Fri, 24 Jan 2014)
Log Message:
-----------
Implement documentation for plgcmap1_range and plscmap1_range.
Thanks to H?\199?\142ili?\195?\160ng Wang for writing the plplot.h/api.xml
consistency checker that discovered these functions in our
public API did not have any documentation in api.xml.
ToDo: There are still 4 more functions that are missing documentation
according to that checker report and also inconsistencies between
plplot.h and api.xml in the number and names of the function
arguments.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2014-01-24 05:11:55 UTC (rev 12956)
+++ trunk/doc/docbook/src/api.xml 2014-01-24 08:34:51 UTC (rev 12957)
@@ -4559,6 +4559,64 @@
</sect1>
+ <sect1 id="plgcmap1_range" renderas="sect3">
+ <title>
+ <function>plgcmap1_range</function>: Get the cmap1 argument
+ range for continuous color plots
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plgcmap1_range</function>
+ </funcdef>
+ <paramdef><parameter>min_color</parameter></paramdef>
+ <paramdef><parameter>max_color</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Get the cmap1 argument range for continuous color plots.
+ (Use &plscmap1_range; to set the cmap1 argument range.)
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>min_color</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to the current minimum cmap1 floating point argument.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>max_color</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to the current maximum cmap1 floating point argument.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plgcmap1_range(min_color, max_color)</function>
+ </para>
+
+ <para>
+ This function is currently not used in any example.
+ </para>
+
+ </sect1>
+
<sect1 id="plgcol0" renderas="sect3">
<title>
<function>plgcol0</function>: Returns 8-bit RGB values for given color
@@ -11157,6 +11215,69 @@
</sect1>
+ <sect1 id="plscmap1_range" renderas="sect3">
+ <title>
+ <function>plscmap1_range</function>: Set the cmap1 argument
+ range for continuous color plots
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plscmap1_range</function>
+ </funcdef>
+ <paramdef><parameter>min_color</parameter></paramdef>
+ <paramdef><parameter>max_color</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Set the cmap1 argument range for continuous color
+ plots. If <parameter>min_color</parameter> is greater than
+ <parameter>max_color</parameter> or
+ <parameter>max_color</parameter> is greater than 1.0 or
+ <parameter>min_color</parameter> is less than 0.0 then no change
+ is made. (Use &plgcmap1_range; to get the cmap1
+ argument range.)
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>min_color</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The minimum cmap1 floating point argument.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>max_color</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The maximum cmap1 floating point argument.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plscmap1_range(min_color, max_color)</function>
+ </para>
+
+ <para>
+ This function is currently used in example 33.
+ </para>
+
+ </sect1>
+
<sect1 id="plscmap1" renderas="sect3">
<title>
<function>plscmap1</function>: Set color map1 colors using 8-bit RGB
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-24 05:11:55 UTC (rev 12956)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-24 08:34:51 UTC (rev 12957)
@@ -116,6 +116,7 @@
<!ENTITY plfontld '<link linkend="plfontld"><function>plfontld</function></link>'>
<!ENTITY plFree2dGrid '<link linkend="plFree2dGrid"><function>plFree2dGrid</function></link>'>
<!ENTITY plgch '<link linkend="plgch"><function>plgch</function></link>'>
+<!ENTITY plgcmap1_range '<link linkend="plgcmap1_range"><function>plgcmap1_range</function></link>'>
<!ENTITY plgcol0 '<link linkend="plgcol0"><function>plgcol0</function></link>'>
<!ENTITY plgcolbg '<link linkend="plgcolbg"><function>plgcolbg</function></link>'>
<!ENTITY plgcompression '<link linkend="plgcompression"><function>plgcompression</function></link>'>
@@ -182,6 +183,7 @@
<!ENTITY plschr '<link linkend="plschr"><function>plschr</function></link>'>
<!ENTITY plscmap0 '<link linkend="plscmap0"><function>plscmap0</function></link>'>
<!ENTITY plscmap0n '<link linkend="plscmap0n"><function>plscmap0n</function></link>'>
+<!ENTITY plscmap1_range '<link linkend="plscmap1_range"><function>plgsmap1_range</function></link>'>
<!ENTITY plscmap1 '<link linkend="plscmap1"><function>plscmap1</function></link>'>
<!ENTITY plscmap1l '<link linkend="plscmap1l"><function>plscmap1l</function></link>'>
<!ENTITY plscmap1n '<link linkend="plscmap1n"><function>plscmap1n</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
|
From: <ai...@us...> - 2014-01-25 19:47:33
|
Revision: 12958
http://sourceforge.net/p/plplot/code/12958
Author: airwin
Date: 2014-01-25 19:47:30 +0000 (Sat, 25 Jan 2014)
Log Message:
-----------
Document plgdrawmode and plsdrawmode.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2014-01-24 08:34:51 UTC (rev 12957)
+++ trunk/doc/docbook/src/api.xml 2014-01-25 19:47:30 UTC (rev 12958)
@@ -5266,6 +5266,45 @@
</sect1>
+ <sect1 id="plgdrawmode" renderas="sect3">
+ <title>
+ <function>plgdrawmode</function>: Get drawing mode (depends on
+device support!)
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plgdrawmode</function>
+ </funcdef>
+ <paramdef></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Get drawing mode. Note only one device driver (cairo) currently
+ supports this at the moment, and for that case the PLINT value
+ returned by this function is one of
+ <literal>PL_DRAWMODE_DEFAULT</literal>,
+ <literal>PL_DRAWMODE_REPLACE</literal>,
+ <literal>PL_DRAWMODE_XOR</literal>, or
+ <literal>PL_DRAWMODE_UNKNOWN</literal>. This function returns
+ <literal>PL_DRAWMODE_UNKNOWN</literal> for the rest of the
+ device drivers. See also &plsdrawmode;.
+ </para>
+
+ <para>
+ Redacted form: <function>plgdrawmode()</function>
+ </para>
+
+ <para>
+ This function is used in example 34.
+ </para>
+
+ </sect1>
+
<sect1 id="plgfam" renderas="sect3">
<title>
<function>plgfam</function>: Get family file parameters
@@ -5337,7 +5376,6 @@
</sect1>
-
<sect1 id="plgfci" renderas="sect3">
<title>
<function>plgfci</function>: Get FCI (font characterization integer)
@@ -12757,6 +12795,55 @@
</sect1>
+ <sect1 id="plsdrawmode" renderas="sect3">
+ <title>
+ <function>plsdrawmode</function>: Set drawing mode (depends on
+device support!)
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plsdrawmode</function>
+ </funcdef>
+ <paramdef>mode</paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Set drawing mode. Note only one device driver (cairo) currently
+ supports this at the moment. See also &plgdrawmode;.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>mode</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Control variable which species the drawing mode (one of
+ <literal>PL_DRAWMODE_DEFAULT</literal>,
+ <literal>PL_DRAWMODE_REPLACE</literal>, or
+ <literal>PL_DRAWMODE_XOR</literal>) to use.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plsdrawmode(mode)</function>
+ </para>
+
+ <para>
+ This function is used in example 34.
+ </para>
+
+ </sect1>
+
<sect1 id="plseed" renderas="sect3">
<title>
<function>plseed</function>: Set seed for internal random
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-24 08:34:51 UTC (rev 12957)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2014-01-25 19:47:30 UTC (rev 12958)
@@ -125,6 +125,7 @@
<!ENTITY plgdiori '<link linkend="plgdiori"><function>plgdiori</function></link>'>
<!ENTITY plgdiplt '<link linkend="plgdiplt"><function>plgdiplt</function></link>'>
<!ENTITY plGetCursor '<link linkend="plGetCursor"><function>plGetCursor</function></link>'>
+<!ENTITY plgdrawmode '<link linkend="plgdrawmode"><function>plgdrawmode</function></link>'>
<!ENTITY plgfam '<link linkend="plgfam"><function>plgfam</function></link>'>
<!ENTITY plgfci '<link linkend="plgfci"><function>plgfci</function></link>'>
<!ENTITY plgfnam '<link linkend="plgfnam"><function>plgfnam</function></link>'>
@@ -197,6 +198,7 @@
<!ENTITY plsdiori '<link linkend="plsdiori"><function>plsdiori</function></link>'>
<!ENTITY plsdiplt '<link linkend="plsdiplt"><function>plsdiplt</function></link>'>
<!ENTITY plsdiplz '<link linkend="plsdiplz"><function>plsdiplz</function></link>'>
+<!ENTITY plsdrawmode '<link linkend="plsdrawmode"><function>plsdrawmode</function></link>'>
<!ENTITY plseed '<link linkend="plseed"><function>plseed</function></link>'>
<!ENTITY plsesc '<link linkend="plsesc"><function>plsesc</function></link>'>
<!ENTITY plsescfortran95 '<link linkend="plsescfortran95"><function>plsescfortran95</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X