doc/ikiwiki-comment.mdwn

   1 # NAME
   2
   3 ikiwiki-comment - posts a comment
   4
   5 # SYNOPSIS
   6
   7 ikiwiki-comment page.mdwn
   8
   9 # DESCRIPTION
  10
  11 `ikiwiki-comment` creates a comment for the specified wiki page file,
  12 and opens your editor to edit it.
  13
  14 Once you're done, it's up to you to add the comment to whatever version
  15 control system is being used by the wiki, and do any necessary pushing to
  16 publish it.
  17
  18 Note that since ikiwiki-comment is not passed the configuration of
  19 the wiki it's acting on, it doesn't know what types of markup are
  20 available. Instead, it always removes one level of extensions from the
  21 file, so when run on a page.mdwn file, it puts the comment in page/
  22
  23 The username field is set to the unix account name you're using.
  24 You may want to edit it to match the username you use elsewhere
  25 on the wiki.
  26
  27 # AUTHOR
  28
  29 Joey Hess <joey@ikiwiki.info>
  30
  31 Warning: this page is automatically made into ikiwiki-comments's man page, edit with care