Documentation

German version

= StatusNet features =

This shall become the foundation of user documentation of the features of a StatusNet driven microblogging site. I know that nobody is reading docs, but some do and these shall benefit abit. Currently I'm brainstorming, just comment on the items in the ideas list below.

intro paragraph

Documentation is also aviable in de, ... (just add your translation here, trac is speaking UTF8)

1. Features 1. How to use StatusNet 1. Details on features 1. How do I delete my account?
 * webinterface
 * XMPP
 * email
 * SMS
 * tags
 * tagging your friends
 * search StatusNet
 * invite people
 * favorites
 * Spam and Blocking other users
 * direct notices
 * Twitter related stuff
 * Twitter bridge

Features
StatusNet, as of version 0.6.0, supports public and direct notices. You can mark notices as your favorite, tag them and have them automatically pushed over to Twitter. You can post your notices with your browser, your favorite XMPP application or one of many other desktop and web applications.

Please see below for details.

'''Also note that maybe not all features of StatusNet are described here. If you find some missing items, add them! '''

Not yet implemented features

 * list of features known from other platforms, that are not jet implemented, but are planed to

I think this should be filled out by some of the devs *g*

How to use StatusNet
To use StatusNet you need an account at any StatusNet based platform. The well known one is identica but there are many others as well (see ListOfServers). StatusNet implements the OpenMicroBlogging protocol, meaning that you can have friends on other microblogging services that can receive your notices.

via the webinterface
Image(identica063.main.jpg)

The web interface is the main interface to the functions of a StatusNet server. When logged in, there are three major parts on the main page: the main menu to the right of the logo, an input box and the public timeline.

The tabs below the input box are new in version 0.6.3, they will bring you to the public timeline, the overview page of the recent used tags, a list of featured users on the StatusNet server and a list of dents that were marked as favorites the most this week.

To send a notice to the server, simply type in the input box and press the Send button. The notice should immediately enter the public timeline below.

via XMPP
To use StatusNet with XMPP (Jabber / Google Talk) just add the XMPP bot of your Statusnet platform to your contacts (at identi.ca this is update[at]identi.ca). Then make sure your settings (IM tab) are set properly.

Sending &quot;help&quot; to the bot will give you an overview what it can do for you. As of version 0.6.0 the commands it understands are: on                   - turn on notifications off                  - turn off notifications help                 - show this help follow    - subscribe to user groups               - lists the groups you have joined subscriptions        - list the people you follow subscribers          - list the people that follow you leave     - unsubscribe from user d   - direct message to user get       - get last notice from user whois     - get profile info on user lose      - force user to stop following you fav       - add user's last notice as a 'fave' fav #     - add notice with the given id as a 'fave' repeat #  - repeat a notice with a given id repeat     - repeat the last notice from user reply #   - reply to notice with a given id reply      - reply to the last notice from user join         - join group login                - Get a link to login to the web interface drop         - leave group stats                - get your stats stop                 - same as 'off' quit                 - same as 'off' sub       - same as 'follow' unsub     - same as 'leave' last      - same as 'get' on        - not yet implemented. off       - not yet implemented. nudge     - remind a user to update. invite - not yet implemented. track         - not yet implemented. untrack       - not yet implemented. track off            - not yet implemented. untrack all          - not yet implemented. tracks               - not yet implemented. tracking             - not yet implemented. The list of commands has grown somewhat, just try &quot;help&quot; to see the all the commands.

To send a notice, just send it to the bot. If you enabled it in the setting, notices from people you're subscribed to will be delivered to your XMPP account.

See also: XMPP Bot and XMPP Setup

via email
To post dents via email you have to create an Incoming email adress in &quot;Settings -&amp;gt; Email&quot;. If you did, you can send emails with the address you entered above in the settings to this address to post notices.

The settings are case sensitive, so Testaddress[at]example.com is not the same as testaddress[at]example.com!

NOTE: Needs improvement. This tells what needs to be done, but not how to do it. More challenged users need more information. (like me)

via SMS
Posting via sms is done in the same way as posting via email. SMS client (your cellphone) receives posts from statusnet; reply-to: address is your Incoming Email made up address. Send a reply from the phone, and it emails Statusnet and posts the dent.

NOTE: Needs improvement. This tells what needs to be done, but not how to do it. More challenged users need more information. (like me)

other applications
There are many other applications with which you can use Statusnet based services (or at least identica). See the Apps wiki page for the complete list.

Details on features
The following section should give some more details of the features that are implemented. They should be labeled with the version number, so that one can see when they when the feature was implemented and if the StatusNet server supports it.

public timeline
The public timeline is the live stream of all notices that are posted. Every notice that is not a direct notice will show up in the public timeline. Everybody can read and answer to it.

the main menu and what's behind the links
The main menu, located at the top of the page consists of six links: Home, Search, Tags, Settings, Invite and Logout.The Home link points to your profile (see below).

tags
Following the Tag link, you'll reach a cloud of the recent tags. The entries in the cloud are linked with a list of all dents, that where taged with that word.

Tags are used to categorize dents. Tags are linked with an overview page, that shows all notices that got marked with the tag.

