docs/WRITING_SIGS

   1 Simon Huggins <huggie@earth.li>
   2
   3 Sigs are essentially just text files with special characters inside them.
   4
   5 There are two (ish) types of special characters:
   6         - those that just get substituted
   7         - those that get padded and aligned
   8
   9 For a full definition of reserved letters and macros that can exist please
  10 read MACRO_DESCRIPTION.  Yeah, I know there is overlap but this file is
  11 meant to help you write sigs and MACRO_DESCRIPTION is meant to be an
  12 authoritative reference file.
  13
  14 See the end for the examples which are probably more interesting.
  15
  16 Straight substitutions
  17 ======================
  18
  19         Becomes
  20 @B      A newline.  This is a bit pointless for sigs - why have a macro to
  21         insert a newline when you can just put one in yourself?
  22         It's useful for taglines.
  23 @F      First name of person in To: line.
  24 @L      Last name of person in To: line.
  25 @N      Whole name of person in To: line.
  26 @V      Version of htag.pl (format x.y.z i.e. 0.0.17)
  27
  28 Padding and Aligning
  29 ====================
  30
  31 Ok, substitutions of this sort are done to a set number of characters.
  32
  33 They are of the form:
  34 @[A-Za-z]?[1-9][0-9]*[RC]?@
  35
  36 That is:
  37         - An @ symbol
  38         - An optional letter
  39                 * If it's not there it means insert a bit of the tagline
  40                   you've selected (multiple ones of these are replaced with
  41                   multiple sections of tagline)
  42                 * If it does exist it means insert a bit of the plugin that
  43                   deals with that particular letter (multiple ones of these
  44                   are replaced each time with a new line from the plugin)
  45         - A number
  46                 * This is the exact number of characters that will be
  47                   inserted.
  48         - An optional alignment
  49                 * R for right padded with spaces
  50                 * C for centered padded with spaces
  51                 * Nothing for left aligned padded with spaces on the right.
  52         - An @ symbol
  53
  54
  55 What this all means
  56 ===================
  57
  58 It's probably best shown with examples:
  59
  60 @40@ means insert 40 characters of the tagline chosen left aligned.
  61 @64R@ means right align over 64 characters part of the tagline.
  62
  63
  64 @20R@ @20@ means right align 20 characters of tagline and then put a space
  65 and then left align another 20.
  66
  67 With letters:
  68
  69 @U20@ means print in 20 characters the output of the uptime plugin
  70 (depending on the settings in htrc this is normally of the form:
  71 up 23 days, 3:41)
  72
  73 @U1@ means give me an error message because I didn't give it enough space to
  74 put the uptime in.
  75
  76 Here is one of my sigs:
  77
  78 --
  79 UK based domain, email and web hosting ***/ @28R@ /*
  80 http://www.blackcatnetworks.co.uk/     **/ @28R@ /**
  81 sales@blackcatnetworks.co.uk           */ @28R@ /***
  82 Black Cat Networks                     / @28R@ /****
  83
  84 It just sticks the tagline inside the slanty bit right aligned.
  85
  86 And another:
  87
  88 --
  89 Just another wannabie | @30C@ |  Just another fool
  90 ----------------------+ @30C@ +-------------------
  91 This message was brought to you @S30@.
  92 htag.pl @V -- http://www.earth.li/projectpurple/progs/htag.html
  93
  94 This puts the tagline in the middle over two lines and centers it.  It
  95 replaces S30 with by the letter A and the number 1 where A and 1 are
  96 randomly chosen letters using the sesame plugin and it replaces @V with the
  97 current version of htag.pl
  98
  99 Hope that helped a bit.
 100 Send me any good sigs that you write :)