W3C Web Editing Tools for Media Annotations WG.

Tools and Guidelines for editing specification in WG space

These tools allow editing any document in the Working Group space (http://www.w3.org/2008/WebVideo/Annotations/)

1. Editors SHOULD use Jigedit to publish on w3C web site.
2. Editors should use an HTML authoring tool that allows to publish on our web site using a PUT, else you should use our internal PUT tools, or WebDav or CVS.
3. Editors MUST use Validation Tools

A- Use an HTML authoring tool that allows to publish on our web site using a PUT.

• Amaya is the W3C's browser/authoring tool and is used to demonstrate and test many of the new developments in Web protocols and data formats. It is available on both Unix and Windows '95/NT platforms.
  It supports most advanced features of HTTP 1.1 , such as content negotiation to retrieve the most appropriate picture format, keep alive connections to save bandwidth and authentication to allow secure remote publishing.

If your Web authoring tool does not support PUT, you should use our internal internal PUT tools,:

• Winie is a Java network utility to put (delete and get) files on the World Wide Web using HTTP/1.1.
  A highly recommended tool allowing, version conflict detection, retries when connection closed, upload all files located in a directory (recursively or not), support for proxies and metadata configuration (language, charset).
  Winie needs jdk1.2.2
• Web Commander is a Win32 application to put (delete and get) documents remotely using HTTP/1.1.
  It allows the user to explicitly control the metadata describing the document to save including the language, type, charset, etc. Download Web Commander.

B- Use WebDav

WebDAV is an HTTP-based protocol that allows accessing the content of an HTTP server as a networked filesystems; to put it simply, it allows to edit directly a Web site as if it were an additional disk on your computer. JigEdit accounts are configured to allow users to use the WebDAV protocol.

C- Use CVS

CVS accounts are available for web account holders at member and public level access. They are described as follows:

• cvs.w3.org (Member) CVS access denotes that the holder of the account has carefully circumscribed access to the W3C site. The requested work area must be included in the original account request (see below). These accounts access spaces under cvs.w3.org:/w3ccvs.
• dev.w3.org (Public) CVS access denotes that the holder has read/write access to the public areas of the W3C site. These accounts are provided to those Collaborators and Invited Experts that are performing collaborative functions on code or documents maintained under spaces in dev.w3.org:/sources/public or elsewhere on the public server.

Nota bene: In order to process requests for either of the above types of CVS account, the request MUST include a SSH public key (the id_{dsa,rsa}.pub file) in OpenSSH format from the end user.

Note: CVS is only recommended for expert users. If you would prefer to use a simpler interface to edit pages on the Web site, consider WebDAV. Refer to the guidebook Use of CVS in W3C

Send your request to Thierry Michel , (tmichel@w3.org) for a CVS account if you need one.

Validation Tools

Append one of these magic words to the end of any URI on www.w3.org for quick access to the tool (it does not work in DEV space (http://dev.w3.org).

• ,checklink or ,checklinks: runs Link Checker. Works on non-public pages too !
• ,validate: runs Validator on the URL. Works on non-public pages too !
• ,cssvalidate: runs CSS Validator on the URL.
• ,text: outputs a text only version of the page. Very handy to paste pages into a mail. Does not work on non-public pages yet :-(

Editors must conform to W3C Publication Guidelines

Note. It is not the role of the Team Contact or of the W3C Communications or Web Teams to ensure that documents are valid; it is the Editor's responsibility. The Editor should ensure validity before requesting publication. The W3C makes available validation services to assist Editors.

Please follow these steps to ensure that your documents are valid once in TR space:

• Check your spelling.
• Make sure there are no broken links in your documents at the time of publication. Some services on the Web may help you with this, including W3C's link checking service (append ",checklink" to the URL).
• Make sure your Technical Report validates in the HTML Validation Service (using the HTML 4.0, 3.2, or 2.0 DTDs). You may append ",validate" to a W3C URI to invoke the HTML validator for the resource. Please make sure any HTML examples in your document validate as well.
• Make sure your Technical Report validates in the CSS Validation Service. You may append ",cssvalidate" to a W3C URI to invoke the CSS validator for the resource. Please make sure any CSS examples in your document validate as well.
• Make sure your document is accessible: Follow the Web Content Accessibility Guidelines. Use an automated tool such as Bobby.

Jigedit

Here are some hints about Jigedit, our publishing tool.

You MUST have a Jigedit account to publish on w3C web site. Send your request to Thierry Michel , (tmichel@w3.org) for a jigedit account if you need one.

Jigedit is our PUT server that allows users to easily upload documents on our web site, and to concurrently edit the same documents. It is based on jigsaw, the W3C HTTP server, and CVS, the Concurrent Versioning System.
There is documentation in the Jigedit Guide on how to use Jigedit. The documentation needs work, but it would get you started.

You can browse your area in jigedit: http ://jigedit.w3.org/your-jigedit-account/
It looks like a file system. The Root of the W3C Web site is at http ://jigedit.w3.org/your-jigedit-account/WWW/

You can select any html file, and then edit it using one of the PUT-capable HTML editors, and then save it: it will be uploaded on our web site, and immediately browsable using the regular www.w3.org URL. The recommended way to PUT is using our PUT tool. The other recommended tool is W3C's own browser/editor, Amaya

Access is limited to http ://jigedit.w3.org/your-jigedit-account/WWW/2008/WebVideo/Annotations/ only. You can't browse or PUT documents in other areas of our web site through jigedit.
What you see in http ://jigedit.w3.org/your-jigedit-account/WWW/2008/WebVideo/Annotations/ is a copy of the content of our web site in the SYMM Working Group area. When you upload a new document, it will automatically be propagated to the 'live' copy on the main web site.

For example if you need to publish a document to http://www.w3.org/2008/WebVideo/Annotations/foo.html
Use jigedit and upload it to: http ://jigedit.w3.org/your-jigedit-account/WWW/2008/WebVideo/Annotations/foo.html

In order to change your Jigedit Password use http ://jigedit.w3.org/your-jigedit-account/ChangePassword

Questions and requests about jigedit should go to webreq@w3.org . There is some information on how jigedit works in the Jigedit Guide.

Tools and Guidelines for editing specification in DEV space

These tools allow editing any document in the Working Group space (http://dev.w3.org/2008/video/mediaann/)

1. Editors MUST use CVS and XML spec tool to publish on W3C DEV webspace.

A-Use CVS

CVS accounts are available for web account holders at member and public level access. They are described as follows:

• cvs.w3.org (Member) CVS access denotes that the holder of the account has carefully circumscribed access to the W3C site. The requested work area must be included in the original account request (see below). These accounts access spaces under cvs.w3.org:/w3ccvs.
• dev.w3.org (Public) CVS access denotes that the holder has read/write access to the public areas of the W3C site. These accounts are provided to those Collaborators and Invited Experts that are performing collaborative functions on code or documents maintained under spaces in dev.w3.org:/sources/public or elsewhere on the public server.

Nota bene: In order to process requests for either of the above types of CVS account, the request MUST include a SSH public key (the id_{dsa,rsa}.pub file) in OpenSSH format from the end user.

You MUST have a CVS account to publish on W3C DEV webspace. Send your request to Thierry Michel , (tmichel@w3.org) for a CVS account if you need one.

Refer to the guidebook Use of CVS in W3C

B-Use of XMLSpec

You need CVS read and write access to the W3C Public CVS Repository. After getting the access, checkout the complete Media Annotations directory

Refer to the XMLSPEC info page

http://www.w3.org/2008/WebVideo/Annotations/editors.html#xmlspec

Thierry Michel , (tmichel@w3.org), W3C staff contact.

last revised $Date: 2009/12/08 21:45:18 $ by $Author: tmichel $