Print this page
    
    
      
        | Split | 
	Close | 
      
      | Expand all | 
      | Collapse all | 
    
    
          --- old/docs/lisp-metadata.txt
          +++ new/docs/lisp-metadata.txt
   1    1  Lisp-formated Post and Comment Metadata
   2    2  =======================================
   3    3  
   4    4  We use a Lisp-type syntax to keep track of all the metadata.  For more
   5    5  information about the exact syntax, look at lisp.txt in the docs directory.
   6    6  
   7    7  
   8    8  Post
   9    9  ----
  10   10  
  11   11  Posts' metadata is stored alongside the post text in a file called
  12   12  "post.lisp".  The contents are a Lisp alist.  For example:
  13   13  
  14   14  ((time . "2015-09-19 21:28")
  15   15   (title . "abcdef")
  16   16   (fmt . 3)
  17   17   (tags "tag1" "tag2")
  18   18   (comments 1 2 3)
  19   19   (listed #t))
  20   20  
  21   21  
  22   22  Most entries are self explanatory.  With that said,
  23   23  
  
    | 
      ↓ open down ↓ | 
    23 lines elided | 
    
      ↑ open up ↑ | 
  
  24   24   time: the time of publication (UTC)
  25   25  
  26   26   title: the title of this post
  27   27  
  28   28   fmt: format version for the post text itself
  29   29  
  30   30     The supported formats are:
  31   31  
  32   32       2: raw HTML
  33   33       3: pseudo-LaTeX
       34 +     4: Markdown (MD)
  34   35  
  35   36   tags: list of tags associated with this post
  36   37  
  37   38   comments: entry enumerates all the comment IDs for this post
  38   39  
  39   40   listed: list this post on the index/tag/archive pages?
  40   41  
  41   42  
  42   43  Comment
  43   44  -------
  44   45  
  45   46  Comments store their metadata alongside the comment text in a file called
  46   47  "meta.lisp".  The contents are a Lisp alist.  For example:
  47   48  
  48   49  ((author . "bob")
  49   50   (email . "bob@example.com")
  50   51   (time . "2015-09-19 21:30")
  51   52   (ip . "10.10.10.10")
  52   53   (url . "http://example.com")
  53   54   (moderated . #t))
  54   55  
  55   56  
  56   57  Again, the entries are self explanatory.
  57   58  
  58   59   author: the author of the comment
  59   60  
  60   61   email: the email address of the comment author
  61   62  
  62   63   time: time of comment (UTC)
  63   64  
  64   65   ip: the IP address used by the comment author to leave the comment
  65   66  
  66   67   url: the comment author's website
  67   68  
  68   69   moderated: has this post been moderated?
  
    | 
      ↓ open down ↓ | 
    25 lines elided | 
    
      ↑ open up ↑ | 
  
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX