remove revhistory

[sitka/doc/style.git] / style / style-links.xml

<?xml version="1.0" encoding="utf-8"?>\r
<chapter xml:id="style-links" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
    xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
\r
    <info>\r
\r
        <title>Creating Links</title>\r
    </info>\r
\r
<para>There are many way to link w/ docbook but the options in the table below cover the most common documentation scenarios.</para>\r
\r
\r
    <informaltable>\r
\r
        <tgroup cols="4" align="left" colsep="1" rowsep="1">\r
\r
            <thead>\r
                <row>\r
                    <entry>Linking scenario</entry>\r
                    <entry>Syntax</entry>\r
                    <entry>Output</entry>\r
                    <entry>Notes</entry>\r
\r
                </row>\r
            </thead>\r
\r
\r
\r
            <tbody>\r
                <row>\r
                    <entry>Internal link with auto-generated link text</entry>\r
                    <entry><![CDATA[ <xref linkend="style-glossary"/> ]]></entry>\r
                    <entry>\r
                        <xref linkend="style-glossary"/>\r
                    </entry>\r
                    <entry>The <emphasis>linkend</emphasis> value (<emphasis>style-glossary</emphasis>) is the xml:id of\r
                        the target element; link text is auto-generated from the target. The tag is\r
                        self-closing (no <![CDATA[</xref>]]> closing tag required></entry>\r
                </row>\r
                <row>\r
                    <entry>Internal link with custom link text</entry>\r
                    <entry><![CDATA[ <link linkend="style-glossary">The Sitka glossary page</link> ]]></entry>\r
                    <entry><link linkend="style-glossary">The Sitka glossary page</link></entry>\r
                    <entry><emphasis>linkend</emphasis> is the <emphasis>xml:id</emphasis> of the target element; link text is supplied by author</entry>\r
                </row>\r
                <row>\r
                    <entry>External link</entry>\r
                    <entry><![CDATA[ <link xlink:href="https://bc.libraries.coop/" xlink:title="Link hover text goes here">https://bc.libraries.coop/</link> ]]></entry>\r
                    <entry><link xlink:href="https://bc.libraries.coop/" xlink:title="Link hover text goes here">https://bc.libraries.coop/</link></entry>\r
                    <entry><emphasis>xlink:href</emphasis> is the target URL. In Sitka docs show full URL so users can see it in PDF or copy and paste from the staff client (to open in a separate browser)</entry>\r
                </row>\r
<row>\r
                    <entry>External link open in New Tab</entry>\r
                    <entry><![CDATA[ <link xlink:show="new" xlink:href="https://bc.libraries.coop/"><emphasis role="bold">Sitka's Evergreen New Features in release 2.10 (5:55)</emphasis> </link> ]]></entry>\r
                    <entry><link xlink:show="new" xlink:href="https://bc.libraries.coop/" xlink:title="Link hover text goes here">https://bc.libraries.coop/</link></entry>\r
                    <entry><emphasis>xlink:show="new"</emphasis> opens the target in a New Browser Tab</entry>\r
                </row>\r
\r
\r
            </tbody>\r
        </tgroup>\r
    </informaltable>\r
    \r
    <para>For internal links the hover tip text is generated automatically; for external links please include an xlink:title, otherwise the link hover text will be the name of the section or chapter where the link appears.</para>\r
\r
\r
</chapter>\r