kopia lustrzana https://gitlab.com/sane-project/standard
Fix spelling issues
rodzic
1914bf0202
commit
32df893b33
44
api.rst
44
api.rst
|
@ -759,9 +759,9 @@ of a given capability bitset:
|
|||
| | | ``preview`` option. |
|
||||
| | | If this capability is set for an option of type |
|
||||
| | | :macro:`SANE_TYPE_GROUP`, all options belonging to the group are also |
|
||||
| | | hidden, even if they don't set the capabilty themselves. |
|
||||
| | | hidden, even if they don't set the capability themselves. |
|
||||
| | | A frontend typically doesn't display such options by default but there |
|
||||
| | | should be a way to override this default behaviour. |
|
||||
| | | should be a way to override this default behavior. |
|
||||
+-------------------------------------+------+---------------------------------------------------------------------------+
|
||||
| .. macro:: SANE_CAP_ALWAYS_SETTABLE | 256 | .. attention:: |
|
||||
| | | |
|
||||
|
@ -848,9 +848,9 @@ Internationalization
|
|||
|
||||
.. attention::
|
||||
|
||||
All backend texts should be written in english. Localization
|
||||
All backend texts should be written in English. Localization
|
||||
(translation of backend texts) has to be done in the frontend. To
|
||||
automatically prepare translation tables (e.g. english to german)
|
||||
automatically prepare translation tables (e.g. English to German)
|
||||
it is necessary to mark the texts that shall be translated.
|
||||
|
||||
How is a text marked for translation
|
||||
|
@ -886,7 +886,7 @@ How is a text marked for translation
|
|||
|
||||
#define START_SCAN_TEXT SANE_I18N("Start scan")
|
||||
|
||||
It also is allowed to mark texts in structs because the prototype
|
||||
It also is allowed to mark texts in structures because the prototype
|
||||
:macro:`SANE_I18N` has no effect to the compiler.
|
||||
|
||||
Which texts shall be marked for translation?
|
||||
|
@ -913,7 +913,7 @@ File formats and translation functions
|
|||
.. attention::
|
||||
|
||||
The recommended file formats for translation tables are the
|
||||
:file:`po` files and :file:`mo` or :file:`gmo` files. The po file
|
||||
:file:`po` files and :file:`mo` or :file:`gmo` files. The :file:`po` file
|
||||
contains the original text marked with the keyword :token:`msgid`
|
||||
and the translated text marked with the keyword :token:`msgstr`. A
|
||||
:file:`po` file that contains all needed :token:`msgid`'s can be
|
||||
|
@ -1351,7 +1351,7 @@ structure is given below.
|
|||
| .. macro:: SANE_FRAME_MIME | 6 | Data described by a mime descriptor. |
|
||||
+-----------------------------+------+-----------------------------------------+
|
||||
|
||||
The :member:`flags` member is a 32 bit bitfield, for which up to now 4
|
||||
The :member:`flags` member is a 32-bit bit field, for which up to now 4
|
||||
informational bits are defined, all unused bits have to be set to 0:
|
||||
|
||||
- .. macro:: SANE_PFLAG_LAST_FRAME
|
||||
|
@ -1403,7 +1403,7 @@ until it returns a status of :macro:`SANE_STATUS_EOF`.
|
|||
.. attention::
|
||||
|
||||
Note, that even when transferring formats that have this
|
||||
information inband, it is recommended to set that member, if
|
||||
information in-band, it is recommended to set that member, if
|
||||
available. If unavailable or not applicable, set to -1 as mentioned
|
||||
above.
|
||||
|
||||
|
@ -1425,7 +1425,7 @@ sample.
|
|||
Note, that only -1 (for not applicable), 1, and multiples of 8 are
|
||||
allowed values. Data with other depths has to be scaled up
|
||||
accordingly. Depth 1 is only allowed if the image consists of a
|
||||
single channel (lineart or halftone modes).
|
||||
single channel (``Lineart`` or ``Halftone`` modes).
|
||||
|
||||
Member :member:`pixels_per_line` specifies the number of
|
||||
pixels that comprise one scan line.
|
||||
|
@ -1471,7 +1471,7 @@ able to properly cope with such “padded” image formats.
|
|||
The :member:`format_desc` contains a description of the channel
|
||||
data and an optional depth information separated by a colon(:).
|
||||
|
||||
A plane is descibed by one channel, e.g. "``gray``" or
|
||||
A plane is described by one channel, e.g. "``gray``" or
|
||||
"``gray:12``".
|
||||
|
||||
Channel interleaved data is described by a comma separated list
|
||||
|
@ -1494,7 +1494,7 @@ able to properly cope with such “padded” image formats.
|
|||
Note that an image can be sent in single planes, in one
|
||||
interleaved frame that contains all channels or in several
|
||||
frames that contain one or more (interleaved) channels. When an
|
||||
RGB image is sent it is prefered to send the image data in one
|
||||
RGB image is sent it is preferred to send the image data in one
|
||||
interleaved frame that consist of red, green and blue data in
|
||||
this order. The number of channels is defined in member
|
||||
:member:`channels_per_image`.
|
||||
|
@ -1516,7 +1516,7 @@ able to properly cope with such “padded” image formats.
|
|||
A SANE backend must be able to at least optionally transmit
|
||||
:macro:`SANE_FRAME_RAW` (possibly with the help of a meta
|
||||
backend), if the hardware supports delivering image data at
|
||||
all. For data that doesn't comprise images, it's admisable to
|
||||
all. For data that doesn't comprise images, it's admissible to
|
||||
only provide MIME frames. As a general principle, if there are
|
||||
several choices in MIME types, the format that is most widely
|
||||
implemented should be used.
|
||||
|
@ -1550,7 +1550,7 @@ able to properly cope with such “padded” image formats.
|
|||
additional image information, that can be stored in the comment areas
|
||||
several file formats offer. It can contain any textual information
|
||||
the backend wishes to convey to the user, like date/time of
|
||||
exposure, enganged filters, etc. Set to ``""`` if unused.
|
||||
exposure, engaged filters, etc. Set to ``""`` if unused.
|
||||
|
||||
The members :member:`dpi_x` and :member:`dpi_y` encode the
|
||||
horizontal and vertical resolution. Note, that multiple-image scans
|
||||
|
@ -1901,9 +1901,9 @@ operation.
|
|||
the actual call to :func:`sane_start()` return an error like
|
||||
:macro:`SANE_STATUS_NO_DOCS`. Such a sequence is permitted to
|
||||
transmit multiple images from a single page as well as multiple
|
||||
pages. This behaviour should be controlled by backend options as
|
||||
pages. This behavior should be controlled by backend options as
|
||||
required, to allow single-page scanning as well as
|
||||
ADF-batch-scanning. The frontend should always continue reading all
|
||||
ADF batch scanning. The frontend should always continue reading all
|
||||
images until a frame with :macro:`SANE_PFLAG_LAST_FRAME` on and
|
||||
:macro:`SANE_PFLAG_MORE_IMAGES` off is encountered, or an error
|
||||
other than :macro:`SANE_STATUS_EOF` occurs in a SANE function.
|
||||
|
@ -2176,9 +2176,9 @@ Depth Option
|
|||
Option ``depth`` is used to select the image depth in bits/sample
|
||||
in multi bit mode - (e.g. for 24 bit RGB mode this value must
|
||||
be 8). The type of this option is :macro:`SANE_TYPE_INT`. The
|
||||
unit is :macro:`SANE_UNIT_BIT`. For 1 bit modes (Lineart or
|
||||
Halftone) this option has to be inactive. For selection of 1 bit
|
||||
modes (Lineart or Halftone) the backend should use the well-known
|
||||
unit is :macro:`SANE_UNIT_BIT`. For 1 bit modes (``Lineart`` or
|
||||
``Halftone``) this option has to be inactive. For selection of 1 bit
|
||||
modes (``Lineart`` or ``Halftone``) the backend should use the well-known
|
||||
option ``mode``.
|
||||
|
||||
This option is not mandatory, but if a backend does support it, it
|
||||
|
@ -2193,7 +2193,7 @@ Scan Mode Options
|
|||
|
||||
The option ``mode`` defines a :macro:`SANE_CONSTRAINT_STRING_LIST`
|
||||
of type :macro:`SANE_TYPE_STRING`.
|
||||
It is used to select the scanmode (e.g. Color or Gray).
|
||||
It is used to select the scan mode (e.g. Color or Gray).
|
||||
Well known modes are: ``Color``, ``Gray``, ``Halftone``
|
||||
and ``Lineart``. ``Color`` and ``Gray`` are multi bit
|
||||
modes (8 or 16 bits/sample), ``Halftone`` and ``Lineart``
|
||||
|
@ -2228,7 +2228,7 @@ Threshold Option
|
|||
.. attention::
|
||||
|
||||
The option ``threshold`` is used to define the threshold for
|
||||
Lineart and maybe Halftone mode. In multi bit modes this option
|
||||
``Lineart`` and maybe ``Halftone`` mode. In multi bit modes this option
|
||||
should be set inactive. The type of this option is
|
||||
:macro:`SANE_TYPE_FIXED`. The unit is
|
||||
:macro:`SANE_UNIT_PERCENT`. The value range should be
|
||||
|
@ -2427,7 +2427,7 @@ Scanner Button Options
|
|||
scan-button on the scanner. The scanner does scan three times
|
||||
(because three frontends asked the button status when you
|
||||
pressed the button). For three people the image is saved to the
|
||||
harddisk, but it is not sure that your frontend did scan the
|
||||
hard disk, but it is not sure that your frontend did scan the
|
||||
image.
|
||||
|
||||
A backend that does make available the scanner-buttons has to
|
||||
|
@ -2442,7 +2442,7 @@ Scanner Button Options
|
|||
|
||||
When setting these options the backend does not set
|
||||
:macro:`SANE_INFO_RELOAD_OPTIONS` or
|
||||
:macro:`SANE_INFO_RELOAD_PARAMS` if not explictly defined.
|
||||
:macro:`SANE_INFO_RELOAD_PARAMS` if not explicitly defined.
|
||||
|
||||
A frontend has to disable the usage of the scanner-buttons by
|
||||
default. This is important because other frontends will not be able
|
||||
|
|
|
@ -247,9 +247,9 @@ Arbitrary data frames
|
|||
|
||||
.. attention::
|
||||
|
||||
It also is possible to transmit arbitrary (not necessaryly pixel
|
||||
It also is possible to transmit arbitrary (not necessarily pixel
|
||||
oriented) data. This allows transmission of compressed images like
|
||||
jpeg, tiff, etc.
|
||||
JPEG, TIFF, etc.
|
||||
|
||||
The type of arbitrary data frames is :macro:`SANE_FRAME_MIME`. The
|
||||
frame contains arbitrary data of the MIME (see RFC 1521/1522) type
|
||||
|
|
|
@ -42,5 +42,5 @@ this:
|
|||
|
||||
.. attention::
|
||||
|
||||
Paragraphs that changed since the last revision of the documention
|
||||
Paragraphs that changed since the last revision of the documentation
|
||||
are marked like this paragraph.
|
||||
|
|
|
@ -1,11 +1,14 @@
|
|||
backend
|
||||
backends
|
||||
basename
|
||||
bitset
|
||||
bitvalue
|
||||
cancelled
|
||||
endian
|
||||
frontend
|
||||
frontends
|
||||
interoperate
|
||||
lockfile
|
||||
lossy
|
||||
luminance
|
||||
prepends
|
||||
|
@ -17,3 +20,5 @@ reimplementing
|
|||
runtime
|
||||
scalability
|
||||
setuid
|
||||
subtype
|
||||
subtypes
|
||||
|
|
Ładowanie…
Reference in New Issue