forked from GNUsocial/gnu-social
documentation for people tags
This commit is contained in:
Shashi Gowda
parent
b176f0fb58
commit
894d4ba16f
150
EVENTS.txt
150
EVENTS.txt
@ -1115,3 +1115,153 @@ StartGroupProfileElements: Start showing stuff about the group on its profile pa
|
||||
EndGroupProfileElements: Start showing stuff about the group on its profile page
|
||||
- $action: action being executed (for output and params)
|
||||
- $group: group for the page
|
||||
|
||||
StartShowProfileTagContent: When showing a people tag page
|
||||
- $action: action being executed (for output and params)
|
||||
|
||||
EndShowProfileTagContent: After showing the contents of a people tag page
|
||||
- $action: action being executed (for output and params)
|
||||
|
||||
StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
|
||||
- $action: action being executed (for output and params)
|
||||
|
||||
EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
|
||||
- $action: action being executed (for output and params)
|
||||
|
||||
StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
|
||||
- $action: action being executed (for output and params)
|
||||
|
||||
EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
|
||||
- $action: action being executed (for output and params)
|
||||
|
||||
StartTagProfileAction: When starting to show profile tagging page
|
||||
- $action: action being executed (for output and params)
|
||||
- $profile: profile being tagged
|
||||
|
||||
EndTagProfileAction: After showing profile tagging page
|
||||
- $action: action being executed (for output and params)
|
||||
- $profile: profile being tagged
|
||||
|
||||
StartProfileCompletionSearch: When starting a profile search for autocompletion
|
||||
- $action: action being executed (for output and params)
|
||||
- &$profile: result Profile objects
|
||||
- $search_engine: the search engine
|
||||
|
||||
EndProfileCompletionSearch: After search results for profile autocompletion have been found
|
||||
- $action: profilec completion action
|
||||
- &$profile: current result Profile objects
|
||||
- $search_engine: The search engine object
|
||||
|
||||
StartShowTagProfileForm: When showing people tagging form
|
||||
- $action: action being executed (for output and params)
|
||||
- $profile: profile being tagged
|
||||
|
||||
EndShowTagProfileForm: After showing people tagging form
|
||||
- $action: action being executed (for output and params)
|
||||
- $profile: profile being tagged
|
||||
|
||||
StartSavePeopletags: When starting to save people tags
|
||||
- $action: action being executed (for output and params)
|
||||
- $tagstring: string input, a list of tags
|
||||
|
||||
EndSavePeopletags: After saving people tags
|
||||
- $action: action being executed (for output and params)
|
||||
- $tagstring: string input, a list of tags
|
||||
|
||||
StartProfiletagGetUri: when generating the Uri for a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$uri: the URI
|
||||
|
||||
EndProfiletagGetUri: after generating the uri for a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$uri: the URI
|
||||
|
||||
StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$url: the URL
|
||||
|
||||
EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$url: the URL
|
||||
|
||||
StartProfiletagPermalink: when generating the permalink url for a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$url: the URL
|
||||
|
||||
EndProfiletagPermalink: after generating the permalink url for a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$url: the URL
|
||||
|
||||
StartTagProfile: when tagging a profile
|
||||
- $tagger: profile tagging
|
||||
- $tagged: profile being tagged
|
||||
- $tag: the tag
|
||||
|
||||
EndTagProfile: after tagging a profile
|
||||
- $newtag: the newly created Profile_tag object
|
||||
|
||||
StartUntagProfile: when deleting a people tag
|
||||
- $ptag: the Profile_tag object being deleted
|
||||
|
||||
EndUntagProfile: after deleting a people tag
|
||||
- $orig: a copy of the deleted Profile_tag object
|
||||
|
||||
StartSubscribePeopletag: when subscribing to a people tag
|
||||
- $peopletag: Profile_list object being subscribed to
|
||||
- $profile: subscriber's profile
|
||||
|
||||
EndSubscribePeopletag: after subscribing to a people tag
|
||||
- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
|
||||
- $profile: subscriber's profile
|
||||
|
||||
StartUnsubscribePeopletag: when unsubscribing to a people tag
|
||||
- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
|
||||
- $profile: subscriber's profile
|
||||
|
||||
EndUnsubscribePeopletag: after unsubscribing to a people tag
|
||||
- $peopletag: Profile_list object being subscribed to
|
||||
- $profile: subscriber's profile
|
||||
|
||||
StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$object: activity object
|
||||
|
||||
EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
|
||||
- $profile_list: the people tag, a Profile_list object
|
||||
- &$object: activity object
|
||||
|
||||
StartPeopletagGroupNav: Showing the people tag nav menu
|
||||
- $menu: the menu widget; use $menu->action for output
|
||||
|
||||
EndPeopletagGroupNav: after showing the people tag nav menu
|
||||
- $menu: the menu widget; use $menu->action for output
|
||||
|
||||
StartShowPeopletagItem: when showing a people tag
|
||||
- $widget: PeopletagListItem widget
|
||||
|
||||
EndShowPeopletagItem: after showing a people tag
|
||||
- $widget: PeopletagListItem widget
|
||||
|
||||
StartSubscribePeopletagForm: when showing people tag subscription form
|
||||
- $action: action being executed (for output and params)
|
||||
- $peopletag: people tag being subscribed to
|
||||
|
||||
EndSubscribePeopletagForm: after showing the people tag subscription form
|
||||
- $action: action being executed (for output and params)
|
||||
- $peopletag: people tag being subscribed to
|
||||
|
||||
StartShowPeopletags: when showing a textual list of people tags
|
||||
- $widget: PeopletagsWidget; use $widget->out for output
|
||||
- $tagger: profile of the tagger
|
||||
- $tagged: profile tagged
|
||||
|
||||
EndShowPeopletags: after showing a textual list of people tags
|
||||
- $widget: PeopletagsWidget; use $widget->out for output
|
||||
- $tagger: profile of the tagger
|
||||
- $tagged: profile tagged
|
||||
|
||||
StartProfileListItemTags: when showing people tags in a profile list item widget
|
||||
- $widget: ProfileListItem widget
|
||||
|
||||
EndProfileListItemTags: after showing people tags in a profile list item widget
|
||||
- $widget: ProfileListItem widget
|
||||
|
||||
@ -182,6 +182,29 @@ $config['sphinx']['port'] = 3312;
|
||||
// $config['memcached']['server'] = 'localhost';
|
||||
// $config['memcached']['port'] = 11211;
|
||||
|
||||
// People tags
|
||||
// Maximum number of tags a user can create:
|
||||
// $config['peopletag']['maxtags'] = 100;
|
||||
// Maximum number of people can have the same tag by the same user
|
||||
// $config['peopletag']['maxpeople'] = 500;
|
||||
// Types of users one can tag.
|
||||
// Everyone.
|
||||
// $config['peopletag']['allow_tagging']['all'] = true;
|
||||
// Local only.
|
||||
// $config['peopletag']['allow_tagging']['local'] = true;
|
||||
// Subscriptions / Subscribers only (including remote)
|
||||
// $config['peopletag']['allow_tagging']['subs'] = true;
|
||||
// Remote.
|
||||
// $config['peopletag']['allow_tagging']['remote'] = true;
|
||||
// Examples:
|
||||
// The following set of options allows tagging local users and
|
||||
// remote subscribers / subscription.
|
||||
// $config['peopletag']['allow_tagging']['all'] = false;
|
||||
// $config['peopletag']['allow_tagging']['local'] = true;
|
||||
// $config['peopletag']['allow_tagging']['subs'] = true;
|
||||
// Or:
|
||||
// $config['peopletag']['allow_tagging'] = array('local' => true, 'subs' =>true);
|
||||
|
||||
// Disable post-by-email
|
||||
// $config['emailpost']['enabled'] = false;
|
||||
|
||||
|
||||
49
doc-src/tags
49
doc-src/tags
@ -25,20 +25,49 @@ Tagging yourself
|
||||
----------------
|
||||
|
||||
You can also add tags for yourself on your [profile
|
||||
settings](%%action.profilesettings%%) page. Use single words to
|
||||
settings](%%action.profilesettings%%) page or by using the edit tags
|
||||
button on your profile 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
|
||||
--------------------------
|
||||
Tagging others
|
||||
--------------
|
||||
|
||||
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 tag other users by using the edit tags button next to
|
||||
their profile. Such tags are called *people tags*. Once you have
|
||||
created a people tag, you can add or remove users from it using the
|
||||
tag's edit form. This makes it easy to organize your subscriptions
|
||||
into groups and sort through them separately. Also, it will let
|
||||
you create custom lists of people that others can subscribe to.
|
||||
|
||||
You can also send a notice "to the attention of" your subscribers
|
||||
whom you've marked with a particular tag (note: *not* people who've
|
||||
marked themselves with that tag). "@#family hello" will send a
|
||||
notice to all your subscribers you've marked with the tag 'family'.
|
||||
|
||||
Private and public people tags
|
||||
------------------------------
|
||||
|
||||
A private people tag is only visible to the creator, it cannot be
|
||||
subscribed to, but the timeline can be viewed. To create a new
|
||||
private prepend a '.' to the tag in the tags editing box. To set
|
||||
an existing public tag as private or vice-versa, go to the tag's
|
||||
edit page.
|
||||
|
||||
The most used public tags are displayed in the
|
||||
[public people tag cloud](%%action.publicpeopletagcloud%%). Their
|
||||
size shows their frequency of use.
|
||||
|
||||
Remote people tags
|
||||
------------------
|
||||
|
||||
You can even [tag remote users](%%action.profilesettings%%). Just
|
||||
enter the remote profile's URI and click on the "Fetch" button to
|
||||
fetch the profile, you can then add tags and save them.
|
||||
|
||||
Subscribing to the timeline of a people tag on another server also
|
||||
works. Just copy the URL of the people tag's timeline page to the
|
||||
[OStatus subscription](%%action.ostatussub%%) form.
|
||||
|
||||
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'.
|
||||
Loading…
Reference in New Issue
Block a user