Documentation/common-macros.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2
   3
   4
   5 @c Don't replace quotes with directed quotes.
   6
   7 @set txicodequoteundirected
   8 @set txicodequotebacktick
   9
  10
  11 @c   ***** Displaying text *****
  12
  13 @c We need this since @q{\} doesn't work with makeinfo 4.11 --
  14 @c say @q{@bs{}} instead.
  15
  16 @macro bs
  17 \\
  18 @end macro
  19
  20
  21 @ifnotinfo
  22
  23 @macro notation{TEXT}
  24 @var{\TEXT\}
  25 @end macro
  26
  27 @end ifnotinfo
  28
  29 @ifinfo
  30
  31 @macro notation{TEXT}
  32 \TEXT\
  33 @end macro
  34
  35 @end ifinfo
  36
  37
  38 @macro smallspace
  39 @sp 1
  40 @end macro
  41
  42
  43 @c   ***** Displaying images not generated by lilypond-book *****
  44
  45 @c Current installation setup of Info docs requires that all images are
  46 @c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
  47 @c already generates proper @image commands for images of music; these
  48 @c macro definitions do the same for other images.
  49
  50 @ifnotinfo
  51
  52 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  53 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  54 @end macro
  55
  56 @end ifnotinfo
  57
  58 @ifinfo
  59
  60 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
  61 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
  62 @end macro
  63
  64 @end ifinfo
  65
  66
  67 @c   ***** Headers *****
  68
  69 @ifclear snippets-sections
  70 @macro lydoctitle {TEXT}
  71 @emph{\TEXT\}
  72 @end macro
  73 @end ifclear
  74
  75 @c   ***** Indexing *****
  76
  77 @c Don't remove the `@c' within the macro definition!  See section 19.3,
  78 @c `Macro Details and Caveats', in the texinfo info file for explanation.
  79
  80 @macro funindex {TEXT}
  81 @findex \TEXT\
  82 @kindex \TEXT\
  83 @c
  84 @end macro
  85
  86
  87 @c   ***** Macros specific to translated docs *****
  88
  89 @c ugh, cannot set/define global variable 'translationof' in any way :-(
  90
  91 @iftex
  92
  93 @macro translationof{TEXT}
  94 @end macro
  95
  96 @end iftex
  97
  98 @ifinfo
  99
 100 @macro translationof{TEXT}
 101 @set translationof \TEXT\
 102 @end macro
 103
 104 @end ifinfo
 105
 106 @ifhtml
 107
 108 @ifset bigpage
 109 @macro untranslated
 110 @end macro
 111 @end ifset
 112
 113 @ifclear bigpage
 114 @macro untranslated
 115 UNTRANSLATED NODE: IGNORE ME
 116 @end macro
 117 @end ifclear
 118
 119 @end ifhtml
 120
 121 @ifnothtml
 122
 123 @macro untranslated
 124 @end macro
 125
 126 @end ifnothtml