From 364d8460de8923711c2d3f85f3142cb115135851 Mon Sep 17 00:00:00 2001 From: Olaf Meeuwissen Date: Mon, 21 Oct 2019 13:40:08 +0900 Subject: [PATCH] Convert :raw-latex: markers in pandoc generated tables This also reworks the table layout and fixes cross-references for those tables. --- net.rst | 190 ++++++++++++++++++++++++++++++++----------------------- sane.rst | 168 ++++++++++++++++++++++++------------------------ 2 files changed, 192 insertions(+), 166 deletions(-) diff --git a/net.rst b/net.rst index 8ebff44..e9d96c9 100644 --- a/net.rst +++ b/net.rst @@ -166,13 +166,16 @@ This RPC establishes a connection to a particular SANE network daemon. It must be the first call in a SANE network session. The parameter and reply arguments for this call are shown in the table below: -+----------------------------------------------+----------------------------------------------+ -| **request:** | **reply:** | -+----------------------------------------------+----------------------------------------------+ -| :raw-latex:`\code{SANE_Word version_code}` | :raw-latex:`\code{SANE_Word status}` | -+----------------------------------------------+----------------------------------------------+ -| :raw-latex:`\code{SANE_String user_name}` | :raw-latex:`\code{SANE_Word version_code}` | -+----------------------------------------------+----------------------------------------------+ +.. table:: + :align: center + + +----------------------------------------+----------------------------------------+ + | request | reply | + +========================================+========================================+ + | :type:`SANE_Word` :data:`version_code` | :type:`SANE_Word` :data:`status` | + +----------------------------------------+----------------------------------------+ + | :type:`SANE_String` :data:`user_name` | :type:`SANE_Word` :data:`version_code` | + +----------------------------------------+----------------------------------------+ The :data:`version_code` argument in the request is the SANE version-code of the network backend that is contacting the network @@ -206,13 +209,16 @@ in this version code. This RPC is used to obtain the list of devices accessible by the SANE daemon. -+----------------------------+--------------------------------------------------+ -| **request:** | **reply:** | -+----------------------------+--------------------------------------------------+ -| :raw-latex:`\code{void}` | :raw-latex:`\code{SANE_Word status}` | -+----------------------------+--------------------------------------------------+ -| | :raw-latex:`\code{SANE_Device ***device_list}` | -+----------------------------+--------------------------------------------------+ +.. table:: + :align: center + + +--------------+--------------------------------------------+ + | request | reply | + +==============+============================================+ + | :type:`void` | :type:`SANE_Word` :data:`status` | + +--------------+--------------------------------------------+ + | | :type:`SANE_Device` :data:`***device_list` | + +--------------+--------------------------------------------+ There are no arguments in the request for this call. @@ -230,15 +236,18 @@ pointer to a :macro:`NULL`-terminated array of This RPC is used to open a connection to a remote SANE device. -+-----------------------------------------------+--------------------------------------------+ -| **request:** | **reply:** | -+-----------------------------------------------+--------------------------------------------+ -| :raw-latex:`\code{SANE_String device_name}` | :raw-latex:`\code{SANE_Word status}` | -+-----------------------------------------------+--------------------------------------------+ -| | :raw-latex:`\code{SANE_Word handle}` | -+-----------------------------------------------+--------------------------------------------+ -| | :raw-latex:`\code{SANE_String resource}` | -+-----------------------------------------------+--------------------------------------------+ +.. table:: + :align: center + + +-----------------------------------------+--------------------------------------+ + | request | reply | + +=========================================+======================================+ + | :type:`SANE_String` :data:`device_name` | :type:`SANE_Word` :data:`status` | + +-----------------------------------------+--------------------------------------+ + | | :type:`SANE_Word` :data:`handle` | + +-----------------------------------------+--------------------------------------+ + | | :type:`SANE_String` :data:`resource` | + +-----------------------------------------+--------------------------------------+ The :data:`device_name` argument specifies the name of the device to open. @@ -261,11 +270,14 @@ authorize a resource). This RPC is used to close a connection to a remote SANE device. -+----------------------------------------+---------------------------------------+ -| **request:** | **reply:** | -+----------------------------------------+---------------------------------------+ -| :raw-latex:`\code{SANE_Word handle}` | :raw-latex:`\code{SANE_Word dummy}` | -+----------------------------------------+---------------------------------------+ +.. table:: + :align: center + + +----------------------------------+---------------------------------+ + | request | reply | + +==================================+=================================+ + | :type:`SANE_Word` :data:`handle` | :type:`SANE_Word` :data:`dummy` | + +----------------------------------+---------------------------------+ The :data:`handle` argument identifies the connection that should be closed. @@ -282,11 +294,14 @@ would not be able to determine when the RPC has completed). This RPC is used to obtain *all* the option descriptors for a remote SANE device. -+----------------------------------------+-----------------------------------------------------+ -| **request:** | **reply:** | -+----------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{SANE_Word handle}` | :raw-latex:`\code{Option_Descriptor_Array odesc}` | -+----------------------------------------+-----------------------------------------------------+ +.. table:: + :align: center + + +----------------------------------+-----------------------------------------------+ + | request | reply | + +==================================+===============================================+ + | :type:`SANE_Word` :data:`handle` | :type:`Option_Descriptor_Array` :data:`odesc` | + +----------------------------------+-----------------------------------------------+ The :data:`handle` argument identifies the remote device whose option descriptors should be obtained. @@ -313,21 +328,24 @@ following structure: This RPC is used to control (inquire, set, or set to automatic) a specific option of a remote SANE device. -+--------------------------------------------+---------------------------------------------+ -| **request:** | **reply:** | -+--------------------------------------------+---------------------------------------------+ -| :raw-latex:`\code{SANE_Word handle}` | :raw-latex:`\code{SANE_Status status}` | -+--------------------------------------------+---------------------------------------------+ -| :raw-latex:`\code{SANE_Word option}` | :raw-latex:`\code{SANE_Word info}` | -+--------------------------------------------+---------------------------------------------+ -| :raw-latex:`\code{SANE_Word action}` | :raw-latex:`\code{SANE_Word value_type}` | -+--------------------------------------------+---------------------------------------------+ -| :raw-latex:`\code{SANE_Word value_type}` | :raw-latex:`\code{SANE_Word value_size}` | -+--------------------------------------------+---------------------------------------------+ -| :raw-latex:`\code{SANE_Word value_size}` | :raw-latex:`\code{void *value}` | -+--------------------------------------------+---------------------------------------------+ -| :raw-latex:`\code{void *value}` | :raw-latex:`\code{SANE_String *resource}` | -+--------------------------------------------+---------------------------------------------+ +.. table:: + :align: center + + +--------------------------------------+---------------------------------------+ + | request | reply | + +======================================+=======================================+ + | :type:`SANE_Word` :data:`handle` | :type:`SANE_Status` :data:`status` | + +--------------------------------------+---------------------------------------+ + | :type:`SANE_Word` :data:`option` | :type:`SANE_Word` :data:`info` | + +--------------------------------------+---------------------------------------+ + | :type:`SANE_Word` :data:`action` | :type:`SANE_Word` :data:`value_type` | + +--------------------------------------+---------------------------------------+ + | :type:`SANE_Word` :data:`value_type` | :type:`SANE_Word` :data:`value_size` | + +--------------------------------------+---------------------------------------+ + | :type:`SANE_Word` :data:`value_size` | :type:`void` :data:`*value` | + +--------------------------------------+---------------------------------------+ + | :type:`void` :data:`*value` | :type:`SANE_String` :data:`*resource` | + +--------------------------------------+---------------------------------------+ The :data:`handle` argument identifies the remote device whose option should be controlled. Argument :data:`option` @@ -375,13 +393,16 @@ the option that has become effective as a result of this RPC. This RPC is used to obtain the scan parameters of a remote SANE device. -+----------------------------------------+----------------------------------------------+ -| **request:** | **reply:** | -+----------------------------------------+----------------------------------------------+ -| :raw-latex:`\code{SANE_Word handle}` | :raw-latex:`\code{SANE_Status status}` | -+----------------------------------------+----------------------------------------------+ -| | :raw-latex:`\code{SANE_Parameters params}` | -+----------------------------------------+----------------------------------------------+ +.. table:: + :align: center + + +----------------------------------+----------------------------------------+ + | request | reply | + +==================================+========================================+ + | :type:`SANE_Word` :data:`handle` | :type:`SANE_Status` :data:`status` | + +----------------------------------+----------------------------------------+ + | | :type:`SANE_Parameters` :data:`params` | + +----------------------------------+----------------------------------------+ The :data:`handle` argument identifies the connection to the remote device whose scan parameters should be returned. @@ -399,17 +420,20 @@ return the scan parameters. This RPC is used to start image acquisition (scanning). -+----------------------------------------+--------------------------------------------+ -| **request:** | **reply:** | -+----------------------------------------+--------------------------------------------+ -| :raw-latex:`\code{SANE_Word handle}` | :raw-latex:`\code{SANE_Status status}` | -+----------------------------------------+--------------------------------------------+ -| | :raw-latex:`\code{SANE_Word port}` | -+----------------------------------------+--------------------------------------------+ -| | :raw-latex:`\code{SANE_Word byte_order}` | -+----------------------------------------+--------------------------------------------+ -| | :raw-latex:`\code{SANE_String resource}` | -+----------------------------------------+--------------------------------------------+ +.. table:: + :align: center + + +----------------------------------+--------------------------------------+ + | request | reply | + +==================================+======================================+ + | :type:`SANE_Word` :data:`handle` | :type:`SANE_Status` :data:`status` | + +----------------------------------+--------------------------------------+ + | | :type:`SANE_Word` :data:`port` | + +----------------------------------+--------------------------------------+ + | | :type:`SANE_Word` :data:`byte_order` | + +----------------------------------+--------------------------------------+ + | | :type:`SANE_String` :data:`resource` | + +----------------------------------+--------------------------------------+ The :data:`handle` argument identifies the connection to the remote device from which the image should be acquired. @@ -457,11 +481,14 @@ client-side improves the scalability properties of this protocol. This RPC is used to cancel the current operation of a remote SANE device. -+----------------------------------------+---------------------------------------+ -| **request:** | **reply:** | -+----------------------------------------+---------------------------------------+ -| :raw-latex:`\code{SANE_Word handle}` | :raw-latex:`\code{SANE_Word dummy}` | -+----------------------------------------+---------------------------------------+ +.. table:: + :align: center + + +----------------------------------+---------------------------------+ + | request | reply | + +==================================+=================================+ + | :type:`SANE_Word` :data:`handle` | :type:`SANE_Word` :data:`dummy` | + +----------------------------------+---------------------------------+ The :data:`handle` argument identifies the connection whose operation should be cancelled. @@ -478,15 +505,18 @@ would not be able to determine when the RPC has completed). This RPC is used to pass authorization data from the net client to the net server. -+--------------------------------------------+---------------------------------------+ -| **request:** | **reply:** | -+--------------------------------------------+---------------------------------------+ -| :raw-latex:`\code{SANE_String resource}` | :raw-latex:`\code{SANE_Word dummy}` | -+--------------------------------------------+---------------------------------------+ -| :raw-latex:`\code{SANE_String username}` | | -+--------------------------------------------+---------------------------------------+ -| :raw-latex:`\code{SANE_String password}` | | -+--------------------------------------------+---------------------------------------+ +.. table:: + :align: center + + +--------------------------------------+---------------------------------+ + | request | reply | + +======================================+=================================+ + | :type:`SANE_String` :data:`resource` | :type:`SANE_Word` :data:`dummy` | + +--------------------------------------+---------------------------------+ + | :type:`SANE_String` :data:`username` | | + +--------------------------------------+---------------------------------+ + | :type:`SANE_String` :data:`password` | | + +--------------------------------------+---------------------------------+ The :data:`resource` argument specifies the name of the resource to be authorized. This argument should be set to the string diff --git a/sane.rst b/sane.rst index 9ff8eef..b5ac4e4 100644 --- a/sane.rst +++ b/sane.rst @@ -586,39 +586,41 @@ completion status of the operation. If an operation completes successfully, :macro:`SANE_STATUS_GOOD` is returned. In case of an error, a value is returned that indicates the nature of the problem. The complete list of available status codes is listed in Table -:raw-latex:`\ref{tab:status}`. It is recommended to use function +:ref:`tab:status`. It is recommended to use function :func:`sane_strstatus()` to convert status codes into a legible string. -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\multicolumn{1}{|c|}{\bf Symbol}` | :raw-latex:`\multicolumn{1}{c|}{\bf Code}` | :raw-latex:`\multicolumn{1}{c|}{\bf Description}` | -+==================================================================+==============================================+=====================================================+ -| :raw-latex:`\hline`:raw-latex:`\code{\defn{SANE_STATUS_GOOD}}` | 0 | Operation completed succesfully. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_UNSUPPORTED}}` | 1 | Operation is not supported. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_CANCELLED}}` | 2 | Operation was cancelled. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_DEVICE_BUSY}}` | 3 | Device is busy—retry later. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_INVAL}}` | 4 | Data or argument is invalid. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_EOF}}` | 5 | No more data available (end-of-file). | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_JAMMED}}` | 6 | Document feeder jammed. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_NO_DOCS}}` | 7 | Document feeder out of documents. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_COVER_OPEN}}` | 8 | Scanner cover is open. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_IO_ERROR}}` | 9 | Error during device I/O. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_NO_MEM}}` | 10 | Out of memory. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ -| :raw-latex:`\code{\defn{SANE_STATUS_ACCESS_DENIED}}` | 11 | Access to resource has been denied. | -+------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------+ +.. table:: Status Codes + :name: tab:status + :align: center -Table: Status Codes + +--------------------------------------+------+---------------------------------------+ + | Symbol | Code | Description | + +======================================+======+=======================================+ + | .. macro:: SANE_STATUS_GOOD | 0 | Operation completed succesfully. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_UNSUPPORTED | 1 | Operation is not supported. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_CANCELLED | 2 | Operation was cancelled. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_DEVICE_BUSY | 3 | Device is busy—retry later. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_INVAL | 4 | Data or argument is invalid. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_EOF | 5 | No more data available (end-of-file). | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_JAMMED | 6 | Document feeder jammed. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_NO_DOCS | 7 | Document feeder out of documents. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_COVER_OPEN | 8 | Scanner cover is open. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_IO_ERROR | 9 | Error during device I/O. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_NO_MEM | 10 | Out of memory. | + +--------------------------------------+------+---------------------------------------+ + | .. macro:: SANE_STATUS_ACCESS_DENIED | 11 | Access to resource has been denied. | + +--------------------------------------+------+---------------------------------------+ .. index:: SANE_Device @@ -662,55 +664,43 @@ the type of the device. For consistency’s sake, the following strings should be used when appropriate (the lists will be expanded as need arises): -:raw-latex:`\leavevmode` +.. table:: Predefined Device Information Strings + :align: center -.. raw:: latex + +---------------------+--------------+ + | Vendor Strings | + +=====================+==============+ + | ``AGFA`` | ``Logitech`` | + +---------------------+--------------+ + | ``Artec`` | ``Microtek`` | + +---------------------+--------------+ + | ``Connectix`` | ``Minolta`` | + +---------------------+--------------+ + | ``Epson`` | ``Mustek`` | + +---------------------+--------------+ + | ``Hewlett-Packard`` | ``UMAX`` | + +---------------------+--------------+ + | ``Kodak`` | ``Noname`` | + +---------------------+--------------+ - \hspace{\fill} +.. table:: + :align: center -+----------------------------------------------------------------+--------------------------------+ -| :raw-latex:`\multicolumn{2}{|c|}{\bf \defn{Vendor Strings}}` | | -+================================================================+================================+ -| :raw-latex:`\hline` :raw-latex:`\code{AGFA}` | :raw-latex:`\code{Logitech}` | -+----------------------------------------------------------------+--------------------------------+ -| :raw-latex:`\code{Artec}` | :raw-latex:`\code{Microtek}` | -+----------------------------------------------------------------+--------------------------------+ -| :raw-latex:`\code{Connectix}` | :raw-latex:`\code{Minolta}` | -+----------------------------------------------------------------+--------------------------------+ -| :raw-latex:`\code{Epson}` | :raw-latex:`\code{Mustek}` | -+----------------------------------------------------------------+--------------------------------+ -| :raw-latex:`\code{Hewlett-Packard}` | :raw-latex:`\code{UMAX}` | -+----------------------------------------------------------------+--------------------------------+ -| :raw-latex:`\code{Kodak}` | :raw-latex:`\code{Noname}` | -+----------------------------------------------------------------+--------------------------------+ - -Table: Predefined Device Information Strings - -.. raw:: latex - - \hspace{\fill} - -+--------------------------------------------------------------+ -| :raw-latex:`\multicolumn{1}{|c|}{\bf \defn{Type Strings}}` | -+==============================================================+ -| :raw-latex:`\hline` :raw-latex:`\code{flatbed scanner}` | -+--------------------------------------------------------------+ -| :raw-latex:`\code{frame grabber}` | -+--------------------------------------------------------------+ -| :raw-latex:`\code{handheld scanner}` | -+--------------------------------------------------------------+ -| :raw-latex:`\code{still camera}` | -+--------------------------------------------------------------+ -| :raw-latex:`\code{video camera}` | -+--------------------------------------------------------------+ -| :raw-latex:`\code{virtual device}` | -+--------------------------------------------------------------+ - -Table: Predefined Device Information Strings - -.. raw:: latex - - \hspace{\fill} + +----------------------+ + | Type Strings | + +======================+ + | ``flatbed scanner`` | + +----------------------+ + | ``frame grabber`` | + +----------------------+ + | ``handheld scanner`` | + +----------------------+ + | ``still camera`` | + +----------------------+ + | ``video camera`` | + +----------------------+ + | ``virtual device`` | + +----------------------+ Note that vendor string ``Noname`` can be used for virtual devices that have no physical vendor associated. Also, there are @@ -1872,17 +1862,23 @@ the backend to perform the necessary conversions. The names of the four options that define the scan area are given in the table below: -+-----------------------------------+-------------------------------------------+ -| **Name** | **Description** | -+-----------------------------------+-------------------------------------------+ -| :raw-latex:`\code{\defn{tl-x}}` | Top-left :math:`x` coordinate value | -+-----------------------------------+-------------------------------------------+ -| :raw-latex:`\code{\defn{tl-y}}` | Top-left :math:`y` coordinate value | -+-----------------------------------+-------------------------------------------+ -| :raw-latex:`\code{\defn{br-x}}` | Bottom-right :math:`x` coordinate value | -+-----------------------------------+-------------------------------------------+ -| :raw-latex:`\code{\defn{br-y}}` | Bottom-right :math:`y` coordinate value | -+-----------------------------------+-------------------------------------------+ +.. index:: tl-x, tl-y, br-x, br-y + +.. table:: + :name: scan-area + :align: center + + +----------+-----------------------------------------+ + | Name | Description | + +==========+=========================================+ + | ``tl-x`` | Top-left :math:`x` coordinate value | + +----------+-----------------------------------------+ + | ``tl-y`` | Top-left :math:`y` coordinate value | + +----------+-----------------------------------------+ + | ``br-x`` | Bottom-right :math:`x` coordinate value | + +----------+-----------------------------------------+ + | ``br-y`` | Bottom-right :math:`y` coordinate value | + +----------+-----------------------------------------+ There are several rules that should be followed by front and backends regarding these options: