Differences

This shows you the differences between two versions of the page.

Link to this comparison view

about:craftopedia:plugins:identicon [2009/04/05 17:02] (current)
magisterludi created
Line 1: Line 1:
 +====== Identicon Plugin ======
 +
 +The k2g2 **identicon plugin** is an improved version of the original dokuwiki [[doku>plugin:avatar|avatar plugin]].
 +
 +===== Introduction =====
 +
 +An [[wiki:identicon]] is a little icon used to identify the contributions of an individual user across websites, blogs and wikis.
 +
 +===== Default Identicon Service =====
 +==== Description ====
 +The default  identicon service can be selected in the configuration manager. When using the general purpose //identicon// tag you can always switch to a different identicon service later. But if you want to display an identicon using a specific service, independently of the config settings, you should use the service specific syntax given in the sections below.
 +
 +==== Examples ====
 +=== Different identicons ===
 +It should be easy to tell different identicons apart:\\
 +{{identicon>foo}} {{identicon>bar}} {{identicon>foobar}}
 +
 +=== Different sizes ===
 +From left to right: s, m, l and xl.\\
 +{{identicon>foo?s}} {{identicon>foo?m}} {{identicon>foo?l}}{{identicon>foo?xl}}
 +
 +=== Different styles ===
 +Some identicon services provide different rendering styles:
 +== first style ==
 +{{identicon>foo?1}} 
 +
 +== second style ==
 +{{identicon>foo?2}}
 +
 +==== Syntax ====
 +  {{identicon>[user|mail]?[size,style]|[title]}}
 +
 +^ [user]  | the registered user for which you want to display an avatar | required |
 +^ [mail]  | the e-mail address for which you want to display an avatar image | required |
 +^ [size]  | either s(mall) = 20×20 pixel, m(edium) = 40×40 pixel, l(arge) = 80×80 pixel, xl (extra large) = 120×120 pixel | optional;\\ default is medium |
 +^ [style]  | an integer number designating the style to use. if the number is larger than the number of styles available, the modulo operator is applied.| optional;\\ default is 1 |
 +^ [title]  | the name of the person the mail address belongs to or some other title text | optional; default is the obfuscated e-mail address |
 +
 +By padding the e-mail address with spaces you can define the alignment like with [[:syntax#images_and_other_files|images]].
 +
 +===== Specific Identicon Services =====
 +
 +While the original avatar plugin was based on MonsterID, the k2g2 identicon plugin supports a number of additional identicon generators.
 +
 +Please note that the individual plugin components are distributed under different licenses. Read the license carefully, before using them on your wiki.
 +
 +===== Avatar Services =====
 +Currently Gravatar is the only supported global avatar service. But it's also possible to host avatar icons on your own site.
 +
 +==== Gravatar ====
 +=== Description ===
 +The user must have an account at http://gravatar.com.
 +=== Example ===
 +{{gravatar>foo}}
 +=== Syntax === 
 +  {{gravatar>[user|mail]?[size]|[title]}}
 +
 +==== Local Avatars ====
 +=== Description ===
 +If you want users to host their avatar images on your wiki, rather than on Gravatar, you can upload your own avatars into the ''user'' namespace. 
 +=== Syntax ===
 +For a user named ''foo'' this would be an image ''user:foo.jpg'' for example and the syntax:
 +
 +  {{avatar>foo?[size]|[title]}}
 +
 +The username has to be lowercase and follow the pagename naming rules. If unsure, you get your username for example the recent changes log etc.. Supported image types are jpg/png/gif.
 +
 +===== Local Identicon Services =====
 +
 +==== Monster ID ====
 +=== Description ===
 +MonsterID is a compositional identicon generator, inspired by a post from Don Park and the //Combinatoric Critters//. All graphics were created by Andreas Gohr. 
 +
 +You can easily adapt the monster components provided by MonsterID generator yourself. A different set of monster templates is provided by the Bowaz. 
 +
 +The //style// parameter can be used to switch between several template sets. 
 +=== Examples ===
 +==MonsterID==
 +{{monsterid>foo?1}} {{monsterid>bar?1}} {{monsterid>foobar?1}}
 +==Bohwaz==
 +{{monsterid>foo?2}} {{monsterid>bar?2}} {{monsterid>foobar?2}}
 +=== Syntax ===
 +  {{monsterid>[user|mail]?[size,style]|[title]}}
 +=== License ===
 +The source code and the graphics are provided under the Creative Commons Attribution 2.5 License. If you use this software and/or graphics please link back to http://www.splitbrain.org/go/monsterid
 +
 +==== Visiglyph ====
 +=== Description ===
 +A visiglyph is an identicon frequently used in blogs.
 +=== Examples ===
 +{{visiglyph>foo}} {{visiglyph>bar}} {{visiglyph>foobar}}
 +=== Syntax ===
 +  {{visiglyph>[user|mail]?[size]|[title]}}
 +=== License ===
 +Special license - see source code.
 +
 +==== Identifrac ====
 +=== Description ===
 +Identifrac creates a unique fractal for each user. The user ID serves as seed for the fractal and to determine the colour scheme.
 +=== Examples ===
 +== transparent style ==
 +{{identifrac>foo?1}} {{identifrac>bar?1}} {{identifrac>foobar?1}}
 +== dark style ==
 +{{identifrac>foo?2}} {{identifrac>bar?2}} {{identifrac>foobar?2}}
 +=== Syntax ===
 +  {{identifrac>[user|mail]?[size,style]|[title]}}
 +=== License ===
 +GPL.
 +
 +==== Stitchy ====
 +=== Description ===
 +The stitchy was inspired by traditional cross stitch patterns, i.e. black and red emboridery on white linen.  Stitchy patterns are generated from a seed number using the  modulo operator to extract bits of information as needed.
 +
 +A simple heraldics-rule ensures the characteristic look and feel common to all stitchies. (black and red may not touch) 
 +The beauty and simplicity of the stitchies is due to their high degree of symmetry. Each stitchy is based on a unique right-angled triangle, that is transformed into a square using a triple symmetry operation.
 +The stitchy algorithm was conceived by Martin Schneider.
 +=== Examples ===
 +{{stitchy>foo}} {{stitchy>bar}} {{stitchy>foobar}}
 +=== Syntax ===
 +  {{stitchy>[user|mail]?[size]|[title]}}
 +=== License ===
 +GPL.
 +
 +===== Related Plugins =====
 +  * [[doku>plugin:avatar|Original avatar plugin]]
 +
  
about/craftopedia/plugins/identicon.txt · Last modified: 2009/04/05 17:02 by magisterludi
Creative Commons License Knitting Knerds Geek Girls Stitching Bitches Purling Pimps Driven by DokuWiki