TagTeam basics: Difference between revisions

From Harvard Open Access Project
Jump to navigation Jump to search
Line 236: Line 236:
*:''Example'': To search for "test" or "text", use "te?t".
*:''Example'': To search for "test" or "text", use "te?t".
* For a multi-character wildcard search, use the symbol "*".  
* For a multi-character wildcard search, use the symbol "*".  
*:''Example'': To search for "testing" or "tester", use "test*."
*:''Example'': To search for "testing" or "tester", use "test*".


=== Boolean searches ===
=== Boolean searches ===

Revision as of 13:24, 21 October 2014

Preface

Here we describe how to use TagTeam. First we introduce some TagTeam terminology, and then we describe the essential tasks that you can perform with TagTeam, such a creating a hub, creating and modifying tags, subscribing to feeds, and searching.

TagTeam terms

  • A TagTeam project is a hub. The person who creates the hub is the hub owner. The hub owner can add others to the project and give them various roles or rights. Hub members with the right privileges can tag web pages for the hub, modify the tags used by any project taggers, have the hub subscribe to feeds published elsewhere, modify the feeds to which the hub subscribes, and create hub feeds based on combinations of tag feeds and input feeds.
    • Hub inputs take three forms: (1) tags applied to external web pages, (2) feeds to which the hub subscribes, and (3) tag records imported from other tagging platforms such as Connotea. Hubs store their inputs from all three sources for deduping, back-up, export, modification, and searching.
    • Hub outputs take four forms: (1) an output feed for each hub tag, (2) an output feed for each input feed, without modification, and (3) an output feed modifying an input feed, (4) an output feed combining any tag feeds and/or input feeds, with or without modifications.
  • An item is the unit of TagTeam information. If you tag an article for a TagTeam hub, the item contains the URL of the article, all the tags you applied to the article, the "description" of the article you may have added at the time of tagging, the fact that you were the one (or one of the ones) who tagged it for the hub, and similar information. (Hence, we sometimes call items "tag records".) The item does not include the text of the article itself. When a hub subscribes to feeds from elsewhere, those feeds deliver streams of items to the hub. When a hub publishes its own feeds, those feeds deliver streams of items to feed subscribers.
  • The bookmarklet is the button on your browser bar that lets you tag web pages. If you have permission to tag for a hub, then you can find the bookmarklet in the "Bookmarks" tab. Near the top of that page is an underlined phrase "Add to TagTeam". Just drag that phrase to your browser bar. If you don't have permission to tag for a given hub, you will not see that phrase on the hub's Bookmarks tab.
  • A filter is a rule for modifying tags. Hub members with suitable privileges can create filters, for example, to replace deprecated tags with approved tags, to replace misspelled tags with correctly spelled tags, and so on. TagTeam can apply filters to individual items, to individual input feeds, or to the entire hub. Feeds can be prospective (modifying all tags made in the future) and retroactive (modifying all tags already stored in the hub). Hub owners can use filters to tidy up a chaotic collection of tags, and to manage the evolution of a folksonomy of user-defined tags into an ontology or standard vocabulary of project-approved tags.
    • If a hub owner adds no other members and runs the hub solo, the power is much like the power provided by other tagging platforms to modify one's own tags. What makes filters special first appears when the hub has other members. Members with suitable privileges can modify the tags of all members, not just the tags their own tags.
  • A remix feed is a feed published by TagTeam consisting of some combination of other feeds. If your project has many tags, for example, A, B, C, D, and E, then a remix feed could contain just the items with tags A, B, and C, or just the items with A and B but not C. Hub owners can carefully create certain remix feeds and offer them to users. Or users with the right hub privileges can create their own.

What you can do without signing up or signing in

You can access TagTeam without signing up for an account or signing in. You can view all hubs. You can also select any tab on any hub and view its information in read-only mode. However, to create a new hub or make any changes to an existing hub, you must create an account and log in.

You can request permission to tag for someone else's hub without signing up for an account or signing in. However, before you can be approved, you must have a TagTeam account.

Setting up an account and logging in

To start:

  1. Go to TagTeam and click the Log in link on the upper right corner of the screen.
  2. When the Sign in screen appears, take one of the following actions:
    • If you already have an account, fill in the Username or email and Password fields and click Sign in.
    • If you do not have an account, click the Sign up link.

