params/link.to.self.for.mediaobject.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

<refentry xmlns="http://docbook.org/ns/docbook" 
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude" 
          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
          xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
          version="5.0" xml:id="link.to.self.for.mediaobject">
  <refmeta>
    <refentrytitle>link.to.self.for.mediaobject</refentrytitle>
    <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>link.to.self.for.mediaobject</refname>
    <refpurpose>Include <tag>a</tag> element to image objects itself to go to a full-size, freely-zoomable version</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
<src:fragment xml:id="link.to.self.for.mediaobject.frag">
<xsl:param name="link.to.self.for.mediaobject" select="0"/>
</src:fragment>
  </refsynopsisdiv>

  <refsection>
    <info>
      <title>Description</title>
    </info>
    <para>In some cases, it can be very helpful to be able to click on an embedded <tag>figure</tag>
      or <tag>informalfigure</tag> to get a full-size, freely-zoomable version of an image, for
      instance when targeting readers on smartphones. This is implemented for images only, but not
      for audio or video objects. </para>
        
    <para>If non-zero, the image will be wrapped in an <tag>a</tag> element, using the <tag class="attribute">href</tag> 
      attribute pointing to the image itself: </para>
    <screen>&lt;a href="source/image">
   &lt;!-- the image object -->
&lt;/a></screen>

    <para> If the value of <parameter>link.to.self.for.mediaobject.xml</parameter> is zero
      (default), then no <tag>a</tag> container is added. </para>
  </refsection>
</refentry>