git.notmuchmail.org Git - notmuch/blob - devel/nmbug/doc/man5/notmuch-report.json.5.rst

   1 ==============
   2 notmuch-report
   3 ==============
   4
   5 NAME
   6 ====
   7
   8 notmuch-report.json - configure output for **notmuch-report(1)**
   9
  10 DESCRIPTION
  11 ===========
  12
  13 The config file is JSON_ with the following fields:
  14
  15 meta
  16   An object with page-wide information
  17
  18   title
  19     Page title used in the default header.
  20
  21   blurb
  22     Introduction paragraph used in the default header.
  23
  24   header
  25     `Python format string`_ for the HTML header.  Optional.  It is
  26     formatted with the following context:
  27
  28     date
  29       The current UTC date.
  30
  31     datetime
  32       The current UTC date-time.
  33
  34     title
  35       The **meta.title** value.
  36
  37     blurb
  38       The **meta.blurb** value.
  39
  40     encoding
  41       The encoding used for the output file.
  42
  43     inter_message_padding
  44       0.25em, for consistent CSS generation.
  45
  46     border_radius
  47       0.5em, for consistent CSS generation.
  48
  49   footer
  50     `Python format string`_ for the HTML footer.  It is formatted with
  51     the same context used for **meta.header**.  Optional.
  52
  53   message-url
  54     `Python format string`_ for message-linking URLs.  Optional.
  55     Defaults to linking Gmane_.  It is formatted with the following
  56     context:
  57
  58     message-id
  59       The quoted_ message ID.
  60
  61     subject
  62       The message subject.
  63
  64 views
  65   An array of view objects, where each object has the following
  66   fields:
  67
  68   title
  69     Header text for the view.
  70
  71   comment
  72     Paragraph describing the view in more detail.  Optional.
  73
  74   id
  75     Anchor string for the view.  Optional, defaulting to a slugged
  76     form of the view title
  77
  78   query
  79     An array of strings, which will be joined with 'and' to form the
  80     view query.
  81
  82 .. _Gmane: http://gmane.org/
  83 .. _JSON: http://json.org/
  84 .. _Python format string: https://docs.python.org/3/library/string.html#formatstrings
  85 .. _quoted: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote
  86
  87 EXAMPLE
  88 =======
  89
  90 ::
  91
  92   {
  93     "meta": {
  94       "title": "Notmuch Patches",
  95       "blurb": "For more information see <a href=\"https://notmuchmail.org/nmbug\">nmbug</a>",
  96       "header": "<html><head></head><body><h1>{title}</h1><p>{blurb}</p><h2>Views</h2>",
  97       "footer": "<hr><p>Generated: {datetime}</p></html>",
  98       "message-url": "http://mid.gmane.org/{message-id}"
  99     },
 100     "views": [
 101       {
 102         "title": "Bugs",
 103         "comment": "Unresolved bugs.",
 104         "query": [
 105           "tag:notmuch::bug",
 106           "not tag:notmuch::fixed",
 107           "not tag:notmuch::wontfix"
 108         ]
 109       },
 110       {
 111         "title": "Review",
 112         "comment": "These patches are under review, or waiting for feedback.",
 113         "id": "under-review",
 114         "query": [
 115           "tag:notmuch::patch",
 116           "not tag:notmuch::pushed",
 117           "not tag:notmuch::obsolete",
 118           "not tag:notmuch::stale",
 119           "not tag:notmuch::wontfix",
 120           "(tag:notmuch::moreinfo or tag:notmuch::needs-review)"
 121         ]
 122       }
 123     ]
 124   }
 125
 126 SEE ALSO
 127 ========
 128
 129 **notmuch(1)**, **notmuch-report(1)**, **notmuch-search(1)**, **notmuch-tag(1)**