Once you have an account, you can create your own hubs, tag for your own hubs, add members to your hubs, and give members different rights or permissions.

Creating a new hub

To create a new hub:

  1. Log in to TagTeam.
  2. Click the New hub link.
  3. Fill in the required Description field. If you like, fill in any of the optional fields for Title, Nickname, Description, and Tags.
  4. Click Create hub.

You can continue by using any of the available tab selections to make changes to the hub. You can also give other people permission to tag for your hub.

Requesting permission to tag for someone else's hub

If you want to tag for a hub owned by someone else, you need the owner's permission. Likewise, if others want to tag for one of your hubs, they need your permission.

To request permission to tag for a certain hub:

  1. Log in to TagTeam and navigate to the desired hub.
  2. Click the Contact tab.
  3. On the "Contact the owners of this hub" screen, do the following:
    1. Fill in the Name and Email fields. The Name field is optional, but we recommend filling it in. Hub owners are more likely to approve your request if they know who you are.
    2. Select "Request to collaborate" from the Reason drop-down list. When "Ways you'd like to collaborate" list appears, check any desired selections.
    3. Fill in the Message field to explain your request.
    4. When done, click Submit.

The hub owner should then reply to your request by email. Note that these requests must be approved by the human hub owner and cannot (yet) be automated. If the owner is busy or traveling, this may take some time. Follow up with the hub owner if you do no hear back within a reasonable time.

Adding the bookmarklet

If you have permission to tag for a hub, then you can use a bookmarklet to add bookmarks to a hub.

To add the bookmarklet:

  1. Log in to TagTeam and navigate to the desired hub.
  2. Click the Bookmarks tab.
  3. Drag the Add to TagTeam link to your browser's bookmarks tool bar.

If you then visit a web page that you want to tag for that hub, click on the bookmarklet and fill in the bookmarklet form.

If you have permission to tag for more than one hub, clicking the bookmarklet adds the item to the most recently selected hub. You can specify a different hub with the drop-down list near the top of the bookmarklet form.

Tagging

There are two ways to tag for a given hub:

  1. From within TagTeam
  2. From another tagging platform

Using TagTeam as your tagging platform

  • Create a TagTeam account as described above. After you create an account, you can create TagTeam hubs, tag items for your own hubs, and tag for hubs owned by others if the owners give you permission to do so.
  • To tag for one of your own hubs, create the hub, install the bookmarklet, and start tagging. Go to a web page you want to tag, click on the bookmarklet, and fill in the bookmarlet form.
  • To tag for a hub owned by someone else, request permission and wait to be approved. Then install the bookmarklet and start tagging.

Using a tagging platform other than TagTeam

  • This works only if your favorite tagging platform creates RSS or Atom feeds for each of its tags. Examples are CiteULike and Delicious. The basic idea is that a TagTeam can subscribe to the feed generated by a special tag you use from your favorite platform. You just need to pick that special tag, request permission to tag for a TagTeam hub, and ask the hub owner to subscribe to the feed generated by your special tag. To do all this, you need not use TagTeam itself or have a TagTeam account.
  • Create a special tag for items you want the TagTeam hub to include, such as add2hubx, jane-add2hubx, 14159, or zebra. Your special tag may be any string of characters accepted as a valid tag by your chosen tagging platform.
  • Determine the URL of the RSS or Atom feed generated by your chosen tagging platform for your special tag.
    • If your chosen tagging platform generates a feed for your individual use of that tag, and a separate feed for everyone's use of the same tag, then use the former.
  • Request permission to tag for a given TagTeam hub.
    • To request permission to tag items for a TagTeam hub, navigate to the TagTeam hub and follow the directions in the section #Requesting permission to tag for someone else's hub. Make sure to include your Name and Email. In your request, indicate the name of the tagging platform you want to use and the URL of the RSS or Atom feed for your special tag.
    • When you are approved, the hub owner can subscribe to the feed generated by your special tag.
    • From your chosen tagging platform, use your special tag for all the items you want the TagTeam hub to include, and omit it from all the items you want the hub to exclude.
    • When you apply your special tag to an item, you may apply any number of other tags as well. If you do, then the TagTeam hub will harvest all the tags you applied.
    • If you use your special tag for too many items unrelated to the hub topic, the hub owner may unsubscribe from your feed.
    • If you have not already done so, review the commonly used tags for the hub.

