sile-typesetter / sile / 6915845768

local function getUnderlineParameters ()

end

local function getStrikethroughParameters ()

end

-- \hfill (from the "plain" class) and \leaders (from the "leaders" package) use glues,

-- so we behave the same for hrulefill.

end

end

      outputYourself = function (node, typesetter, line)

      end

    })

    local raise

    local thickness

    end

    end

    else

    end

      raise = raise,

      thickness = thickness or SILE.measurement("0.2pt"),

    }))

    end

    end

    end

    -- Re-wrap the hbox in another hbox responsible for boxing it at output

    -- time, when we will know the line contribution and can compute the scaled width

    -- of the box, taking into account possible stretching and shrinking.

      inner = hbox,

      width = hbox.width,

      height = hbox.height,

      depth = hbox.depth,

      outputYourself = function (node, typesetter, line)

        -- Build the original hbox.

        -- Cursor will be moved by the actual definitive size.

        -- Output a line.

        -- NOTE: According to the OpenType specs, underlinePosition is "the suggested distance of

        -- the top of the underline from the baseline" so it seems implied that the thickness

        -- should expand downwards

      end

    })

    -- Re-wrap the hbox in another hbox responsible for boxing it at output

    -- time, when we will know the line contribution and can compute the scaled width

    -- of the box, taking into account possible stretching and shrinking.

      inner = hbox,

      width = hbox.width,

      height = hbox.height,

      depth = hbox.depth,

      outputYourself = function (node, typesetter, line)

        -- Build the original hbox.

        -- Cursor will be moved by the actual definitive size.

        -- Output a line.

        -- NOTE: The OpenType spec is not explicit regarding how the size

        -- (thickness) affects the position. We opt to distribute evenly

      end

    })

    -- This command was not documented and lacks feature.

    -- Plan replacement with a better suited package.

    -- Re-wrap the hbox in another hbox responsible for boxing it at output

    -- time, when we will know the line contribution and can compute the scaled width

    -- of the box, taking into account possible stretching and shrinking.

      inner = hbox,

      width = hbox.width,

      height = hbox.height,

      depth = hbox.depth,

      outputYourself = function (node, typesetter, line)

        -- Build the original hbox.

        -- Cursor will be moved by the actual definitive size.

        -- Output a border

        -- NOTE: Drawn inside the hbox, so borders overlap with inner content.

      end

    })

end

package.documentation = [[

\begin{document}

The \autodoc:package{rules} package provides several line-drawing commands.

The \autodoc:command{\hrule} command draws a blob of ink of a given \autodoc:parameter{width} (length), \autodoc:parameter{height} (above the current baseline), and \autodoc:parameter{depth} (below the current baseline).

Such rules are horizontal boxes, placed along the baseline of a line of text and treated just like other text to be output.

So, they can appear in the middle of a paragraph, like this:

\hrule[width=20pt, height=0.5pt]

(That one was generated with \autodoc:command{\hrule[width=20pt, height=0.5pt]}.)

The \autodoc:command{\underline} command \underline{underlines} its content.

The \autodoc:command{\strikethrough} command \strikethrough{strikes} its content.

\autodoc:note{The position and thickness of the underlines and strikethroughs are based on the metrics of the current font, honoring the values defined by the type designer.}

The \autodoc:command{\hrulefill} inserts an infinite horizontal rubber, similar to an \autodoc:command{\hfill}, but—as its name implies—filled with a rule (that is, a solid line).

By default, it stands on the baseline and has a thickness of 0.2pt, below the baseline.

It supports optional parameters \autodoc:parameter{raise=<dimension>} and \autodoc:parameter{thickness=<dimension>} to adjust the position and thickness of the line, respectively.

The former accepts a negative measurement, to lower the line.

Alternatively, use the \autodoc:parameter{position} option, which can be set to \code{underline} or \code{strikethrough}.

In that case, it honors the current font metrics and the line is drawn at the appropriate position and, by default, with the relevant thickness.

You can still set a custom thickness with the \autodoc:parameter{thickness} parameter.

For instance, \autodoc:command{\hrulefill[position=underline]} gives:

\hrulefill[position=underline]

Finally, \autodoc:command{\fullrule} draws a thin standalone rule across the width of a full text line.

Accepted parameters are \autodoc:parameter{raise} and \autodoc:parameter{thickness}, with the same meanings as above.

\end{document}