W3C home > Mailing lists > Public > www-validator-cvs@w3.org > August 2010

link-checker commit: Add docs.

From: Mercurial notifier <nobody@w3.org>
Date: Thu, 05 Aug 2010 14:46:52 +0000
To: link-checker updates <www-validator-cvs@w3.org>
Message-Id: <E1Oh1ie-0005SN-4X@blinky.w3.org>
changeset:   3:8d0c146395e0
user:        ville
date:        Sun Mar 21 15:11:12 2004 +0000
files:       MANIFEST docs/checklink.css docs/checklink.html
description:
Add docs.


diff -r ddeae812731c -r 8d0c146395e0 MANIFEST
--- a/MANIFEST	Thu Mar 18 21:44:14 2004 +0000
+++ b/MANIFEST	Sun Mar 21 15:11:12 2004 +0000
@@ -6,3 +6,5 @@
 bin/checklink           The link checker
 bin/checklink.pod       Manual page for the link checker
 META.yml
+docs/checklink.html     Additional documentation
+docs/checklink.css      Cascading style sheet for the documentation
diff -r ddeae812731c -r 8d0c146395e0 docs/checklink.css
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/checklink.css	Sun Mar 21 15:11:12 2004 +0000
@@ -0,0 +1,165 @@
+/*
+   Base Style Sheet for the W3C Markup Validation Service.
+
+   Copyright 2000-2004 W3C (MIT, INRIA, Keio). All Rights Reserved.
+   See http://www.w3.org/Consortium/Legal/ipr-notice.html#Copyright
+
+   $Id: checklink.css,v 1.1 2004-03-21 15:11:12 ville Exp $
+*/
+
+html, body {
+  color:            black;
+  background:       white;
+  font-family:      "Bitstream Vera Sans", sans-serif;
+  margin:           0;
+  padding:          0;
+  border:           0;
+}
+
+div#main {
+  padding-top:      1em;
+  margin-left:      1em;
+  margin-right:     7.6em;
+}
+
+div#main p {
+  padding-left:     1em;
+  padding-right:    1em;
+}
+
+a:link, a:visited {
+  color:            blue;
+}
+a:hover {
+  color:            blue;
+  background-color: #eee;
+}
+a:active {
+  color:            red;
+  background-color: yellow;
+}
+
+acronym:hover, abbr:hover {cursor: help};
+abbr[title], acronym[title], span[title], strong[title] {
+  border-bottom:    thin dotted;
+  cursor:           help;
+}
+
+pre, code, tt {
+  font-family:      monospace;
+  line-height:      100%;
+  white-space:      pre;
+}
+
+a:link img, a:visited img {
+  border-style:     none;
+}
+a img {
+  color:            black; /* The only way to hide the border in NS 4.x */
+}
+
+ul.toc {
+  list-style:       none;
+}
+
+ol li {
+  padding:          .1em;
+}
+
+h1 a {color: black} /* These are usually targets and not links */
+h2 a {color: black} /* These are usually targets and not links */
+h3 a {color: black} /* These are usually targets and not links */
+
+img {
+  vertical-align:    middle;
+}
+
+address img {
+  float:             right;
+  width:             88px;
+}
+
+address {
+  padding-top:       .5em;
+  padding-right:     1em;
+  padding-left:      1em;
+  padding-bottom:    .5em;
+  margin-top:        3em;;
+  border-top:        1px solid black;
+  background-color:  #eee;
+  clear:             right;
+}
+
+p.copyright {
+  margin-top:        5em;
+  padding-top:       .5em;
+  font-size:         xx-small;
+  max-width:         85ex;
+  text-align:        justify;
+  text-transform:    uppercase;
+  margin-left:       auto;
+  margin-right:      auto;
+  font-family:       monospace;
+  color:             #888;
+  line-height:       120%;
+}
+
+p.copyright a {
+  color:             #88f;
+  text-decoration:   none;
+}
+
+/* Various header(ish) things. Definitions cribbed from the CORE Styles. */
+h1 {
+  font-family: "Bitstream Vera Sans", Tahoma, Verdana, "Myriad Web", Syntax, sans-serif;
+  font-size-adjust: .53;
+  font-size: 2em;
+  font-weight: bold;
+  font-style: normal;
+  text-decoration: none;
+  color: #053188;
+}
+#banner h1 {font-size: 1.3em;
+border-bottom: 1px solid black;}
+
+#banner {background-image: url(/validator/banner-qa.jpg);
+background-repeat: no-repeat;
+background-attachment: scroll;
+height: 50px;
+background-position: right;
+margin:0; padding:0;}
+
+h1#title {
+/*  background-color: #eee; 
+  border-bottom: 1px solid black; 
+  padding: .25em;*/
+  padding:0;
+  margin: 0;
+  color: #053188;
+}
+
+h2 {
+  font-family: "Bitstream Vera Sans", Tahoma, Verdana, "Myriad Web", Syntax, sans-serif;
+  font-size-adjust: .53;
+  font-size: 1.5em;
+  text-align: left;
+  font-weight: bold;
+  font-style: normal;
+  text-decoration: none;
+  margin-top : 2em;
+  margin-bottom : 1em;
+  line-height: 120%;  
+}
+
+h3 {
+  font-family: "Bitstream Vera Sans", Tahoma, Verdana, "Myriad Web", Syntax, sans-serif;
+  font-size-adjust: .53;
+  font-size: 1.3em;
+  background-color: #eee;
+  text-indent: 2em;
+  padding: .2em;
+  border-top: 1px dotted black;
+  font-weight: normal;
+  font-style: normal;
+  text-decoration: none;
+}
diff -r ddeae812731c -r 8d0c146395e0 docs/checklink.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/checklink.html	Sun Mar 21 15:11:12 2004 +0000
@@ -0,0 +1,214 @@
+<?xml version="1.0"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>W3C Link Checker Documentation</title>
+    <link rev="made" href="mailto:www-validator@w3.org" />
+    <style type="text/css" media="all">@import "checklink.css";</style>
+    <meta name="revision" content="$Id: checklink.html,v 1.1 2004-03-21 15:11:12 ville Exp $" />
+  </head>
+
+  <body>
+    <div id="banner">
+    <h1 id="title"><a href="http://www.w3.org/"><img height="48" alt="W3C"
+        id="logo" src="http://www.w3.org/Icons/WWW/w3c_home" /></a>
+	<img src="http://www.w3.org/QA/2002/12/qa-small.png" alt="QA"/>
+      Link Checker</h1>
+    </div>
+
+    <div id="main">
+
+    <ul>
+      <li><a href="#about">About this service</a></li>
+      <li><a href="#what">What it does</a></li>
+      <li><a href="#online">Use it online</a></li>
+      <li><a href="#install">Install it locally</a></li>
+      <li><a href="#csb">Comments, suggestions and bugs</a></li>
+    </ul>
+
+    <h2><a name="about" id="about">About this service</a></h2>
+
+    <p>
+      In order to check the validity of the technical reports that W3C
+      publishes, the Systems Team has developed a link checker.
+    </p>
+
+    <p>
+      A first version was developed in August 1998 by
+      <a href="http://www.w3.org/People/Renaud/">Renaud Bruyeron</a>.
+      Since it was lacking some functionalities,
+      <a href="http://www.w3.org/People/Hugo/">Hugo Haas</a>
+      rewrote it more or less from scratch in November 1999.
+    </p>
+
+    <p>
+      The source code is available publicly under the
+      <a href="http://www.w3.org/Consortium/Legal/copyright-software">W3C IPR
+      software notice</a> from
+      <a href="http://dev.w3.org/cvsweb/validator/httpd/cgi-bin/checklink.pl">CVS</a>.
+    </p>
+
+    <h2><a name="what" id="what">What it does</a></h2>
+
+    <p>
+      The link checker reads an HTML or XHTML document and extracts a list
+      of anchors and links.
+    </p>
+
+    <p>
+      It checks that no anchor is defined twice.
+    </p>
+
+    <p>
+      It then checks that all the links are dereferenceable, including
+      the fragments. It warns about HTTP redirects, including directory
+      redirects.
+    </p>
+
+    <p>
+      It can check recursively a part of a Web site.
+    </p>
+
+    <p>
+      There is a command line version and a
+      <abbr title="Common Gateway Interface">CGI</abbr> version. They both
+      support <a href="http://www.ietf.org/rfc/rfc2617.txt">HTTP basic
+      authentication</a>. This is achieved in the CGI version
+      by passing through the authorization information from the user browser
+      to the site tested.
+    </p>
+
+    <h2><a name="online" id="online">Use it online</a></h2>
+
+    <p>
+      There is an
+      <a href="http://validator.w3.org/checklink">online version</a>
+      of the link checker.
+    </p>
+
+    <p>
+      The number of documents that can be checked recursively is limited
+      and there is a delay between each document checked to avoid abuses.
+    </p>
+
+    <h2><a name="install" id="install">Install it locally</a></h2>
+
+    <p>
+      The link checker is written in Perl. It is one single file, but it
+      depends on a few modules available from
+      <abbr title="Comprehensive Perl Archive Network">CPAN</abbr>.
+    </p>
+
+    <p>In order to install it:</p>
+
+    <ol>
+      <li>
+	Install <a href="http://www.perl.com/">Perl</a>.
+      </li>
+      <li>
+	You will need the following <a href="http://www.cpan.org/">CPAN</a>
+	distributions, as well as the distributions they possibly depend on.
+	Depending on your Perl version, you might already have some of
+	these installed.  Also, the latest versions of these may require a
+        recent version of Perl.  As long as the minimum version requirement(s)
+        below are satisfied, everything should be fine.  The latest version
+        should not be needed, just get an older version that works with your
+        Perl.  For an introduction to installing Perl modules,
+	see <a href="http://www.cpan.org/misc/cpan-faq.html#How_install_Perl_modules">The CPAN FAQ</a>.
+	<ul>
+	  <li><a href="http://search.cpan.org/dist/CGI.pm/">CGI.pm</a></li>
+          <li><a href="http://search.cpan.org/dist/Config-General/">Config-General</a> (optional, version 2.06 or newer; required only for reading the (optional) configuration file)</li>
+	  <li><a href="http://search.cpan.org/dist/HTML-Parser/">HTML-Parser</a> (version 3.00 or newer)</li>
+	  <li><a href="http://search.cpan.org/dist/libwww-perl/">libwww-perl</a> (version 5.60 or newer if you want HTTP/1.1 with <code>Keep-Alive</code>)</li>
+          <li><a href="http://search.cpan.org/dist/Net-IP/">Net-IP</a></li>
+          <li><a href="http://search.cpan.org/dist/TermReadKey/">TermReadKey</a> (optional but recommended; required only in command line mode for password input)</li>
+	  <li><a href="http://search.cpan.org/dist/Time-HiRes/">Time-HiRes</a></li>
+	  <li><a href="http://search.cpan.org/dist/URI/">URI</a></li>
+	</ul>
+      </li>
+      <li>
+	Download the link checker from
+	<a href="http://dev.w3.org/cvsweb/validator/httpd/cgi-bin/checklink.pl">CVS</a>.
+      </li>
+      <li>
+        Download the configuration file from
+        <a href="http://dev.w3.org/cvsweb/validator/htdocs/config/checklink.conf">CVS</a>
+        and install it to <code>/etc/w3c/checklink.conf</code> or set the
+        <code>W3C_CHECKLINK_CFG</code> environment variable to the location
+        where you installed it.
+      </li>
+    </ol>
+
+    <p>
+      Calling <code>checklink.pl</code> without any arguments runs the
+      CGI version, and running <code>checklink.pl --help</code> shows how to
+      use the command line version.  The script also includes embedded
+      <abbr title="Plain Old Documentation">POD</abbr> documentation, use
+      <code><a href="http://search.cpan.org/dist/Pod-Perldoc/lib/perldoc.pod">perldoc</a> checklink.pl</code> to view it.
+    </p>
+
+    <p>
+      If you want to enable the authentication capabilities with Apache,
+      have a look at
+      <a href="http://lists.w3.org/Archives/Public/www-validator/1999JulSep/0140.html">Steven Drake's hack</a>.
+    </p>
+
+    <p>
+      Some environment variables affect the way how the link checker uses
+      <a href="http://www.ietf.org/rfc/rfc959.txt"><abbr title="File Transfer Protocol">FTP</abbr></a>.
+      In particular, passive mode is the default.  See
+      <a href="http://search.cpan.org/dist/libnet/Net/FTP.pm#CONSTRUCTOR">Net::FTP(3)</a>
+      for more information.
+    </p>
+
+    <p>
+      There are multiple alternatives for configuring the default
+      <a href="http://www.ietf.org/rfc/rfc977.txt"><abbr title="Network News Transfer Protocol">NNTP</a>
+      server for use with <code>news:</code> URIs without explicit hostnames,
+      see
+      <a href="http://search.cpan.org/dist/libnet/Net/NNTP.pm#CONSTRUCTOR">Net::NNTP(3)</a>
+      for more information.
+    </p>
+
+    <h2><a name="csb" id="csb">Comments, suggestions and bugs</a></h2>
+
+    <p>
+      The current version has proven to be stable. It could however be
+      improved, see the <a href="http://www.w3.org/Bugs/Public/buglist.cgi?product=LinkChecker&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED">list of open enhancement ideas and bugs</a> for details.
+    </p>
+
+    <p>
+      Please send comments, suggestions and bugs about the link checker
+      to the <a href="mailto:www-validator@w3.org?subject=checklink%3A%20">www-validator mailing list</a>
+      (<a href="http://lists.w3.org/Archives/Public/www-validator/">archives</a>),
+      with 'checklink' in the subject.
+    </p>
+
+    </div>
+    <address>
+      <a href="http://validator.w3.org/check?uri=referer"><img
+        src="http://www.w3.org/Icons/valid-xhtml10" height="31" width="88"
+        alt="Valid XHTML 1.0!" /></a>
+      <a title="Send Feedback for the W3C Link Checker"
+        href="http://validator.w3.org/feedback.html">The W3C Validator Team</a><br />
+      $Date: 2004-03-21 15:11:12 $
+    </address>
+    <p class="copyright">
+      <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> &copy; 1994-2004
+      <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a>&reg;
+      (<a href="http://www.lcs.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
+      <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
+      <a href="http://www.keio.ac.jp/">Keio</a>),
+      All Rights Reserved.
+      W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
+      <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>,
+      <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a>
+      and <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-software">software licensing</a>
+      rules apply. Your interactions with this site are in accordance
+      with our <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Public">public</a> and
+      <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Members">Member</a> privacy
+      statements.
+    </p>
+  </body>
+</html>
Received on Thursday, 5 August 2010 14:46:55 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 7 January 2015 15:17:43 UTC