One purpose of a TagTeam hub is to publish carefully curated feeds of content relevant to the hub's topics. Requiring permission for tagging lets hub owners prevent spammers from undermining the value of project feeds. Hub owners who notice spamming can revoke the spammer's permissions.

Modifying tags

You can modify tags for for items and feeds in a hub or for the hub as a whole if you have the appropriate roles.

A hub owner sets roles as described in the section #Requesting permission to tag for someone else's hub.

Modifying tags for Item

To modify tags for individual items in a hub, you must have the role Feed Item Tag Filter Manager.

To modify tags on items in a hub:

  1. Log in to Tag Team and navigate to the desired hub.
  2. Select the Items tab.
  3. Click the desired item.

    The item's summary screen appears.

  4. Click the Filters tab.

    TagTeam displays the following links:

    • Add a tag to this item
    • Remove a tag from this item
    • Modify a tag on this item

  5. Click the desired link.

    TagTeam displays a dialog box where you specify the tag to add, remove, or modify.

  6. Fill in the dialog box and click Submit.

TagTeam displays a confirmation message at the top of the screen after completing the desired action.

Modifying tags for all items in a feed

To modify tags feed-wide, you must have the role Feed-wide Tag Filter Manager.

To modify tags for all items on a feed:

  1. Log in to Tag Team and navigate to the desired hub.
  2. Select the Inputs tab.
  3. Click the title of the desired feed.

    TagTeam displays a list of input feeds.

  4. Click the Filters tab.

    TagTeam displays the following links:

    • Add a tag to all items in this feed
    • Remove a tag from all items in this item
    • Modify a tag on all items in this feed

  5. Click the desired link.

    TagTeam displays a dialog box where you specify the tag to add, remove, or modify.

  6. Fill in the dialog box and click Submit.

TagTeam displays a confirmation message at the top of the screen after completing the desired action.

Modifying tags that apply to the entire hub

To modify tags hub-wide, you must have the role Hub-wide Tag Filter Manager.

To modify tags for all items in a hub:

  1. Log in to Tag Team and navigate to the desired hub.
  2. Select the Inputs tab.
  3. Click the Filters tab.

    TagTeam displays the following links:

    • Add a tag to all items in this hub
    • Remove a tag from all items in this hub
    • Modify a tag on all items in this hub

  4. Click the desired link.

    TagTeam displays a dialog box where you specify the tag to add, remove, or modify.

  5. Fill in the dialog box and click Submit.

TagTeam displays a confirmation message at the top of the screen after completing the desired action.

Subscribing to tag feeds from other platforms

== Publishing feeds for subscribers

feeds for tags

feeds for users

feeds for tags for users

remix feeds

Searching

This section summarizes searching in TagTeam.

TagTeam uses the Apache Lucerne query parser. For additional details about searching, see http://lucene.apache.org/core/2_9_4/queryparsersyntax.html.

Searching by phrases and keywords

TagTeam supports searches by keywords, such as "Google," and phrases, such as "Google Chrome."

Wildcard searches

  • For a single-character wildcard search, use the symbol "?".
    Example: To search for "test" or "text", use "te?t".
  • For a multi-character wildcard search, use the symbol "*".
    Example: To search for "testing" or "tester", use "test*".

Boolean searches

TagTeam supports searches containing the Boolean operators AND, "=", OR, NOT, and "-". Boolean operators that are words, such as AND, must be in all capital letters.

Saving a Boolean search

Running fuzzy searches

Copyright and licensing

  1. The Harvard copyright statement only covers the code, not the content or data.
  2. Harvard has chosen to make the code free and open source. The code is at GitHub under an Affero General Public License (AGPL).
  3. When users enter original content, they retain ownership of it. But as a condition of using the software, they grant TagTeam a license to use it. See the details in Section 6.3 of the terms of service.
  4. When users enter content they don't own, they warrant that they have the rights necessary to share it through TagTeam. See the details in Section 6.4 of the terms of service.
  5. Some data arise from the use of TagTeam, such as the date when certain items are tagged. Insofar as these data are copyrightable by TagTeam, TagTeam releases the data into the public domain through a CC0 Public Domain Dedication. Insofar as these data are copyrightable by users, users also agree to release the data into the public domain. See the details in Section 6.6 of the terms of service.