{"id":362,"date":"2010-09-08T23:47:50","date_gmt":"2010-09-08T18:17:50","guid":{"rendered":"http:\/\/www.cvr.cc\/?p=362"},"modified":"2010-09-08T23:47:50","modified_gmt":"2010-09-08T18:17:50","slug":"tex4ht-configure-part-2","status":"publish","type":"post","link":"https:\/\/cvr.cc\/?p=362","title":{"rendered":"TeX4ht: Configure Part 2"},"content":{"rendered":"

Navigation Links for Sectioning Divisions<\/h4>\n

\\Configure{crosslinks}<\/code> provides hooks to create navigation links across sub-documents created from a long document like book where chapters are broken into separate HTML<\/small> documents or a long article where sections might be cut into separate documents for easy browsing. \\CutAt{...}<\/code> helps to split a long document at the desired section or chapter or part units. When documents are split into smaller units, we need navigation links across various split units. Te<\/span>X4ht provides an important function, \\Configure{crosslink}<\/code>, which is explained below how various navigational links can be created and customized.<\/p>\n

  \\Configure{crosslinks}.....................8\n<\/pre>\n\n\n\n\n\n\n\n\n\n\n\n
#1<\/td>\nleft delimiter<\/td>\n<\/tr>\n
#2<\/td>\nright delimiter<\/td>\n<\/tr>\n
#3<\/td>\nnext<\/td>\n<\/tr>\n
#4<\/td>\nprevious<\/td>\n<\/tr>\n
#5<\/td>\nprevious-tail<\/td>\n<\/tr>\n
#6<\/td>\nfront<\/td>\n<\/tr>\n
#7<\/td>\ntail<\/td>\n<\/tr>\n
#8<\/td>\nup<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
An example of the above configuration setup shall be as given below:<\/p>\n
  \\Configure{crosslinks}\n   {\\texttt{<}} {\\texttt{>}}\n   {Next}{Prev}\n   {PrevTail}{Front}\n   {Tail}{Up}\n<\/pre>\n
See the figure below which shows the results of the above code:<\/p>\n
\"crosslink1\"<\/a>
Navigation links as shown at the top of the HTML page.<\/figcaption><\/figure>\n
If you want to re-order the way the navigation widgets are displayed, you might make use of Configure{crosslinks*}<\/code> command. It has seven arguments, where, six arguments have values while the last one (seventh) shall be empty.<\/p>\n
  \\Configure{crosslinks*}.................1--7\n<\/pre>\n
Available options and their defaul order: next<\/code>, prev<\/code>, prevtail<\/code>, tail<\/code>,
\nfront<\/code>, up<\/code>. The last argument must be empty. See below:<\/p>\n
Default:<\/p>\n
  \\Configure{crosslinks*}\n    {next}\n    {prev}\n    {prevtail}\n    {tail} {front}\n    {up}\n    {}\n<\/pre>\n
  \\Configure{crosslinks+}.....................4\n<\/pre>\n\n\n\n\n\n\n\n
#1<\/td>\nbefore top menu<\/td>\n<\/tr>\n
#2<\/td>\nafter top menu<\/td>\n<\/tr>\n
#3<\/td>\nbefore bottom menu<\/td>\n<\/tr>\n
#4<\/td>\nafter bottom menu<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\\Configure{crosslinks+}<\/code> provides further facilities to add extra hooks to the cross linking widgets at top and bottom of the HTML<\/small> document. The top cross links are omitted, if both #1 and #2 are empty. The bottom cross links are omitted, if both #3 and #4 are empty.<\/p>\n
The following hook provides to link the document which you want to navigate to from the first page. This will be honoured unless you invoke the htlatex<\/code> kind of scripts with next<\/code> as one of the options.<\/p>\n
  \\Configure{next}.....................1\n<\/pre>\n\n\n\n
#1<\/td>\nthe anchor of the next button of the front page.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
{next+}<\/code> helps to provided extra hooks in the beginning and end of the hyperlink elements in the {next}<\/code> in the first page.<\/p>\n
  Configure{next+}.............................2\n<\/pre>\n\n\n\n\n\n
#1<\/td>\nbefore the next button of the front page, when the next<\/code> option is active.<\/td>\n<\/tr>\n
#2<\/td>\nafter the button<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Here is an example for the above hooks:<\/p>\n
  Configure{next}{GoTo My Document}\n  \\Configure{next+}{\\Tg<span class=\"clinks\">}{\\Tg<\/span>}\n<\/pre>\n
and will create the link widget as shown in the following screen shot of the first page of the test document.<\/p>\n
\"crosslink4\"<\/a>
Custom navigation link in the first page.<\/figcaption><\/figure>\n
Default: The values provided by default in Configure{crosslinks}<\/code> can
\nbe changed with the following Configure<\/code> hooks.<\/p>\n
 \\ Configure{crosslinks:next}..................1\n  \\Configure{crosslinks:prev}..................1\n  \\Configure{crosslinks:prevtail}..............1\n  \\Configure{crosslinks:tail}..................1\n  \\Configure{crosslinks:front}.................1\n  \\Configure{crosslinks:up}....................1\n<\/pre>\n\n\n\n\n
#1<\/td>\nlocal configurations for the delimiters and hooks<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
  \\Configure{crosslinks-}.....................2\n<\/pre>\n
Asks to show linkless buttons with the following insertions.<\/p>\n\n\n\n\n\n
#1<\/td>\nbefore<\/td>\n<\/tr>\n
#2<\/td>\nafter<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
The default values are used, if both #1<\/code> and #2<\/code> are empty.<\/p>\n
Example<\/h4>\n
  \\Configure{crosslinks-}{}{}\n  \\Configure{crosslinks-}\n     \\{HCode{<span class=\"hidden\">}[}\n     {]\\HCode{<\/span>} }\n  \\Css{span.hidden {visibility:hidden;}}\n<\/pre>\n
A typical example of the cross links for navigation is given below along with screenshot of the resulting HTML<\/small> page.<\/p>\n
\\Configure{crosslinks}\n  {\\Tg<td class=\"clinks\">} {\\Tg<\/td>}\n  {Next}{Prev}\n  {PrevTail}{Front}\n  {Tail}{Up}\n\\Css{.clinks{border: solid 1px; border-color: orange;\n    padding-left: 6px; padding-right: 6px;\n    padding-top: 3px; padding-bottom: 3px;\n    border-radius: 6px; background-color: #fff5f5;\n    -moz-border-radius: 6px 6px 0px 0px;\n    -webkit-border-radius: 6px 6px 0px 0px;}}\n\\Css{a:visited{color: gray; text-decoration: none;}}\n\\Css{a:link{color: #27d; text-decoration: none;}}\n\\Css{a:hover{color: blue; text-decoration; none;}}\n  \\Configure{crosslinks*}\n    {up}\n    {next}\n    {prev}\n    {prevtail}\n    {tail} {front}\n    {}\n\\Configure{crosslinks+}\n   {\\HCode{<table cellspacing=\"5\"><tr>}}\n   {\\HCode{<\/tr><\/table>}}\n   {\\HCode{<table cellspacing=\"5\"><tr>}}\n   {\\HCode{<\/tr><\/table>}}\n<\/pre>\n
\"crosslink3\"<\/a>
Screenshot of navigation links created by code in the example.<\/figcaption><\/figure>\n
Cross-linking<\/h4>\n
Cross-linking assumes much importance in hyperlinked documents. There are different kinds of links in a document, namely, internal links created by simple \\label{...}<\/code> and \\ref{...}<\/code> mechanism of La<\/small><\/span>Te<\/span>X, linking index entries to respective locations in the document body, linking table of contents to the respective entries, hyperlinks created by hyperref<\/code><\/a> package or user defined macros which link content to external URL<\/small>\u2019s, files, multimedia components, etc. Te<\/span>X4ht has a generic mechanism to link various types of links. A special file, \\jobname.xref<\/code> is written during the translation process which is akin to the jobname.aux<\/code> in La<\/small><\/span>Te<\/span>X. The entries in \\jobname.xref<\/code> have special syntax meaningful to Te<\/span>X4ht alone are read in subsequent runs and made use of to build hyperlinks in the HTML<\/small> document generated.<\/p>\n
  \\Link[@1 @2]{@3}{@4}...EndLink\n<\/pre>\n
Creates<\/p>\n
  <a href=\"@1#@3\" name=\"@4\" @2>...<\/a>\n<\/pre>\n
    \n
  • When @1<\/code> is empty, Te<\/span>X4ht will derive its value automatically. The derived value will be the file name containing the target @3<\/code>.<\/li>\n
  • \\Link<\/code> may be followed by -<\/code>, if Te<\/span>X4ht needs not automatically determine (for other link<\/code> commands) the file containing @4<\/code>. In the present of such a flag, Te<\/span>X4ht can spare a definition of one macro.<\/li>\n
  • The component [@1 @2]<\/code> is optional. If omitted, @1<\/code> and @2<\/code> are assumed to be empty.<\/li>\n
  • The \\href<\/code> attribute is omitted when @1<\/code> and @3<\/code> are empty.<\/li>\n
  • The name attribute is omitted when @4<\/code> is empty.<\/li>\n<\/ul>\n
    Example<\/h4>\n
      \\Link{a}{}...\\Endlink .....  \\Link{}{b}...\\EndLink\n  \\Link[http:\/\/foo  id=\"fooo\"]{a}{b}...\\EndLink\n  \\Configure{Link}..............4\n<\/pre>\n
    Configures \\Link...\\EndLink<\/code> so that<\/p>\n\n\n\n\n\n\n\n
    #1<\/td>\nreplaces a<\/code><\/td>\n<\/tr>\n
    #2<\/td>\nreplaces href=<\/code><\/td>\n<\/tr>\n
    #3<\/td>\nreplaces name=<\/code><\/td>\n<\/tr>\n
    #4<\/td>\nreplaces \u2018#\u2019. If empty, the older value remains in effect.<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Example<\/h4>\n
      \\Configure{Link}{a}{href=}{name=}{}\n  \\Configure{Link}{ref}{target=}{id=}{empty}\n  \\Configure{?Link}..............1\n<\/pre>\n\n\n\n\n
    #1<\/td>\ninsertion before broken links<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    To help with debugging<\/p>\n
    \\LinkCommand...................1 <= i <= 6\n<\/pre>\n
    Creates a Link<\/code>-like command<\/p>\n\n\n\n\n\n\n\n\n\n
    #1<\/td>\ntag name<\/td>\n<\/tr>\n
    #2<\/td>\nhref-like attribute<\/td>\n<\/tr>\n
    #3<\/td>\nname-like attribute<\/td>\n<\/tr>\n
    #4<\/td>\ninsertion<\/td>\n<\/tr>\n
    #5<\/td>\n\/<\/code>, if empty element<\/td>\n<\/tr>\n
    #6<\/td>\nreplacement for # (ignored if absent)<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Other types<\/h4>\n
    Example<\/h4>\n
      \\LinkCommandJSLink{a,noexpandjsref,name}\n  defjsref=\"#1\"{href=\"javascript:window.open(\u2019#1\u2019)\"}\n  \\JSLink{a}{}xxEndJSLink\n  \\Link{}{a}\\EndLink       % or \\JSLink{}{a}\\EndJSLink\n  \\Configure{XrefFile}.....................1\n<\/pre>\n\n\n\n\n
    #1<\/td>\nnames cross-references of files (appends #1 to )F<\/code> and )Q<\/code> entries of the .xref<\/code> files). Applicable mainly implicitly within Link <\/code> commands.<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
      Tag.....................................2\n<\/pre>\n\n\n\n\n\n
    #1<\/td>\nlabel<\/td>\n<\/tr>\n
    #2<\/td>\ncontent<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
      \\Ref.....................................1\n  \\LikeRef.................................1\n<\/pre>\n\n\n\n\n
    #1<\/td>\nlabel<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \\Tag<\/code> and \\Ref<\/code> are tex4ht.sty<\/code> commands introduced cross-referencing content through .xref<\/code> auxiliary files.<\/p>\n
    \\LikeRef<\/code> is a variant of \\Ref<\/code> which doesn\u2019t verify whether the labels exist. It is mainly used in \\Link<\/code> and edef<\/code> environments.<\/p>\n
      \\ifTag ..................................3\n<\/pre>\n\n\n\n\n\n\n
    #1<\/td>\nquetioned tag<\/td>\n<\/tr>\n
    #2<\/td>\ntrue part<\/td>\n<\/tr>\n
    #3<\/td>\nfalse part<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
      \\LoadRef-[prefix]+{filename.ext}{pattern}\n<\/pre>\n
    Load the named xref-type file<\/p>\n\n\n\n\n\n\n\n\n
    .xref<\/td>\noptional — .xref<\/code> is assume for a default<\/td>\n<\/tr>\n
    +<\/td>\noptional — asks Ref <\/code> and LikeRef <\/code> commands to use expanded tags filename::tag<\/code>, instead of just tag<\/code><\/td>\n<\/tr>\n
    [prefix]<\/td>\noptional — asks just for tags starting with the specified prefix.<\/td>\n<\/tr>\n
    –<\/td>\noptional — deletes the prefixes from the loaded tags<\/td>\n<\/tr>\n
    {pattern}<\/td>\nto be included only when [prefix]<\/code> or +<\/code> are included. States how tags are to be addressed, with the parameter symbol \u2018#1\u2019 specifying the loaded part.<\/td>\n<\/tr>\n
    <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Example<\/h4>\n
      % a.tex\n  \\LoadRef-[to:]{b}{from:#1}   \\Ref{from:filename}\n                               \\LikeRef{from:filename}\n  % b.tex\n  \\Tag{to:filename}{FileName}\n<\/pre>\n
    Example<\/h4>\n
      \\LoadRef-[)F]{file}{)Ffoo##1}\n  \\LoadRef-[)Q]{file}{)Qfoo##1}\n  \\Configure{XrefFile}{foo}   \\Link...\\EndLink\n  \\LoadRef{another-file}\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
    Navigation Links for Sectioning Divisions \\Configure{crosslinks} provides hooks to create navigation links across sub-documents created from a long document like book where chapters are broken into separate HTML documents or a long article where sections might be cut into separate documents for easy browsing. \\CutAt{…} helps to split a long document at the desired section […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[21,15,16],"tags":[],"class_list":["post-362","post","type-post","status-publish","format-standard","hentry","category-configure","category-tex","category-tex4ht"],"_links":{"self":[{"href":"https:\/\/cvr.cc\/index.php?rest_route=\/wp\/v2\/posts\/362","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cvr.cc\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/cvr.cc\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/cvr.cc\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cvr.cc\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=362"}],"version-history":[{"count":0,"href":"https:\/\/cvr.cc\/index.php?rest_route=\/wp\/v2\/posts\/362\/revisions"}],"wp:attachment":[{"href":"https:\/\/cvr.cc\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=362"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/cvr.cc\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=362"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/cvr.cc\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=362"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}