sile-typesetter / sile / 14908152066

-- URL escape sequence, URL fragment:

-- URL path elements, URL query arguments, acceptable extras:

-- URL scheme:

local escapeRegExpMinimal = function (str)

   -- Minimalist = just what's needed for the above strings

end

end

      parameter = "url.linebreak.primaryPenalty",

      type = "integer",

      default = 100,

      help = "Penalty for breaking lines in URLs at preferred breakpoints",

   })

      parameter = "url.linebreak.secondaryPenalty",

      type = "integer",

      default = 200,

      help = "Penalty for breaking lines in URLs at tolerable breakpoints (should be higher than url.linebreak.primaryPenalty)",

   })

end

            dest = options.src,

            external = true,

            borderwidth = options.borderwidth,

            borderstyle = options.borderstyle,

            bordercolor = options.bordercolor,

            borderoffset = options.borderoffset,

      else

            dest = options.src,

            external = true,

            borderwidth = options.borderwidth,

            borderstyle = options.borderstyle,

            bordercolor = options.bordercolor,

            borderoffset = options.borderoffset,

         }, function (_, _)

         end)

      end

   local urlFilter = function (node, content, options)

      end

         else

               -- Accepts breaking before, and at the extreme worst after.

                  "penalty",

               )

                  "penalty",

               )

               -- Accept breaking after (only).

                  "penalty",

               )

            else

               -- Accept breaking after, but tolerate breaking before.

                  "penalty",

               )

                  "penalty",

               )

            end

         end

      end

   end

               -- Trick the engine by declaring a "fake"" language that doesn't apply

               -- the typographic rules for punctuations

               -- Not needed (the engine already defaults to SILE.nodeMakers.unicode if

               -- the language is not found):

               -- SILE.nodeMakers._fr_noSpacingRules = SILE.nodeMakers.unicode

            else

            end

         else

         end

            primaryPenalty = primaryPenalty,

            secondaryPenalty = secondaryPenalty,

            worsePenalty = worsePenalty,

         })

      end)

end

package.documentation = [[

\begin{document}

\use[module=packages.url]

This package enhances the typesetting of URLs in two ways.

First, it provides the \autodoc:command{\href[src=<url>]{<content>}} command which inserts PDF hyperlinks, \href[src=http://www.sile-typesetter.org/]{like this}.

The \autodoc:command{\href} command accepts the same \autodoc:parameter{borderwidth}, \autodoc:parameter{bordercolor}, \autodoc:parameter{borderstyle}, and \autodoc:parameter{borderoffset} styling options as the \autodoc:command[check=false]{\pdf:link} command from the \autodoc:package{pdf} package, for instance \href[src=http://www.sile-typesetter.org/, borderwidth=0.4pt, bordercolor=blue, borderstyle=underline]{like this}.

Nowadays, it is a common practice to have URLs in print articles (whether it is a good practice or not is yet \em{another} topic).

Therefore, the package also provides the \autodoc:command{\url} command, which will automatically insert breakpoints into unwieldy URLs like \url{https://github.com/sile-typesetter/sile-typesetter.github.io/tree/master/examples} so that they can be broken up over multiple lines.

It allows line breaks after the colon, and before or after appropriate segments of an URL (path elements, query parts, fragments, etc.).

By default, the \autodoc:command{\url} command ignores the current language, as one would not want hyphenation to occur in URL segments.

If you have no other choice, however, you can pass it a \autodoc:parameter{language} option to enforce a language to be applied.

Note that if French (\code{fr}) is selected, the special typographic rules applying to punctuations in this language are disabled.

To typeset a URL and also make it an active hyperlink, use the \autodoc:command{\href} command without the \autodoc:parameter{src} option,

but with the URL passed as argument.

The breaks are controlled by two penalty settings: \autodoc:setting{url.linebreak.primaryPenalty} for preferred breakpoints and, for less acceptable but still tolerable breakpoints, \autodoc:setting{url.linebreak.secondaryPenalty}—its value should logically be higher than the previous one.

The \autodoc:command{\urlstyle} command hook may be overridden to change the style of URLs.

By default, they are typeset as “code”.

\end{document}