diff options
Diffstat (limited to 'doc-src')
| -rw-r--r-- | doc-src/about | 10 | ||||
| -rw-r--r-- | doc-src/badge | 65 | ||||
| -rw-r--r-- | doc-src/contact | 24 | ||||
| -rw-r--r-- | doc-src/faq | 42 | ||||
| -rw-r--r-- | doc-src/groups | 42 | ||||
| -rw-r--r-- | doc-src/help | 32 | ||||
| -rw-r--r-- | doc-src/im | 35 | ||||
| -rw-r--r-- | doc-src/openid | 11 | ||||
| -rw-r--r-- | doc-src/openmublog | 25 | ||||
| -rw-r--r-- | doc-src/privacy | 45 | ||||
| -rw-r--r-- | doc-src/sms | 68 | ||||
| -rw-r--r-- | doc-src/source | 12 | ||||
| -rw-r--r-- | doc-src/tags | 40 |
13 files changed, 451 insertions, 0 deletions
diff --git a/doc-src/about b/doc-src/about new file mode 100644 index 000000000..3036a51b9 --- /dev/null +++ b/doc-src/about @@ -0,0 +1,10 @@ +%%site.name%% is a +[micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service +based on the Free Software [Laconica](http://laconi.ca/) tool. + +If you [register](%%action.register%%) for an account, +you can post small (140 chars or less) text notices +about yourself, where you are, what you're doing, or practically +anything you want. You can also subscribe to the notices of your +friends, or other people you're interested in, and follow them on the +Web or in an [RSS](http://en.wikipedia.org/wiki/RSS) feed. diff --git a/doc-src/badge b/doc-src/badge new file mode 100644 index 000000000..1c368eb69 --- /dev/null +++ b/doc-src/badge @@ -0,0 +1,65 @@ +Install the %%site.name%% badge on you blog or web site to show the latest updates +from you and your friends! + +<MTMarkdownOptions output='raw'> +<script type="text/javascript" src="http://identi.ca/js/identica-badge.js"> +{ + "user":"kentbrew", + "server":"identi.ca", + "headerText":" and friends" +} +</script> +</MTMarkdownOptions> + +Things to try +-------------- + +* Click an avatar and the badge will refresh with that user's timeline +* Click a nickname to open a user's profile in your browser +* Click a notice's timestamp to view the notice in your browser +* @-replies and #tags are live links + +## Installation instructions + +Copy and paste the following JavaScript into an HTML page where +you want the badge to show up. Substitute your own ID in the user +parameter. + +<pre> + <script type="text/javascript" src="http://identi.ca/js/identica-badge.js"> + { + "user":"kentbrew", + "server":"identi.ca", + "headerText":" and friends" + } + </script> + +</pre> + + + +Valid parameters for the badge: +------------------------------- + +* user : defaults to 7000 (@kentbrew) +* headerText : defaults to empty +* height : defaults to 350px +* width : defaults to 300px +* background : defaults to #193441. If you set evenBackground, oddBackground, + and headerBackground, you won't see it at all. +* border : defaults to 1px solid black +* userColor : defaults to whatever link color is set to on your page +* headerBackground : defaults to transparent +* headerColor : defaults to white +* evenBackground : defaults to #fff +* oddBackground : defaults to #eee +* thumbnailBorder : 1px solid black +* thumbnailSize : defaults to 24px +* padding : defaults to 3px +* server : defaults to identi.ca + +Licence +------- + +Identi.ca badge by [Kent Brewster](http://kentbrewster.com/identica-badge/). +Licenced under [CC-BY-SA-3](http://kentbrewster.com/rights-and-permissions/). diff --git a/doc-src/contact b/doc-src/contact new file mode 100644 index 000000000..a8efc456a --- /dev/null +++ b/doc-src/contact @@ -0,0 +1,24 @@ +There are a number of options for getting in contact with responsible +people for %%site.name%%. + +Post a notice +------------- + +If you have a question about how to do something, just post a notice +with your question. People here like to answer messages. Watch the +[public timeline](%%action.public%%) for answers; they'll usually start +with "@" plus your user name. + +Bugs +---- + +If you think you've found a bug in the [Laconica](http://laconi.ca/) software, +or if there's a new feature you'd like to see, add it into the [Laconica bug database](http://laconi.ca/PITS/HomePage). Don't forget to check the list of +existing bugs to make sure it hasn't already been reported! + +Email +----- + +You can reach the responsible party for this server at [%%site.email%%](mailto:%%site.email%%). + + diff --git a/doc-src/faq b/doc-src/faq new file mode 100644 index 000000000..31582b9f0 --- /dev/null +++ b/doc-src/faq @@ -0,0 +1,42 @@ +These are some *Frequently Asked Questions* about this service, with +some answers. + +What is %%site.name%%? +---------------------- + +%%site.name%% is a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service. +You can use it to write short notices about yourself, where you are, +and what you're doing, and those notices will be sent to all your friends +and fans. + +How is %%site.name%% different from Twitter, Jaiku, Pownce, Plurk, others? +-------------------------------------------------------------------------- + +%%site.name%% is an [Open Network Service](http://opendefinition.org/ossd). Our main +goal is to provide a fair and transparent service that preserves users' autonomy. In +particular, all the software used for %%site.name%% is [Free Software](http://en.wikipedia.org/wiki/Free_Software), and all the data is available +under the [%%license.title%%](%%license.url%%) license, making it Open Data. + +The software also implements the [OpenMicroBlogging](http://openmicroblogging.org/) protocol, meaning that you can have friends on other microblogging services +that can receive your notices. + +The goal here is *autonomy* -- you deserve the right to manage your own on-line +presence. If you don't like how %%site.name%% works, you can take your data and the source code and set up your own server (or move your account to another one). + +Where is feature X? +------------------- + +The software we run, [Laconica](http://laconi.ca/), is still in its early stages, +and many features people expect from microblogging sites are not yet implemented. Some important ones that are expected "soon": + +* More [AJAX](http://en.wikipedia.org/wiki/AJAX)-y interface +* Maps +* Cross-post to Pownce, Jaiku, etc. +* Pull messages from Twitter, Pownce, Jaiku, etc. +* [Facebook](http://www.facebook.com/) integration +* Image, video, audio notices + +There is [a list of bugs and features](http://laconi.ca/trac/) that you may find +interesting. New ideas or complaints are very welcome. + + diff --git a/doc-src/groups b/doc-src/groups new file mode 100644 index 000000000..645390e0c --- /dev/null +++ b/doc-src/groups @@ -0,0 +1,42 @@ +Users on %%site.name%% can create *groups* that other users can join. +Groups can be a great way to share information and entertainment with +a group of people who have a common interest or background. + +You can find out about groups on the server on the +[Groups](%%action.groups%%) page. You can join a group by clicking on +the "Join" button either in the group list or on the group's home page. + +Starting a new group +-------------------- + +If you want, you can start a new group for friends and people with +common interests. Note that all groups are free for anyone to join. + +To start a new group, use the [new group](%%action.newgroup%%) tool +and fill out the form. Describe your group as best you can if you want +people to be able to find it. + +When choosing the nickname for your group, try to keep it short. The +nickname is included in every message to and from the group, so the +less chars the better. Try using acronyms for organizations, or +airport codes for places (like 'pdx' instead of 'portland'). + +Sending messages to a group +--------------------------- + +You can send a message to a group using the syntax "!groupname" +anywhere in the message. If you have more than one group named, the +notice will go to each group. Only members can send notices to a +group, and groups do not respond to direct messages (DMs). + +Receiving messages +------------------ + +New group messages will appear in your inbox, and will also come to +your phone or IM client if you've set them up to receive notices. + +Remote groups +------------- + +While it's technically possible, this version of Laconica does not +support remote group membership. diff --git a/doc-src/help b/doc-src/help new file mode 100644 index 000000000..a8cfccd2b --- /dev/null +++ b/doc-src/help @@ -0,0 +1,32 @@ +%%site.name%% is a **microblogging service**. Users post short (140 +character) notices which are broadcast to their friends and fans using +the Web, RSS, or instant messages. + +If you'd like to try it out, first [register](%%action.register%%) a new account. +Then, on the [public timeline](%%action.public%%), enter your message into +the textbox at the top of the page, and click "Send". It will go out on the +public timeline and to anyone who is subscribed to your notices (probably nobody, +at first). + +To subscribe to other people's notifications, go to their profile page +and click the "subscribe" button. They'll get a notice that you're now +subscribed to their notifications, and, who knows?, they might subscribe +back. + +More help +--------- + +Here are some documents that you might find helpful in understanding +%%site.name%% and how to use it. + +* [About](%%doc.about%%) - an overview of the service +* [FAQ](%%doc.faq%%) - frequently-asked questions about %%site.name%% +* [Contact](%%doc.contact%%) - who to contact with questions about the service +* [IM](%%doc.im%%) - using the instant-message (IM) features of %%site.name%% +* [SMS](%%doc.sms%%) - tying your cellphone to %%site.name%% +* [tags](%%doc.tags%%) - different ways to use tagging +* [Groups](%%doc.groups%%) - joining together in groups +* [OpenID](%%doc.openid%%) - what OpenID is and how to use it with this service +* [OpenMicroBlogging](%%doc.openmublog%%) - subscribing to remote users +* [Privacy](%%doc.privacy%%) - %%site.name%%'s privacy policy +* [Source](%%doc.source%%) - How to get the Laconica source code diff --git a/doc-src/im b/doc-src/im new file mode 100644 index 000000000..da07f9fe7 --- /dev/null +++ b/doc-src/im @@ -0,0 +1,35 @@ +You can post messages to %%site.name%% using a [Jabber](http://jabber.org/) client +on your computer, mobile phone, or other platform. ([GTalk](http://talk.google.com/), +Google's Jabber program, will also work.) This can be a convenient way to keep +up with your friends on %%site.name%%. + +If you don't already have a Jabber account, you can use GTalk or one of the other +[public Jabber services](http://www.jabber.org/im-services). You'll probably also +need an IM client like [Pidgin](http://www.pidgin.im/). + +Managing your IM settings +------------------------- + +Use the [IM settings](%%action.imsettings%%) page to set your IM preferences. You can add or change your Jabber address and set the flags for Jabber update. + +When you add or change your address, you'll receive a message from **%%xmpp.user%%@%%xmpp.server%%** asking you to confirm the change. (You may need to +add %%xmpp.user%%@%%xmpp.server%% to your buddy list *before* changing your IM +settings; this is definitely true for GTalk.) + +Sending updates +--------------- + +You send updates by sending messages to %%xmpp.user%%@%%xmpp.server%%. Messages +should be less than 140 characters; longer messages will be truncated. + +Commands +-------- + +You can do some minor management of your account through Jabber. These are the +currently-implemented commands: + +* **on**: Turn on notifications. You'll receive copies of messages by people + you subscribe to. +* **off**: Turn off notifications. You'll no longer receive Jabber + notifications. + diff --git a/doc-src/openid b/doc-src/openid new file mode 100644 index 000000000..c741e3674 --- /dev/null +++ b/doc-src/openid @@ -0,0 +1,11 @@ +%%site.name%% supports the [OpenID](http://openid.net/) standard for single signon between Web sites. OpenID lets you log into many different Web sites without using a different password for each. (See [Wikipedia's OpenID article](http://en.wikipedia.org/wiki/OpenID) for more information.) + +If you already have an account on %%site.name%%, you can [login](%%action.login%%) with your username and password as usual. +To use OpenID in the future, you can [add an OpenID to your account](%%action.openidsettings%%) after you have logged in normally. + +There are many [Public OpenID providers](http://wiki.openid.net/Public_OpenID_providers), and you may already have an OpenID-enabled account on another service. + +* On wikis: If you have an account on an OpenID-enabled wiki, like [Wikitravel](http://wikitravel.org/), [wikiHow](http://www.wikihow.com/), [Vinismo](http://vinismo.com/), [AboutUs](http://aboutus.org/) or [Keiki](http://kei.ki/), you can log in to %%site.name%% by entering the **full URL** of your user page on that other wiki in the box above. For example, *http://kei.ki/en/User:Evan*. +* [Yahoo!](http://openid.yahoo.com/) : If you have an account with Yahoo!, you can log in to this site by entering your Yahoo!-provided OpenID in the box above. Yahoo! OpenID URLs have the form *https://me.yahoo.com/yourusername*. +* [AOL](http://dev.aol.com/aol-and-63-million-openids) : If you have an account with [AOL](http://www.aol.com/), like an [AIM](http://www.aim.com/) account, you can log in to %%site.name%% by entering your AOL-provided OpenID in the box above. AOL OpenID URLs have the form *http://openid.aol.com/yourusername*. Your username should be all lowercase, no spaces. +* [Blogger](http://bloggerindraft.blogspot.com/2008/01/new-feature-blogger-as-openid-provider.html), [Wordpress.com](http://faq.wordpress.com/2007/03/06/what-is-openid/), [LiveJournal](http://www.livejournal.com/openid/about.bml), [Vox](http://bradfitz.vox.com/library/post/openid-for-vox.html) : If you have a blog on any of these services, enter your blog URL in the box above. For example, *http://yourusername.blogspot.com/*, *http://yourusername.wordpress.com/*, *http://yourusername.livejournal.com/*, or *http://yourusername.vox.com/*. diff --git a/doc-src/openmublog b/doc-src/openmublog new file mode 100644 index 000000000..6e3abee42 --- /dev/null +++ b/doc-src/openmublog @@ -0,0 +1,25 @@ +[OpenMicroBlogging](http://openmicroblogging.org/) is a protocol that +lets users of one [microblogging](http://en.wikipedia.org/wiki/microblogging) service +subscribe to notices by users of another service. The protocol, based on +[OAuth](http://oauth.net/), is open and free, and doesn't depend on any +central authority to maintain the federated microblogs. + +The [Laconica](http://laconi.ca/) software that runs %%site.name%% supports +OpenMicroBlogging 0.1. Anyone can make a new installation of Laconica on their +own servers, and users of that new installation can subscribe to notices from +%%site.name%%. + +Remote subscription +------------------- + +If you have an account on a remote site that supports OpenMicroBlogging, and you +want to subscribe to the notices of a user on this site, click on the "Subscribe" +link under their avatar on their profile page. This should take you to the +[remote subscription](%%action.remotesubscribe%%) page. Make sure that you've got the +right nickname registered, and enter your profile URL on the other microblogging +service. + +You'll be taken to your microblogging service, where you'll be asked to confirm the +subscription. When you confirm, your service will receive new notifications from +the user on %%site.name%%, and your service will forward them to you (using IM, SMS, +the Web, or whatever else). diff --git a/doc-src/privacy b/doc-src/privacy new file mode 100644 index 000000000..90c7b3c7f --- /dev/null +++ b/doc-src/privacy @@ -0,0 +1,45 @@ +This document outlines this service's respect for your personal +privacy as a user of the service. + +- Almost all the text and files that users upload to this site is + available under the site license (see the license block at the bottom + of this page). Users agree to the license when they register to use + the site for the first time. Typically that means that the data can + be copied far and wide, for commercial and non-commercial purposes, + and in modified or unmodified form. If you're not OK with that, + don't use the service. +- The following data items are considered *private data* that won't be + shared with other users, business partners, or the public at large: + * your password + * your email address + * your IM address (AIM, Jabber, or other instant messaging address) + * your phone number + * your "private messages" + * your login credentials (username and password) for other services (Twitter, Facebook, etc.) +- Some private data may be published in aggregate, e.g. "30% of our + users are registered with Hotmail addresses." +- Your notices (including files) can be downloaded and re-used by + other services, either one-by-one or in bulk as + [RSS](http://en.wikipedia.org/wiki/RSS) files. +- Your profile information (including subscriptions and avatars) can be + downloaded and re-used by other services, either scraped from the HTML + interface or in bulk as [FOAF](http://en.wikipedia.org/wiki/FOAF) files. +- Your notices will be forwarded to users who subscribe to them, + including users on another microblogging service. +- Your profile information will be sent to microblogging services for + users who subscribe to you or to whom you subscribe. +- Based on your email preferences, you may receive automated email + messages for important system events, such as when others subscribe + to your notices. +- Based on your email preferences, you may receive an email + newsletter. You can opt out of the newsletter if you don't want to + receive it. +- In urgent situations, administrators may send you email directly to + your registered email address, even if you've requested no notices + or newsletter. *Administrators will use digitally-signed email.* +- This service will comply with court orders to turn over your private + information. + + + + diff --git a/doc-src/sms b/doc-src/sms new file mode 100644 index 000000000..1beb49786 --- /dev/null +++ b/doc-src/sms @@ -0,0 +1,68 @@ +You can post messages to %%site.name%% using a many kinds of cell +phones that support SMS messaging. This site does not support SMS +directly; rather, it uses your carrier's email gateway to send and +receive messages. + +Managing your SMS settings +-------------------------- + +Use the [SMS settings](%%action.smssettings%%) page to set your SMS +preferences. You can add or change your SMS number and set the +flags for SMS updates. + +When you add or change your phone number, you'll receive a message on your +phone with a verification code. Enter it into the SMS settings page to +confirm that the owner of the phone authorizes sending it messages. + +Note that only the carriers listed in the drop down list on the form +are supported by %%site.name%%. They're the only ones we know how to +make email addresses for. + +Receiving messages +------------------ + +Once you've verified your phone number, you can enable sending +messages to your phone. If you have a lot of friends and a typical +phone, it can be hard to keep up. + +Sending messages +---------------- + +To send a message, you must send an email to the incoming email +address visible on your SMS settings page. The method for sending +email from your phone varies from carrier to carrier and from handset +to handet; if in doubt, ask your carrier. + +Keep your incoming email address a secret -- it's the only way we know +you're really you! + +Commands +-------- + +You can use the following commands with %%site.name%%. + +* on - turn on notifications +* off - turn off notifications +* help - show this help +* follow <nickname> - subscribe to user +* leave <nickname> - unsubscribe from user +* d <nickname> <text> - direct message to user +* get <nickname> - get last notice from user +* whois <nickname> - get profile info on user +* fav <nickname> - add user's last notice as a 'fave' +* stats - get your stats +* stop - same as 'off' +* quit - same as 'off' +* sub <nickname> - same as 'follow' +* unsub <nickname> - same as 'leave' +* last <nickname> - same as 'get' +* on <nickname> - not yet implemented. +* off <nickname> - not yet implemented. +* nudge <nickname> - not yet implemented. +* invite <phone number> - not yet implemented. +* track <word> - not yet implemented. +* untrack <word> - not yet implemented. +* track off - not yet implemented. +* untrack all - not yet implemented. +* tracks - not yet implemented. +* tracking - not yet implemented. diff --git a/doc-src/source b/doc-src/source new file mode 100644 index 000000000..83debbe53 --- /dev/null +++ b/doc-src/source @@ -0,0 +1,12 @@ +This service uses a Free microblogging tool called **Laconica**. +Laconica is available under the [GNU Affero General Public License +Version 3.0](http://www.fsf.org/licensing/licenses/agpl-3.0.html), a +Free Software license for network services. + +You can get a copy of the software from the +[Laconica](http://laconi.ca/) main site. The version of the software +that runs on *this* site is unmodified from that version. The site +also depends on certain libraries and other software; you can get +those at the Laconica site, too. + + diff --git a/doc-src/tags b/doc-src/tags new file mode 100644 index 000000000..2ed352e70 --- /dev/null +++ b/doc-src/tags @@ -0,0 +1,40 @@ +%%site.name%% supports +[tags](http://en.wikipedia.org/wiki/Tag_(metadata)) to help you +organize your activities here. You can use tags for people and for +notices. + +Tagging a notice +---------------- + +You can tag a notice using a *hashtag*; a # character followed by +letters and numbers as well as '.', '-', and '_'. Note that accented +latin characters are not supported, and non-roman scripts are right out. + +The HTML for the notice will link to a stream of all the other notices +with that tag. This can be a great way to keep track of a conversation. + +The most popular current tags on the site can be found in the [public +tag cloud](%%action.publictagcloud%%). Their size shows their +popularity and recency. + +Tagging yourself +---------------- + +You can also add tags for yourself on your [profile +settings](%%action.profilesettings%%) page. Use single words to +describe yourself, your experiences and your interest. The tags will +become links on your profile page to a list of all the users on the +site who use that same tag. It can be a nice way to find people who +are related to you geographically or who have a common interest. + +Tagging your subscriptions +-------------------------- + +You can also tag your subscriptions, on the subscriptions page. This +makes it easy to organize your subscriptions into groups and sort +through them separately. + +You can also send a notice "to the attention of" everyone you've +marked with a particular tag (note: *not* people who've marked +themselves with that tag). "@#family hello" will send a notice to +everyone you've marked with the tag 'family'.
\ No newline at end of file |