To set a tag you have to prefix the tag-to-be with a hash (that's the #). Currently (as of StatusNet version 0.6.0) tags may contain ASCII characters (alphanumeric and underscores) UPPER, lower and mixed case, but no UTF8.

Examples
 * valid tags: #thIS #is #a #Valid #TAG #123
 * invalid tags: #€uro #Übertragung

Since version 0.6.3 of StatusNet you now can also tag yourself and your friends.

friendtags (0.6.3)
Since version 0.6.3 of StatusNet you can tag your contacts. To do so go to your profile page and follow one of the links &quot;Subscribers&quot;, &quot;Subscriptions&quot; or &quot;All subscriptions&quot; (below the icons of your contacts). There you'll see all your contacts in a list, with their associatied tag or &quot;(none)&quot;. To change the tags simply follow the Tags link for that contact.

So why tagging your contacts? 1. you can send dents to a group of friends tagged with the same tag with @#thetag 1. if you've a lot of people subscribed, you can shorting the list with displaying only the contacts mathing to a selected tag.

search functions
Here you can search either for people on a StatusNet server, or a piece of text in the public notices. The search item have to have three (3) or more letters. You can search for more than one word at once, separating the search items with a space.

Logical expressions and the order of your search items are ignored.

settings
See DocumentationSettings for informations about the settings of your StatusNet account.

invite
Since version 0.6.0 you can invite friends to StatusNet based platforms. Following the Invite link brings you to a form with two boxes. In the upper one you list the email addresses of the people you wish to invite, one per line, and in the lower you can add a message to be sent along with the default message. If the person accepts the invitation you'll be notified.

Invitation emails consist of a short introduction of the server and who invited you. With links to the profile of the member who send out the invitation and to register at the server.

If you invite somebody that is already active at the StatusNet server, you will automatically be subscribed to that account.

your profile - the tabs and what's behind them
Image(identica063.home.jpg)

If you follow the Home link in the main menu, you'll reach your profile. Currently (version 0.6.0 of StatusNet) it is subdivided into six tabs:

personal
The personal timeline in your profile is the collection of all your notices and the notices of the accounts you are subscribed to.

replies
In the replies tab you'll find answerts to your notices. StatusNet counts every notice that includes a @yourusername as a reply to you. Replies are public as any other notice you write--if you don't wish that, send a direct notice instead.

profile
The profile page shows your personal information that you can alter in the Settings Area. There is also a small area listing statistics of your activities; to whom you are subscribed and who is subscribed to you. The profile tab is also the place where all your notices (except direct notices) are collected.

Here you'll also find links to the list of people who subscrubed to you, and you are subscribed to. In these lists you can tag your friends. To tag yourself see your Profile settings.

favorites
Since version 0.6.0 StatusNet supports marking a notice as favorite, like bookmarks in your browser. All the notices you marked as favorite will be listed in the Favorites tab of your profile. Everybody can browse your favorites.

To mark a notice as favorite, there is a button in the near of the notice, depending on the styling. The author of the notice will receive an email notification, that you marked the dent as your favorite. At identica it's a small heart at the right side of the notice.

Since version 0.6.3 there is a tab at the main page of StatusNet, where the most faved dents are collected called &quot;Favorited&quot; or since version 0.6.4 &quot;Popular&quot;.

Spam and Blocking other users]
Since version 0.6.4 of StatusNet you can block other users from your account. They are then forced to unsubscribe from your account and can not resubscribe to it. Further they can no longer send you @-replies.

There is a block link around profiles in their profile or your subscribers/subscriptions lists. If you want to block someone.

direct notices [inbox / outbox]
Since version 0.6.0 you can send direct messages other StatusNet users, as long as both of you are subscribed to each other.

If this is the case, you'll find a link below the avatar of the users profile follow the link and type the direct message. Another possibility is to go to either your inbox or your outbox. In both cases right above the input box, there is a pull down menu of all the accounts you can send direct notices to. Select the recipient from this menu, type the message and hit the Send button.

The inbox and outbox tabs are not publicly visible and will only be displayed if you are logged in and view your own profile. Direct messages will not show up in the public timeline. They will only be visible in the Inbox and Outbox tabs of your profile. If you receive a direct message, you'll be notified with an email containing the direct message and a link to reply to the message.

Since version 0.6.1 of StatusNet you can use direct messages by beginning a notice with &quot;d username&quot;.

twitter related
Since version 0.6.3 you can syncronise your friend lists between your StatusNet account and twitter. You'll be automatically connected to other local twitter users in your friendlist, if you two have set up the twitter settings in your profile.

twitter bridge
add to your config.php the following:

Then go to https://twitter.com/apps and add your app. Make it a "Browser" app and use http://example.org/mublog/twitter/authorization as the "call back address" (replacing this with your site URL). Go back to your StatusNet site admin panel, click on Twitter and add Consumer key, Consumer secret and Integration source - which is the same as your Application name you entered while registering the Twitter App.

Finally, go to "Settings - Twitter" and connect with twitter.

How do I delete my account?
Currently with version 0.6.0 of StatusNet you cannot delete your account. This is planned for a future release of StatusNet. See ticket #155 for more information.

= To Do = Things that need to be done for this documentation:
 * introparagraph
 * features planned in the future
 * automatically shortening of long url (introduced with version 0.6.2)
 * send notices via SMS