Documentation/common-macros.itexi

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