From 3d6f092684723d21e03505a1b1bf3492b9af04dd Mon Sep 17 00:00:00 2001 From: Geoff McLane Date: Sun, 3 Aug 2014 19:25:09 +0200 Subject: [PATCH] some documentation updates, but not checked --- build/rpm/tidy.spec | 3 +- htmldoc/quickref-html.xsl | 3 +- htmldoc/tidy1.xsl | 60 +++++++++++++++++++++++++++++---------- 3 files changed, 47 insertions(+), 19 deletions(-) diff --git a/build/rpm/tidy.spec b/build/rpm/tidy.spec index 630f5c0..aa76c91 100644 --- a/build/rpm/tidy.spec +++ b/build/rpm/tidy.spec @@ -1,5 +1,4 @@ -# -# spec file for package tidy +# RPM spec file for tidy # # (c) 2006 (W3C) MIT, ERCIM, Keio University # See tidy.h for the copyright notice. diff --git a/htmldoc/quickref-html.xsl b/htmldoc/quickref-html.xsl index ada2a73..aaf5004 100644 --- a/htmldoc/quickref-html.xsl +++ b/htmldoc/quickref-html.xsl @@ -32,8 +32,7 @@

HTML Tidy Configuration Options

-

Generated automatically with HTML Tidy released - on .

+

Version:

HTML, XHTML, XML
Diagnostics
diff --git a/htmldoc/tidy1.xsl b/htmldoc/tidy1.xsl index 85f070b..414eb53 100644 --- a/htmldoc/tidy1.xsl +++ b/htmldoc/tidy1.xsl @@ -41,20 +41,24 @@ - .\" tidy man page for the Tidy Sourceforge project -.TH tidy 1 "$Date: 2007/02/01 12:25:21 $" "HTML Tidy " "User commands" + .\" tidy man page for the HTML5 fork of Tidy +.TH TIDY 1 "" "HTML Tidy" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l .SH NAME -\fBtidy\fR - validate, correct, and pretty-print HTML files -.br -(version: ) +\fBtidy\fR - check, correct, and pretty-print HTML(5) files .SH SYNOPSIS \fBtidy\fR [option ...] [file ...] [option ...] [file ...] .SH DESCRIPTION -Tidy reads HTML, XHTML and XML files and writes cleaned up markup. For HTML variants, it detects and corrects many common coding errors and strives to produce visually equivalent markup that is both W3C compliant and works on most browsers. A common use of Tidy is to convert plain HTML to XHTML. For generic XML files, Tidy is limited to correcting basic well-formedness errors and pretty printing. +Tidy reads HTML(5), XHTML(5) and XML files and writes cleaned-up markup. For HTML variants, it detects, reports, and corrects many common coding errors and strives to produce visually equivalent markup that is both conformant to the HTML specifications and that works in most browsers. +.LP +A common use of Tidy is to convert plain HTML to XHTML. For generic XML files, Tidy is limited to correcting basic well-formedness errors and pretty printing. .LP If no input file is specified, Tidy reads the standard input. If no output file is specified, Tidy writes the tidied markup to the standard output. If no error file is specified, Tidy writes messages to the standard error. For command line options that expect a numerical argument, a default is assumed if no meaningful value can be found. @@ -68,10 +72,6 @@ Input/Output default to stdin/stdout respectively. Single letter options apart f .LP .in 1i \fBtidy -f errs.txt -imu foo.html\fR -.LP -For further info on HTML see \fIhttp://www.w3.org/MarkUp\fR. -.LP -For more information about HTML Tidy, visit the project home page at \fIhttp://tidy.sourceforge.net\fR. Here, you will find links to documentation, mailing lists (with searchable archives) and links to report bugs. .SH ENVIRONMENT .TP .B HTML_TIDY @@ -347,12 +347,42 @@ appearing in content with another backslash. -.SH "SEE ALSO" -HTML Tidy Project Page at \fIhttp://tidy.sourceforge.net\fR -.SH AUTHOR -\fBTidy\fR was written by Dave Raggett <\fIdsr@w3.org\fR>, and is now maintained and developed by the Tidy team at \fIhttp://tidy.sourceforge.net/\fR. It is released under the \fIMIT Licence\fR. +.SH SEE ALSO +For more information about the experimental HTML5 fork of Tidy: +.RS 4 .LP -Generated automatically with HTML Tidy from https://github.com/w3c/tidy-html5. +http://w3c.github.com/tidy-html5/ +.RE +.LP +For more information on HTML: +.RS 4 +.LP +\fBHTML: Edition for Web Authors\fR (the latest HTML specification) +.br +http://dev.w3.org/html5/spec-author-view +.LP +\fBHTML: The Markup Language\fR (an HTML language reference) +.br +http://dev.w3.org/html5/markup/ +.RE +.LP +For bug reports and comments: +.RS 4 +.LP +https://github.com/w3c/tidy-html5/issues/ +.RE +.LP +Or send questions and comments to \fBhtml-tidy@w3.org\fR +.LP +Validate your HTML documents using the \fBW3C Nu Markup Validator\fR: +.RS 4 +.LP +http://validator.w3.org/nu/ +.RE +.SH AUTHOR +\fBTidy\fR was written by \fBDave Raggett\fR <dsr@w3.org>, and subsequently maintained by a team at http://tidy.sourceforge.net/ +.LP +The sources for the HTML5 fork of \fBTidy\fR are available at https://github.com/w3c/tidy-html5/ under the MIT Licence.