Documentation updates.

* CHANGES
    add changes since last time we were going to release 1.0

* templates/docroot/help_rootview.html
    add better overview of ViewCVS. a little dry but more useful than
    "Directory entries end in slashes" and other stuff that shouldn't have
    to be pointed out.

    also remove outdated information about ViewCVS Project and
    replace it with a link to viewcvs.sourceforge.net


git-svn-id: http://viewvc.tigris.org/svn/viewvc/trunk@1152 8cb11bc2-c004-0410-86c3-e597b4017df7
remotes/tags/1.0.0-rc1
rey4 2005-11-08 12:21:15 +00:00
parent b0d6bf328e
commit 78c66dff21
2 changed files with 108 additions and 39 deletions

41
CHANGES
View File

@ -18,41 +18,70 @@ Version 1.0 (not yet released)
(2002-Dec-12)
* add new "use_localtime" option to display local times instead of
UTC times (2002-May-06)
* add new "root_parents" option to make it possible to add and
remove repositories without modifying the ViewCVS configuration
(2004-Jul-16)
* add new "template_dir" option to facilitate switching between
sets of templates (2005-Feb-08)
* add new "sort_group_dirs" option to disable grouping of
directories in directory listings (2005-Mar-07)
* make "default_root" option optional. When no root is specified,
show a page listing all available repositories (2005-Feb-04)
* make "checkout_magic" obsolete (but still enabled by default for
URL compatibility with old versions of ViewCVS). When disabled,
bare file URLs (with no query parameters) will return checked
out file contents instead of log listings. That way, checkout
URLs no longer need magic /*checkout*/ strings in them for
relative links and image paths in checked out HTML files to work
(2005-Feb-13)
* hide CVS "Attic" directories and add simple toggle for showing
dead files in directory listings (2004-Jul-31)
* show Unified, Context and Side-by-side diffs in HTML instead of
in bare text pages (2004-Jun-22)
* make View/Download links work the same for all file types
(2004-Jan-21)
* add links to tip of selected branch on log page (2005-Oct-03)
* enable enscript highlighting for more file types
* add sorting arrows for directory views (2004-Jul-21)
* get rid of popup windows for checkout links (2004-Jan-21)
* obfuscate email addresses in html output by encoding @ symbol
with an HTML character reference (2004-Jul-29)
* add page numbers to page pick lists (2002-Feb-01)
* Improvements to templates
- add new template authoring guide
- increase coverage, use templates to produce HTML for diff pages,
markup pages, annotate pages, and error pages
- move more common page elements into includes
- clean up HTML output using CSS for formatting, entities to
escape special characters, and content-oriented tags like
optgroup, thead, and tbody. Also fix tag nesting.
* add new "root_parents" option to make it possible to add and
remove repositories without modifying the ViewCVS configuration
(2004-Jul-16)
- add new template variables providing ViewCVS URLs for more
links between related pages and less URL generation inside
templates
* add new [define] EZT directive for assigning variables within
templates (2004-Apr-21)
* add command line argument parsing to install script to allow
non-interactive installs (2005-Jan-06)
* add stricter parameter validation to lower likelihood of CSS
vulnerabilities (2002-May-24)
* add support for cvsweb's "mime_type=text/x-cvsweb-markup" URLs
(2002-Oct-10)
* fix incompatibility with enscript 1.6.3 (2002-Feb-05)
* fix bug in parsing FreeBSD rlog output (2003-Jul-24)
* work around rlog assumption all two digit years in RCS files are
relative to the year 1900. (2005-Sep-30)
* change loginfo-handler to cope with spaces in filenames and
support a simpler command line invocation from CVS (2003-Feb-11)
* show diff error when comparing two binary files (2002-Jan-23)
* make regular expression search skip binary files (2002-Jan-17)
* make regular expression search skip nonversioned files in CVS
directories instead of choking on them (2002-Sep-27)
* fix tarball generator so it doesn't include forbidden modules
(2002-Feb-22)
* output "404 Not Found" errors instead of "403 Forbidden" errors
to not reveal whether forbidden paths exist (2005-May-17)
* fix sorting bug in directory view (2002-Apr-18)
* reset log and directory page numbers when leaving those pages
(2005-Jan-29)
* reset sort direction in directory listing when clicking new
columns (2004-Jul-21)
* fix "Accept-Language" handling for Netscape 4.x browsers
(2002-May-23)
* fix file descriptor leak in standalone server (2004-Jul-17)

View File

