139
edits
Changes
Jump to navigation
Jump to search
== Hyphenation ==
adapt display to the wiki
== Overview ==
URLs can be typeset in various ways. You may specify a URL for later reuse via [[{{cmd:useURL|\useURL]]}}:
<texcode>
\useURL[aurl] [http://xkcd.com/149/] [] [I prefer hot dogs.]
</texcode>
where #1 is the identifier, #2 is the URL you want to point to, and #4 the text to be displayed where the URL is used. #3 can be used for the 'file path' portion of the URL, if you want. This dates back to when hyperlink support in
</texcode>
<!--You can use
<texcode>
\url[aurl]
</texcode>
as well, which behaves like {{cmd|from}}[#1].--> URL shortcuts defined by {{cmd|useURL}} can be used while {{cmd|url}} as well:<texcode>\url[aurl]</texcode> == How to Typeset URLs == === Example for Mailto #1 ===<context source=yes>\setupinteraction[state=start]\useurl [mymail] [mailto:nobody@example.zzz] [][visible@mailaddress.zzz] Send your spam to \from[mymail]!</context> === Example for Mailto #2 === <context source=yes>\setupinteraction[state=start] Send your spam to \goto{visible@mailaddress.zzz}[url(mailto:nobody@example.zzz)]</context> === Example for WWW ({{cmd|goto}}) === Another way of typesetting URLs is the {{cmd|goto}}: \goto{#1}[#2] command. This expects the description text as first argument and the actual URL as the second one; note that it has to be wrapped in url(#2) to create a clickable link:<texcode>\goto{In Lua, array indices start from one.}[url(http://www.xkcd.com/163/)]</texcode> === Escaping of Special Characters === You might be interested in [[URL#Avoid_Escaping_Characters|not escaping characters]]. Note that special characters, eg hash sign, percent sign, must be escaped by backslash. Escaping means that the special character will be processed one step later and it preventsannoying error messages during compilation. The <code>#</code> sign will be replaced by <code>\#</code>,the <code>%</code> sign by <code>\%</code>, etc. <context source=yes>\setupinteraction[state=start]\useurl [myurl] [www.example.zzz/\#999] [] [www.example.zzz/\#999]</context> Another way of writing special characters is described below, with hyphenated URLs. == Hyphenated URLs ==
URLs tend to become large monsters under many circumstances but you may have a good reason not to conceal them from the reader.
This is where hyphenation comes in handy.
ConTeXt provides a dedicated mechanism for chopping them into pieces:
<context source=yes>
\enabledirectives[hyphenators.urls.packslashes] % this avoids consecutive slashes each in a different line
\sethyphenatedurlbefore{/} % but then they seem to be fixed to what comes before and after them
\startTEXpage[width=7em, foregroundstyle=\ttb] % just to display the output better
\hsize\zeropoint % to see where lines may be broken
\hyphenatedurl{http://bits.blogs.nytimes.com/2010/03/05/a-former-book-designer-says-good-riddance-to-print/?hpw}
\stopTEXpage
</context>
The previous sample shows all possible line breaks, since horizontal size (text width) has been set to zero ({{cmd|hsize}}{{cmd|zeropoint}}).
=== Hyphenation Rules ===
This has some characters predefined where Hans “likes” URLs to break (see the list at the beginning of [[source:lang-url.lua|lang-url.lua]], cf. [http://www.ntg.nl/pipermail/ntg-context/2008/032959.html a message on ntg-context]).
If you prefer other characters you can add them via:
</texcode>
== Other ways =Escaping Special Characters === Another way The method for escaping of typesetting URLs special characters described above does not work with command{{cmd|hyphenatedurl}} completely, unfortunately. Escaping backslash will undesirably appear on the output when percent sign is printed out. Similar problems bring hash sign and backslash. Therefore, these three characters must be rewritten to commands, see the [[following list:<table><tr><td><code>%</code></td><td> --> <code>{{cmd|letterpercent}}</code></td></tr><tr><td><code>#</code></td><td> --> <code>{{cmd:goto|letterhash}}</code></td></tr><tr><td><code>\goto</code></td><td> --> <code>{{#1cmd|letterescape}} or {{cmd|letterbackslash}}[#2]]] command. This expects the description text as first argument and the actual URL as the second one; note that </code></td></tr></table> For other characters, similar commands have been predefined but it has is not necessary to use them. <table><tr><td><code>&</code></td><td> --> <code>{{cmd|letterampersand}}</code></td></tr><tr><td><code><</code></td><td> --> <code>{{cmd|letterless}}</code></td></tr><tr><td><code>></code></td><td> --> <code>{{cmd|lettermore}}</code></td></tr><tr><td><code>"</code></td><td> --> <code>{{cmd|letterdoublequote}}</code></td></tr><tr><td><code>'</code></td><td> --> <code>{{cmd|lettersinglequote}}</code></td></tr><tr><td><code>$</code></td><td> --> <code>{{cmd|letterdollar}}</code></td></tr><tr><td><code>^</code></td><td> --> <code>{{cmd|letterhat}}</code></td></tr><tr><td><code>_</code></td><td> --> <code>{{cmd|letterunderscore}}</code></td></tr><tr><td><code>|</code></td><td> --> <code>{{cmd|letterbar}}</code></td></tr><tr><td><code>~</code></td><td> --> <code>{{cmd|lettertilde}}</code></td></tr><tr><td><code>/</code></td><td> --> <code>{{cmd|letterslash}}</code></td></tr><tr><td><code>?</code></td><td> --> <code>{{cmd|letterquestionmark}}</code></td></tr><tr><td><code>!</code></td><td> --> <code>{{cmd|letterexclamationmark}}</code></td></tr><tr><td><code>@</code></td><td> --> <code>{{cmd|letterat}}</code></td></tr><tr><td><code>:</code></td><td> --> <code>{{cmd|lettercolon}}</code></td></tr><tr><td><code>{</code></td><td> --> <code>{{cmd|letterbgroup}}</code> or <code>{{cmd|letteropenbrace}}</code> or <code>{{cmd|letterleftbrace}}</code></td></tr><tr><td><code>}</code></td><td> --> <code>{{cmd|letteregroup}}</code> or <code>{{cmd|letterclosebrace}}</code> or <code>{{cmd|letterrightbrace}}</code></td></tr></table> A custom symbol can be wrapped inserted as well, eg in url(#2) to create case of a clickable linklinebreak:
<texcode>
\gotodef\hyphenatedurlseparator{In Lua, array indices start from one.↩}[url(http://www.xkcd.com/163/)]
</texcode>
These special commands can be used in other cases, like {{cmd|useURL}}, too. == Setting color Color and style Style ==For \{{cmd|url}}:
<texcode>
\setupurl
style=\tf]
</texcode>
For \{{cmd|goto }} and \{{cmd|from}}:
<texcode>
\setupinteraction
style=\tf]
</texcode>
== Tips and Tricks ==
=== Using variable URLs ===
When using variables, or macros in general, it's necessary to consider that <code>\useURL</code> '''doesn't expand''', which means that any commands within will be treated like text and printed plainly, i.e. instead of the hyperlink the command name will be pasted to the browser or mail client. To circumvent this use <code>\expanded{}</code> around <code>\useURL</code>:
<texcode>
\expanded{\useURL[][][][]}
</texcode>
The following MWE demonstrates the issue.
<texcode>
\setupinteraction[state=start]
%
\setvariables[Sender][Mail={ntg-context@ntg.nl}]
%
\useURL[Direct][mailto:ntg-context@ntg.nl][][ntg-context@ntg.nl]
\useURL[Unexpanded][mailto:\getvariable{Sender}{Mail}][][\getvariable{Sender}{Mail}]
% same as above but within \expanded{}:
\expanded{\useURL[Expanded][mailto:\getvariable{Sender}{Mail}][][\getvariable{Sender}{Mail}]}
%
\starttext
\from[Direct] Direct input works\blank
\from[Unexpanded] Unexpanded fails\blank
\from[Expanded] Expanded works\blank
%
In the PDF mind the tooltips and how the wrong line transfers to the mail client.
\stoptext
</texcode>
=== Many Different Hyperrefs ===
If you need many hyperrefs in your document these definitions may be handy for you
<context source=yes>
\def\href#1#2{\useURL[#2][{#2}][][{#1}]\goto{\url[#2]}[url(#1)]}
\def\ahref#1{\color[linkcolor]{\ttx \href{#1}{<#1>}}}
\def\fullahref#1{\color[linkcolor]{\ttx \href{#1}{http://#1}}}
\def\mailto#1{\useURL[#1][mailto:#1][][#1]\from[{#1}]}
\def\MailTo#1#2{\useURL[#1][mailto:#1][][#2]\from[{#1}]}
Send mail to \MailTo{foo@bar.zzz}{Mr. Foo}
</context>
=== Avoid Escaping Characters ===
In case you don’t want to escape characters from your URLs, you might want to use the following command:
<context source="yes">
\setupinteraction[state=start]
\setupnote[footnote][location=text]
\setupnotation[footnote][alternative=serried, numbercommand=\tfx]
\unexpanded\def\mypersonalurl#1{%
\bgroup\tt\goto{\hyphenatedurl{#1}}[url(#1)]\egroup}
\startasciimode
\mypersonalurl{http://a.b?hpw%20h#pw}
\stopasciimode
\startasciimode
\footnote{\mypersonalurl{http://a.b?hpw%20h#pw}}
\stopasciimode
\placenotes[footnote]
</context>
But you have to consider one option to make it work:
* Setting {{cmd|asciimode}} for the whole document.<p>Comments won’t work, because <code>%</code> will be considered a standard character.</p>
* Wrapping all URLs inside {{cmd|startasciimode}}...{{cmd|stopasciimode}}.<p>If you use URLs inside footnotes, it is the whole footnote which has to be inside the pair of commands.</p><p>Comments inside the mode won’t work.</p>
=== External Links ===
Create a macro for external links in a colour that is distinct from other document links.
<context source="yes">
% Enable document colours
\setupcolors[state=start,]
% Internal link colours
\setupinteraction[state=start,color=blue,]
% External link colours
\definecolor[steelblue][h=4682B4]
\define[2]\href{%
\begingroup
\setupinteraction[
style=normal,
color=steelblue,
]%
\goto{#1}[url(#2)]%
\endgroup%
}
% Set index colours
\setupcombinedlist[content][
interaction=all,
color=red,
]
% Set the table of contents colours
\setuplist[chapter][
% Text colour
color=darkcyan,
% Page number colour
pagecolor=darkgreen,
]
% Set up the index heading colour
\setupregister[index][
color=darkgray,
balance=no,
]
\def\Google{G\color[red]{o}\color[orange]{o}g\color[green]{l}\color[red]{e}}
%\starttext % makes no sense in the wiki
\startTEXpage[offset=1dk, foregroundstyle=\tfb]
\completecontent
% \startchapter[title=chapter]
Search \index{source code}{source code} using \href{\Google{} Website}{http://google.com}! Read about
\index{syntax}{syntax}.
% \stopchapter
\blank
\placeindex
\stopTEXpage
%\stoptext % makes no sense in the wiki
</context>
[[Category:Basics]]
[[Category:Interaction]]
