|
UW Mangrove Project
|
|
How to add yourself to the Departmental Who's Who
There are two general ways to add yourself to the Who's Who:
- Fill in a simple XML template and store this in your web directory. This is simple, but not as cool (from our point of view)
and not linked up with the content on your existing web page (so it may get out of date).
- Add some basic annotations to your web page, either by hand with an editor or with a simple tool we provide. This will
take a little more work, but then anytime you change your web page
your Who's Who entry will automatically be updated. Plus, you will be
one of the first to really participate in the Semantic Web, and will
then be able to easily add information to the Department
Calendar and Publications Database (see these
instructions for more info). This will not change the appearance of your page within a browser and you can continue to maintain your web page as normal (e.g., with a text editor or with FrontPage).
You can use either technique (or even a mixture of the two). This document is geared towards UW graduate students,
but these instructions will also work for undergrads, faculty members, and staff members, and also for persons not affiliated with UW.
Bear in mind that all the information you provide will be freely
accessible to anyone with a web browser, though the most common users
will be people within the department.
- Log into a UNIX machine. From Windows, use "Programs->Internet and Remote Connections->SSH->Secure Shell Client" and
log into 'bicycle.cs.washington.edu'. For undergrads, try 'barb.cs.washington.edu'.
- Copy the template into your web directory:
cp /projects/semweb1/www/info.xml ~/www
(or download from here)
- Make your file web-accessible:
chmod a+rx ~/www
cd ~/www
chmod a+rx info.xml
- Use an editor to fill in the form with info about you. For instance, use 'emacs -nw info.xml'. Everything
except the 'name' is optional.
- If you are not a grad student, change the <uw:gradStudent> and </uw:gradStudent> tags from
'gradStudent' to 'undergradStudent', 'staffMember', or 'facultyMember'
- Publish your info by entering the
URL for your file (e.g.,
http://www.cs.washington.edu/homes/myusername/info.xml) into this
form.
- You should be immediately added to the Who's
Who. Check it out!
- The server will perioidically revisit this file, so any changes you make will automatically propagate to the Who's Who.
That's all. See here if you want
more info on setting up your web directory, or continue reading to find out how to add
annotations to your main web page.
First a quick overview on what annotations are, then some instructions.
We assume that you already have a personal web page. If not,
follow the directions here to create
one. If you need a UNIX host, try 'bicycle.cs.washington.edu.' (undergrads: try barb.cs.washington.edu) Your web page can be in any format;
here is a completed example (to see annotations, look at the source).
Annotation consists of adding semantic tags to your HTML document. For example,
<html xmlns:uw="http://www.cs.washington.edu/research/semweb/vocab#v1_0">
<uw:gradStudent>
<uw:name> <i> Jane Doe </uw:name> 's </i> home page.
Hi. I'm a <uw:yearOfStudy> 3rd year </uw:yearOfStudy> grad student and my advisor
is <uw:advisor> <a href="http://www.cs.washington.edu/homes/perringer">John Perringer</a> </uw:advisor>.
I like <uw:hobbies>mountain biking and playing squash</uw:hobbies>.
...
</uw:gradStudent>
</html>
The semantic tags are ignored by traditional browsers and thus will
not disrupt the look and feel of your home page. Likewise, HTML
formatting tags (like the <i> tag inside the <uw:name>
element above) are ignored by the semantic parser, so you can tag your
data without having to make any other changes to the HTML.
The system will, however, make use of link or image tags where possible (like in the <a href...> tag inside <uw:advisor> above).
You have a choice of annotating a document either:
Using the graphical annotation tool.
"By hand" (i.e. with an editor such as emacs)
Using the annotation tool is easier and just requires a simple download. The annotation tool will not do any annoying reformatting of your document. This tools runs on Linux but is a little clumsy; we recommend annotation by hand instead on Linux.
If you have more than one page that contains your personal information, simply follow the steps below for each page that you wish to annotate. The Who's Who will automatically combine the information about you into a single entry.
- Follow these instructions for basics on how to download and use the tagger.
- First tag the entire document as a <uw:gradStudent> (or use <uw:undergradStudent>, <uw:staffMember>, or <uw:facultyMember> as appropriate)
- Then highlight specific regions of the page and right-click to select other tags such as <uw:name>, <uw:workEmail>, and <uw:hobbies>. See the schema for explanations.
- (optional)Highlight and tag your picture with the <uw:portrait> tag.
- Save your file, then click on the Publish button in the tagger to send the URL of your page to the server.
- If there are no errors, view the result on the Who's Who. You can stop now, or add more tags and publish again.
- The server will periodically revisit your home page, so changes will automatically propagate into the Who's Who.
- Open your HTML file using an editor such as emacs.
- Change the initial <html> tag to be:
<html xmlns:uw="http://www.cs.washington.edu/research/semweb/vocab#v1_0">
- If you are a grad student, add the <uw:gradStudent> and
</uw:gradStudent> tags surrounding everything between the
<body> and </body> HTML tags (or use <uw:undergradStudent>, <uw:staffMember>, or <uw:facultyMember> as appropriate). Then add
<uw:name>, <uw:workEmail>, and <uw:hobbies> tags (and closing tags) as
appropriate. See the example given above.
- (Optional) Add other tags as desired. For instance:
<uw:portrait> (around an HTML <img> tag for your picture)
<uw:researchInterests>
<uw:office> (use with caution if you are a TA!)
<uw:sportsPlayed>
<uw:birthday> (best to omit the year)
The schema provides a complete list of tags. See the list of allowable tags inside a <uw:gradStudent> tag, or start from the valid top-level tags.
- Save the document and then publish it to make it available to applications. Use the full URL of your home page, e.g., http://www.cs.washington.edu/homes/myusername
- If the "publish" output shows no errors, check out the
Who's Who to see the results!
- The server will periodically revisit your file, so any changes you make will propagate to the Who's Who.
Here is a completed example (to see annotations, look at the source).
NOTES:
- If you wish to add additional semantic information (such as a value for <uw:birthday>) that you don't want
to appear in the rendered HTML, you can inline the information:
VALID: <uw:birthday value="September 21" /> (note the trailing / to terminate the element)
- If you have more than one answer for a given tag (e.g., two advisors), you can either write multiple answers between the given set of tags, or produce multiple sets of tags with a single answer in each, e.g.,
VALID: <uw:advisor>John Doe and Jane Deer</uw:advisor>
VALID: <uw:advisor>John Doe</uw:advisor> and <uw:advisor>Jane Deer</uw:advisor>
- Legal tags to use depend upon the semantic context, which is determined by the parent semantic tag. For instance,
VALID: <uw:gradStudent> <uw:office> Allen 516 </uw:office> <uw:gradStudent> (<uw:office> is a valid tag
inside <uw:gradStudent>)
INVALID:<uw:gradStudent> <uw:course> CSE 521 </uw:course> <uw:gradStudent> (<uw:course> is not valid inside <uw:gradStudent>)
The top-level tags are valid for use when there is no parent tag, such as when starting a document.
- You may freely intermix HTML formatting tags and semantic tags. For instance,
VALID: <uw:topic>The <b>Final</b> demo! </uw:topic>
- However, semantic tags must be properly nested, just like with XML. For instance, do not do the following:
INVALID: <uw:event> <uw:topic> Networks </uw:event></uw:topic>
(instead, the <topic> element must be completely nested inside the <event> element)
- Wondering why certain tags aren't showing? They've probably been parsed, but just aren't being displayed.
The following information/tags are displayed by the Who's Who:
- Advised Student,
Advisor,
Assistant,
Birthday,
Cell Phone,
Degree Completed,
Degree Goal,
Hobbies,
Home Address,
Home Phone,
Job Title,
Office Hours,
Office,
Organization,
Other Interests,
Pager,
Personal Email,
Personal Homepage,
Portrait,
Program Status,
Research Interests,
Sports Played,
Thesis Topic,
Undergrad University,
Work Email,
Work Homepage,
Work Phone,
Year Of Study.
Make sure you modified the initial <html> tag as specified above.
Make sure you publish your document.
The semantic parser is not currently very user friendly. If you get parsing errors, check to make sure that
every semantic tag has a matching end tag and that the semantic tags are properly nested.
This is a research prototype, so we are happy to help if you have any problems. Send mail to lucasm@cs.washington.edu.