kopia lustrzana https://gitlab.com/sane-project/standard
Restore numeric chapter and section cross-references
rodzic
002b7b568b
commit
6d86ce9c87
4
conf.py
4
conf.py
|
@ -49,7 +49,8 @@ primary_domain = 'c'
|
|||
numfig = True
|
||||
numfig_format = {
|
||||
'figure': 'Figure %s',
|
||||
'table': 'Table %s'
|
||||
'table': 'Table %s',
|
||||
'section': '%s'
|
||||
}
|
||||
|
||||
today_fmt = '%Y-%m-%d'
|
||||
|
@ -71,6 +72,7 @@ html_static_path = ['_static']
|
|||
|
||||
html_last_updated_fmt = today_fmt
|
||||
html_show_copyright = False
|
||||
html_secnumber_suffix = ' '
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
|
||||
|
|
|
@ -2,6 +2,7 @@ SANE Standard
|
|||
=============
|
||||
|
||||
.. toctree::
|
||||
:numbered: 3
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
|
|
15
net.rst
15
net.rst
|
@ -1,3 +1,5 @@
|
|||
.. _chap:net:
|
||||
|
||||
Network Protocol
|
||||
================
|
||||
|
||||
|
@ -179,7 +181,7 @@ reply arguments for this call are shown in the table below:
|
|||
|
||||
The :data:`version_code` argument in the request is the SANE
|
||||
version-code of the network backend that is contacting the network
|
||||
daemon (see Section :raw-latex:`\ref{sec:saneversioncode}`). The
|
||||
daemon (see Section :numref:`sec:saneversioncode`). The
|
||||
“build-revision” in the version code is used to hold the network
|
||||
protocol version. The SANE network daemon receiving such a request must
|
||||
make sure that the network protocol version corresponds to a supported
|
||||
|
@ -260,7 +262,7 @@ device handle that uniquely identifies the connection. The
|
|||
:data:`resource` argument is used to request authentication.
|
||||
If it has a non-:macro:`NULL` value, the network backend
|
||||
should authenticate the specified resource and then retry this operation
|
||||
(see Section :raw-latex:`\ref{sec:authorization}` for details on how to
|
||||
(see Section :numref:`sec:authorization` for details on how to
|
||||
authorize a resource).
|
||||
|
||||
.. index:: SANE_NET_CLOSE
|
||||
|
@ -358,7 +360,7 @@ specifies the type of the option value (must be one of
|
|||
:macro:`SANE_TYPE_STRING`,
|
||||
:macro:`SANE_TYPE_BUTTON`). Argument
|
||||
:data:`value_size` specifies the size of the option value in
|
||||
number of bytes (see Section :raw-latex:`\ref{sec:valuesize}` for the
|
||||
number of bytes (see Section :numref:`sec:valuesize` for the
|
||||
precise meaning of this value). Finally, argument
|
||||
:data:`value` is a pointer to the option value. It must be a
|
||||
writeable area that is at least :data:`value_size` bytes
|
||||
|
@ -370,7 +372,7 @@ the next best value that the backend has chosen.)
|
|||
In the reply, argument :data:`resource` is set to the name
|
||||
of the resource that must be authorized before this call can be retried.
|
||||
If this value is non-:macro:`NULL`, all other arguments have
|
||||
undefined values (see Section :raw-latex:`\ref{sec:authorization}` for
|
||||
undefined values (see Section :numref:`sec:authorization` for
|
||||
details on how to authorize a resource). Argument
|
||||
:data:`status` indicates the completion status. If the value
|
||||
is anything other than :macro:`SANE_STATUS_SUCCESS`, the
|
||||
|
@ -378,7 +380,7 @@ remainder of the reply has undefined values. The
|
|||
:data:`info` argument returns the information on how well
|
||||
the backend was able to satisfy the request. For details, see the
|
||||
description of the corresponding argument in
|
||||
Section :raw-latex:`\ref{sec:control}`. Arguments
|
||||
Section :numref:`sec:control`. Arguments
|
||||
:data:`value_type` and :data:`value_size` have
|
||||
the same values as the arguments by the same name in corresponding
|
||||
request. The values are repeated here to ensure that both the request
|
||||
|
@ -441,7 +443,7 @@ remote device from which the image should be acquired.
|
|||
In the reply, argument :data:`resource` is set to the name
|
||||
of the resource that must be authorized before this call can be retried.
|
||||
If this value is non-:macro:`NULL`, all other arguments have
|
||||
undefined values (see Section :raw-latex:`\ref{sec:authorization}` for
|
||||
undefined values (see Section :numref:`sec:authorization` for
|
||||
details on how to authorize a resource). Argument,
|
||||
:data:`status` indicates the completion status. If the value
|
||||
is anything other than :macro:`SANE_STATUS_SUCCESS`, the
|
||||
|
@ -498,6 +500,7 @@ purpose is to ensure proper synchronization (without it, a net client
|
|||
would not be able to determine when the RPC has completed).
|
||||
|
||||
.. index:: SANE_NET_AUTHORIZE, network authorization
|
||||
.. _sec:authorization:
|
||||
|
||||
:data:`SANE_NET_AUTHORIZE`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
30
sane.rst
30
sane.rst
|
@ -17,7 +17,7 @@ The SANE standard is being developed by a group of free-software
|
|||
developers. The process is open to the public and comments as well as
|
||||
suggestions for improvements are welcome. Information on how to join the
|
||||
SANE development process can be found in Chapter
|
||||
:raw-latex:`\ref{chap:contact}`.
|
||||
:numref:`chap:contact`.
|
||||
|
||||
The SANE standard is intended to streamline software development by
|
||||
providing a standard application programming interface to access raster
|
||||
|
@ -37,13 +37,13 @@ application on any platform to interoperate with any SANE backend for
|
|||
that platform.
|
||||
|
||||
The remainder of this document is organized as follows.
|
||||
Chapter :raw-latex:`\ref{chap:intro}` provides introductional material.
|
||||
Chapter :raw-latex:`\ref{chap:environ}` presents the environment SANE is
|
||||
designed for. Chapter :raw-latex:`\ref{chap:api}` details the SANE
|
||||
Application Programmer Interface. Chapter :raw-latex:`\ref{chap:net}`
|
||||
Chapter :numref:`chap:intro` provides introductional material.
|
||||
Chapter :numref:`chap:environ` presents the environment SANE is
|
||||
designed for. Chapter :numref:`chap:api` details the SANE
|
||||
Application Programmer Interface. Chapter :numref:`chap:net`
|
||||
specifies the network protocol that can be used to implement the SANE
|
||||
API in a network transparent fashion. Finally,
|
||||
Chapter :raw-latex:`\ref{chap:contact}` gives information on how to join
|
||||
Chapter :numref:`chap:contact` gives information on how to join
|
||||
the SANE development process.
|
||||
|
||||
Typographic Conventions
|
||||
|
@ -52,6 +52,8 @@ Typographic Conventions
|
|||
Changes since the last revision of this document are highlighted like
|
||||
this:
|
||||
|
||||
.. _chap:intro:
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
|
@ -82,6 +84,8 @@ A driver that implements the SANE interface is called a SANE *backend*.
|
|||
A *meta backend* provides some means to manage one or more other
|
||||
backends.
|
||||
|
||||
.. _chap:environ:
|
||||
|
||||
The SANE Environment
|
||||
====================
|
||||
|
||||
|
@ -193,6 +197,7 @@ standard describes the interface from the viewpoint of a (real)
|
|||
frontend.
|
||||
|
||||
.. index:: image data format
|
||||
.. _sec:imageformat:
|
||||
|
||||
Image Data Format
|
||||
-----------------
|
||||
|
@ -312,6 +317,8 @@ This version of the SANE standard supports the following frame types:
|
|||
:macro:`SANE_FRAME_BLUE`. The order in which the
|
||||
frames are transmitted chosen by the backend.
|
||||
|
||||
.. _chap:api:
|
||||
|
||||
The SANE Application Programmer Interface (API)
|
||||
===============================================
|
||||
|
||||
|
@ -327,6 +334,8 @@ normally be included via a C pre-processor directive of the form:
|
|||
|
||||
#include <sane/sane.h>
|
||||
|
||||
.. _sec:saneversioncode:
|
||||
|
||||
Version Control
|
||||
---------------
|
||||
|
||||
|
@ -359,7 +368,7 @@ numbers.
|
|||
|
||||
.. function:: SANE_VERSION_CODE(maj, min, bld)
|
||||
|
||||
:raw-latex:`\label{sec:saneversioncode}` This macro can be used
|
||||
This macro can be used
|
||||
to build a monotonically increasing version code. A SANE version
|
||||
code consists of the SANE standard major version number
|
||||
(:data:`maj`), the minor version number
|
||||
|
@ -724,6 +733,7 @@ no predefined model name strings since those are vendor specific and
|
|||
therefore completely under control of the respective backends.
|
||||
|
||||
.. index:: SANE_Option_Descriptor
|
||||
.. _sec:odesc:
|
||||
|
||||
Option Descriptor Type
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
@ -868,6 +878,8 @@ unit (e.g., inches or centimeters).
|
|||
| .. macro:: SANE_UNIT_MICROSECOND | 6 | Value is time in :math:`\mu`-seconds. |
|
||||
+----------------------------------+------+----------------------------------------+
|
||||
|
||||
.. _sec:valuesize:
|
||||
|
||||
Option Value Size
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
@ -1222,6 +1234,7 @@ returned address) until the device is closed.
|
|||
sane_get_option_descriptor (SANE_Handle h, SANE_Int n);
|
||||
|
||||
.. index:: sane_control_option
|
||||
.. _sec:control:
|
||||
|
||||
:func:`sane_control_option`
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
@ -1387,7 +1400,7 @@ Member :member:`format` specifies the format of the next frame
|
|||
to be returned. The possible values for type
|
||||
:type:`SANE_Frame` are described in
|
||||
:numref:`tab:frameformat`. The meaning of these values is
|
||||
described in more detail in Section :raw-latex:`\ref{sec:imageformat}`.
|
||||
described in more detail in Section :numref:`sec:imageformat`.
|
||||
|
||||
.. tabularcolumns:: |\X{8}{32}|r|l|
|
||||
.. table:: Frame Format (:type:`SANE_Frame`)
|
||||
|
@ -1895,6 +1908,7 @@ regarding these options:
|
|||
.. include:: net.rst
|
||||
|
||||
.. index:: mailing list
|
||||
.. _chap:contact:
|
||||
|
||||
Contact Information
|
||||
===================
|
||||
|
|
Ładowanie…
Reference in New Issue