doc/plugins/contrib/opengraph.mdwn

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