Files
klammertext/sks/image/image.k
Andy Kopra 6e7596ab2e Option sets: a .o target for shared parameters
A named group of optional parameters, declared once and used by several
klammers, so a writer learns one vocabulary instead of a spelling per
klammer.  The "o" target is a pseudo-target beside "k": "k" declares a
klammer's interface and documents it, "o" declares an option interface and
documents it, and neither produces output for any target.

    @@caption_args.o :caption :number.bool true :caption_side.side
    : Arguments that define a caption for a block element @@

    @@code.k :filename @hpos_args :hpos left @ @caption_args :caption_side top @
    | text.literal : A source file displayed verbatim @@

A set is used only in the parameter list of a ".k" declaration -- the one
place a klammer's interface is declared once for all of its targets -- and
is resolved as that list is read.  Names and types come from the set; a
default may be overridden where it is used.  A klammer application in a
parameter list is now a definition-time error.

The SKS gains the sets caption_args and hpos_args (:hpos and :offset), and
@table, @image, @image_grid, @reference and @show gain .k declarations.  A
distance is no longer written as a position: :hpos 4em is rejected, and the
same layout is :hpos left :offset 4em.  Code listings are numbered by
default, like tables and figures.

New engine sources mac/option_set{,_registry}.{h,cpp}; tst/ ships two more
suites, option_set_test.sh and signature_test.sh (twelve in all).

 (from dev 34e536cb0329)
2026-08-06 13:11:37 +02:00

62 lines
1.7 KiB
Plaintext

#[
@@@state image_search_path.list :create Series of directories for image search
:value . imgsrc ../imgsrc ../dbg
@@@
]#
@@@state Image_search_path :desc Series of directories for image search
:value . imgsrc ../imgsrc ../dbg
@@@
@@@state Image_output_dir :desc Output directory for images :value img @@@
@@@state Image_default_width :desc Default width for images :value .667w @@@
#
# @@@argtype pixels | a pixel count :pattern \d+px @@@
# @@image.k basename : Image read from a file @@
# @@image.html basename | width | height : @eval import image ; result = image.image(K) eval@ @@
# An image once had its own position type, for the sake of the "none" value
# (no positioning container). That value is meaningful for any block
# element, so the shared hpos type carries it and an image is placed by the
# hpos_args option set like every other block element.
@@image.k
basename
:id
:width.length .5w
@caption_args@
:vmargin.bool true
@hpos_args@
:rel
:abswidth.number 0.0
:border.bool false
:
An image read from a file. The basename names the file, which is looked
for in the image search path and converted to a format the target can use.
^:width is the image's width in the text column, ^:hpos and ^:offset place
it there, and the caption arguments caption it.
@@
@@image :: @eval image.Image(K) eval@ @@
@@image_grid.k
image_specs.rest(2)
:cell_number.bool false
:landscape.bool false
:scale.number 0.98
@caption_args@
@hpos_args@
:thumbnail.bool false
:allow_break.bool true
:id
:rel
:hsep.number 0.02
: A grid of images
@@
@@image_grid :: @eval image_grid.Image_grid(K) eval@ @@
@@fig spec.figure_id : @reference *spec* | Figure @ @@