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