sile-typesetter / sile / 6713098919

end

local shapeHbox = function (options, content)

  -- Clear irrelevant values before passing to font

  end)

end

  -- This implementation relies on the hangafter and hangindent features of Knuth's line-breaking algorithm.

  -- These features in core line breaking algorithm supply the blank space in the paragraph shape but don't fill it with anything.

    -- We want the drop cap to span over N lines, that is N - 1 baselineskip + the height of the first line.

    -- Note this only works for the default linespace mechanism.

    -- We determine the height of the first line by measuring the size the initial content *would have* been.

    -- This gives the font some control over its relative size, sometimes desired sometimes undesired.

    -- Now we need to figure out how to scale the dropcap font to get an initial of targetHeight.

    -- From that we can also figure out the width it will be at that height.

    -- Typeset the dropcap with its final shape, but don't output it yet

    -- Setup up the necessary indents for the final paragraph content

    -- The paragraph is indented so as to leave enough space for the drop cap.

    -- We "trick" the typesetter with a zero-dimension box wrapping our original box.

        end)

      end)

    end)

end

package.documentation = [[

\begin{document}

The \autodoc:package{dropcaps} package allows you to format paragraphs with an “initial capital” (also commonly referred as a “drop cap”), typically one large capital letter used as a decorative element at the beginning of a paragraph.

It provides the \autodoc:command{\dropcap} command.

The content passed will be the initial character(s).

The primary option is \autodoc:parameter{lines}, an integer specifying the number of lines to span (defaults to \code{3}).

The scale of the characters can be adjusted relative to the first line using the \autodoc:parameter{scale} option (defaults to \code{1.0}).

The \autodoc:parameter{join} parameter is a boolean for whether to join the dropcap to the first line (defaults to \code{false}).

If \autodoc:parameter{join} is \code{true}, the value of the \autodoc:parameter{standoff} option (defaults to \code{1spc}) is applied to all but the first line.

Optionally \autodoc:parameter{color} can be passed to change the typeface color, which is sometimes useful to offset the apparent weight of a large glyph.

To tweak the position of the dropcap, measurements may be passed to the \autodoc:parameter{raise} and \autodoc:parameter{shift} options.

Other options passed to \autodoc:command{\dropcap} will be passed through to \autodoc:command{\font} when drawing the initial letter(s).

This may be useful for passing OpenType options or other font preferences.

\begin{autodoc:note}

One caveat is that the size of the initials is calculated using the default linespacing mechanism.

If you are using an alternative method from the \autodoc:package{linespacing} package, you might see strange results.

Set the \autodoc:setting{document.baselineskip} to approximate your effective leading value for best results.

If that doesn't work set the size manually.

Using \code{SILE.setCommandDefaults()} can be helpful for so you don't have to set the size every time.

\end{autodoc:note}

\end{document}