@ -2,7 +2,7 @@
"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>ViewCVS Help: Toplevel Directory View</title>
<title>ViewCVS Help: General</title>
<link rel="stylesheet" href="help.css" type="text/css" />
</head>
<body>
@ -14,7 +14,7 @@
src="images/logo.png" alt="ViewCVS logotype" /></a>
</td>
<td>
<h1>ViewCVS Help: Toplevel Directory View</h1>
<h1>ViewCVS Help: General</h1>
</td>
</tr>
<tr><td>
@ -23,7 +23,6 @@
<a href="help_dirview.html">Directory&nbsp;View</a><br />
<a href="help_log.html">Classic&nbsp;Log&nbsp;View</a><br />
<a href="help_logtable.html">Alternative&nbsp;Log&nbsp;View</a><br />
<a href="help_query.html">Query&nbsp;Database</a><br />
<h3>Internet</h3>
<a href="http://viewcvs.sf.net/index.html">Home</a><br />
@ -32,36 +31,77 @@
<a href="http://viewcvs.sf.net/license-1.html">License</a><br />
</td><td colspan="2">
<p><strong>ViewCVS</strong> is a WWW interface for CVS and Subversion repositories.
You can browse the
file hierarchy by picking directories (which have slashes after
them, <em>e.g.</em>, <strong>src/</strong>). If you pick a file, you will see
the revision history for that file. Selecting a revision number
will display that revision of the file. There is a link at each
revision to display diffs between that revision and the previous
one, and a form at the bottom of the page that allows you to
display diffs between arbitrary revisions.
</p>
<h3>ViewCVS History and Credits</h3>
<p>
This program
(<a href="http://viewcvs.sourceforge.net/">ViewCVS</a>)
has been written by Greg Stein
&lt;<a href="mailto:gstein@lyra.org">gstein@lyra.org</a>&gt;
based on the
<a href="http://linux.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi">cvsweb</a>
script by Henner Zeller
&lt;<a href="mailto:zeller@think.de">zeller@think.de</a>&gt;;
it is covered by the
<a href="http://www.opensource.org/licenses/bsd-license.html">BSD-License</a>.
If you would like to use this CGI script on your own web server and
CVS tree, see Greg's
<a href="http://viewcvs.sourceforge.net/">ViewCVS&nbsp;distribution&nbsp;site</a>.
Please send any suggestions, comments, etc. to the
<a href="mailto:viewcvs-dev@lyra.org">ViewCVS&nbsp;Developers&nbsp;Mailinglist</a>.
</p>
<p><em>ViewCVS</em> is a WWW interface for CVS and Subversion
repositories. It allows you to browse the files and directories in a
repository while showing you metadata from the repository history: log
messages, modification dates, author names, revision numbers, copy
history, and so on. It provides several different views of repository
data to help you find the information you are looking for:</p>
<h3>Documentation about CVS</h3>
<ul>
<li><a href="help_dirview"><strong>Directory View</strong></a> - Shows
a list of files and subdirectories in a directory of the repository,
along with metadata like author names and log entries.</li>
<li><a href="help_log.html"><strong>Log View</strong></a> - Shows a
revision by revision list of all the changes that have made to a
file or directory in the repository, with metadata and links to views
of each revision.</li>
<li><strong>File Contents View (Markup View)</strong> - Shows the
contents of a file at a particular revision, with revision information
at the top of the page. File revisions which are GIF, PNG, or JPEG
images are displayed inline on the page. Other file types are
displayed as marked up text. The markup may be limited to turning URLs
and email addresses into links, or configured to show colorized source
code.</li>
<li><strong>File Download (Checkout View)</strong> - Retrieves the
unaltered contents of a file revision. Browsers may try to display
the file, or just save it to disk.</li>
<li><strong>File Annotate View</strong> - Shows the contents of a file
revision and breaks it down line by line, showing the revision number
where each one was last modified, along with links and other
information. <em>This view is disabled in some ViewCVS
configurations</em></li>
<li><strong>File Diff View</strong> - Shows the changes made between
two revisions of a file</li>
<li><strong>Directory Tarball View</strong> - Retrieves a gzipped tar
archive containing the contents of a directory.<em>This view is
disabled in the default ViewCVS configuration.</em></li>
<li><strong>Directory Query View</strong> - Shows information about
changes made to all subdirectories and files under a parent directory,
sorted and filtered by criteria you specify.<em>This view is
disabled in the default ViewCVS configuration.</em></li>
<li><strong>Revision View</strong> - Shows information about a
revision including log message, author, and a list of changed paths.
<em>For Subversion repositories only.</em></li>
<li><strong>Graph View</strong> - Shows a graphical representation
of a file's revisions and branches complete with tag and author
names and links to markup and diff pages. <em>For CVS repositories
only, and disabled in the default configuration.</em></li>
</ul>
<h3>ViewCVS and Multiple Repositories</h3>
<p>A single installation of ViewCVS is often used to provide access to
more than one repository. In these installations, ViewCVS shows a
<em>Project Root</em> drop down box in the top right corner of every
generated page to allow for quick switching between repositories.</p>
<h3>More Information</h3>
<p>More information about <em>ViewCVS</em> is available from
<a href="http://viewcvs.sourceforge.net/">viewcvs.sourceforge.net</a>.
See the links below for guides to CVS and Subversion</p>
<h4>Documentation about CVS</h3>
<blockquote>
<p>
<a href="http://cvsbook.red-bean.com/">Karl Fogel's CVS book</a><br />
@ -73,7 +113,7 @@
</p>
</blockquote>
<h3>Documentation about Subversion</h3>
<h4>Documentation about Subversion</h3>
<blockquote>
<p>
<a href="http://svnbook.red-bean.com/">Subversion: the Definitive Guide</a><br />