]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - doc-src/badge
Merge branch '0.9.x' into 1.0.x
[quix0rs-gnu-social.git] / doc-src / badge
1 <!-- Copyright 2008-2010 StatusNet Inc. and contributors. -->
2 <!-- Document licensed under Creative Commons Attribution 3.0 Unported. See -->
3 <!-- http://creativecommons.org/licenses/by/3.0/ for details. -->
4
5 Install the %%site.name%% badge on your blog or web site to show the latest updates 
6 from you and your friends!
7
8 <MTMarkdownOptions output='raw'>
9 <script type="text/javascript" src="http://identi.ca/js/identica-badge.js">
10 {
11    "user":"kentbrew",
12    "server":"identi.ca",
13    "headerText":" and friends"
14 }
15 </script>
16 </MTMarkdownOptions>
17
18 Things to try
19 --------------
20
21 * Click an avatar and the badge will refresh with that user's timeline
22 * Click a nickname to open a user's profile in your browser
23 * Click a notice's timestamp to view the notice in your browser
24 * @-replies and #tags are live links
25
26 ## Installation instructions 
27
28 Copy and paste the following JavaScript into an HTML page where
29 you want the badge to show up.  Substitute your own ID in the user
30 parameter.
31
32 <pre>
33         &lt;script type=&quot;text/javascript&quot; src=&quot;http://identi.ca/js/identica-badge.js&quot;&gt;
34         {
35            &quot;user&quot;:&quot;kentbrew&quot;,
36            &quot;server&quot;:&quot;identi.ca&quot;,
37            &quot;headerText&quot;:&quot; and friends&quot;
38         }
39         &lt;/script&gt;
40
41 </pre>
42
43
44
45 Valid parameters for the badge:
46 -------------------------------
47
48 * user : defaults to 7000 (@kentbrew)
49 * headerText  : defaults to empty
50 * height : defaults to 350px
51 * width : defaults to 300px
52 * background : defaults to #193441. If you set evenBackground, oddBackground,
53   and headerBackground, you won't see it at all.
54 * border : defaults to 1px solid black
55 * userColor : defaults to whatever link color is set to on your page
56 * headerBackground : defaults to transparent 
57 * headerColor :  defaults to white
58 * evenBackground : defaults to #fff
59 * oddBackground : defaults to #eee
60 * thumbnailBorder : 1px solid black
61 * thumbnailSize : defaults to 24px
62 * padding : defaults to 3px
63 * server : defaults to identi.ca
64
65 Licence
66 -------
67
68 Identi.ca badge by [Kent Brewster](http://kentbrewster.com/identica-badge/). 
69 Licenced under [CC-BY-SA-3](http://kentbrewster.com/rights-and-permissions/).