doc/plugins/contrib/opengraph.mdwn

   1 [[!toc]]
   2
   3 ---
   4
   5 # NAME
   6
   7 IkiWiki::Plugin::opengraph - Adds Open Graph tags on the html head
   8
   9 ---
  10
  11 # DESCRIPTION
  12
  13 This plugin implements the Open Graph tags in the head of the hmtl for all pages, provided you configure it properly and add it to the current template.
  14 For more information on what is Open Graph, visit [[!wikipedia Open_Graph]].
  15 To test your site against the Open Graph rules, use the tool available on <https://developers.facebook.com/tools/debug/og/object/>.
  16
  17
  18 > **WARNING: Open Graph is modern spyware. You should use this if and only if you don't mind making the readers of your wiki/blog being tracked by evil corporations without their consent. By using this plugin you are being mean to the people who are reading your content. You have been warned.**
  19
  20 ---
  21
  22 # INSTALLATION
  23
  24 Put [opengraph.pm](https://notabug.org/hiatobr/ikiwiki-plugin-opengraph/raw/master/opengraph.pm) in *${HOME}/.ikiwiki/IkiWiki/Plugin/* or elsewhere in
  25 your *@INC* path. Or read [[/plugins/install]].
  26
  27 ---
  28
  29 # CONFIGURATION
  30
  31 Add to the configuration in your [[blog.setup|/setup#index5h2]] file.
  32
  33     ## Open Graph plugin
  34     # For more information, see
  35     # <https://en.wikipedia.org/wiki/Open_Graph#Open_Graph_protocol>.
  36     # Default values for <http://ikiwiki.info>
  37     # obtained from <https://developers.facebook.com/tools/debug/og/object/>
  38     # meta property="og:title"
  39     opengraph_title: "ikiwiki"
  40     # meta property="og:type"
  41     opengraph_type: "website"
  42     # meta property="og:url"
  43     opengraph_url: "http://ikiwiki.info/"
  44     # meta property="og:image"
  45     opengraph_image: "http://ikiwiki.info/logo/ikiwiki.png"
  46     # meta property="og:description"
  47     opengraph_description: "Ikiwiki is a wiki compiler."
  48
  49 Add *opengraph* to the list of plugins:
  50
  51     add_plugins => [qw{goodstuff opengraph}]
  52
  53 ---
  54
  55 # TEMPLATES
  56
  57 You will need to add the following code to [[page.tmpl|/templates]] on the current
  58 [[template|/templates]]. It **must** be in the <head> section of the <html>. I recommend
  59 puting it after the <title> tag.
  60
  61     <TMPL_IF OPENGRAPH>
  62     <TMPL_VAR OPENGRAPH_TAGS>
  63     </TMPL_IF>
  64
  65 ---
  66
  67 # BUGS AND LIMITATIONS
  68
  69 ...that's not a bug. It's an issue. Issues shall be reported [here](https://notabug.org/hiatobr/ikiwiki-plugin-opengraph/issues)
  70
  71 ---
  72
  73 # LICENSE AND COPYRIGHT
  74
  75 Copyleft (.) 2015 Hacklab Independência
  76
  77 This program is free software: you can redistribute it and/or modify
  78 it under the terms of the GNU General Public License as published by
  79 the Free Software Foundation, either version 3 of the License, or
  80 (at your option) any later version.
  81
  82 This program is distributed in the hope that it will be useful,
  83 but WITHOUT ANY WARRANTY; without even the implied warranty of
  84 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  85 GNU General Public License for more details.
  86
  87 You should have received a copy of the GNU General Public License
  88 along with this program. If not, see <http://www.gnu.org/licenses/>.
  89
  90 ---
  91
  92 # SEE ALSO
  93
  94 [[index]]
  95
  96 [[!wikipedia Open_Graph]]
  97
  98 [[plugins/contrib/opengraph]]