vitalif
/
viewvc-4intranet
mirror of https://github.com/vitalif/viewvc-4intranet
1
0
Fork 0
Code Issues Releases Wiki Activity

More documentation updates 

* templates/docroot/help_rootview.html
* templates/docroot/help_dirview.html
* templates/docroot/help_log.html
    updated

* templates/docroot/help_logtable.html
    removed


git-svn-id: http://viewvc.tigris.org/svn/viewvc/trunk@1155 8cb11bc2-c004-0410-86c3-e597b4017df7
remotes/tags/1.0.0-rc1
rey4 2005-11-09 15:34:25 +00:00
parent 8bba165888
commit 8aa47a94e9
4 changed files with 212 additions and 163 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
templates/docroot/help_dirview.html
View File

@ -21,9 +21,7 @@
<h3>Help</h3>
<a href="help_rootview.html">General</a><br />
<strong>Directory&nbsp;View</strong><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 />
<a href="help_log.html">Log&nbsp;View</a><br />
<h3>Internet</h3>
<a href="http://viewcvs.sf.net/index.html">Home</a><br />
@ -31,26 +29,102 @@
<a href="http://viewcvs.sf.net/contributing.html">Contributing</a><br />
<a href="http://viewcvs.sf.net/license-1.html">License</a><br />
</td><td colspan="2">
<p>
Click on a directory to enter that directory. Click in the leftmost
column of a row to display the revision history of a file and to get
a chance to display diffs between revisions. Click on second column
to view the content of the latest revision of that file.
</p>
<p>
Directories are always displayed first in alphabetically order.
Ordinary files follow and are sorted according to the selected
sort criteria. You may click on a particular column header to
select this column as sort criteria. It is than displayed in
another color (e.g. light green, if using the default configuration).
</p>
<p>The directory listing view should be a familiar sight to any
computer user. It shows the path of the current directory being viewed
at the top of the page. Below that is a table summarizing the
directory contents, and then comes actual contents, a sortable list of
all files and subdirectories inside the current directory.</p>
<p><a name="summary"></a>The summary table is made up of some or all
of the following rows:</p>
<ul>
<li><a name="summary-files-shown"><strong>Files Shown</strong></a>
- Number of files shown in the directory listing. This might be less
than the actual number of files in the directory if a
<a href="#option-search">regular expression search</a> is in place,
hiding files which don't meet the search criteria. In CVS directory
listings, this row will also have a link to toggle display of
<a href="help_rootview.html#dead-files">dead files</a>, if any are
present.</li>
<li><a name="summary-revision"><strong>Directory
Revision</strong></a> - For Subversion directories only.
Shown as "# of #" where the first number is the most recent
repository revision where the directory (or a path underneath it)
was modified. The second number is just the latest repository
revision. Both numbers are links to
<a href="help_rootview.html#view-rev">revision views</a></li>
<li><a name="summary-sticky-revision-tag"><strong>Sticky
Revision/Tag</strong></a> - shows the current
<a href="help_rootview.html#sticky-revision-tag">sticky revision or
tag</a> and contains form fields to set or clear it.</li>
<li><a name="summary-search"><strong>Current Search</strong></a> -
If a <a href="#option-search">regular expression search</a> is in place,
shows the search string.</li>
<li><a name="summary-query"><strong>Query</strong></a> - Provides
a link to a <a href="help_rootview.html#view-query">query form</a>
for the directory</li>
</ul>
<p><a name="list"></a>The actual directory list is a table with
filenames and directory names in one column and information about the
most recent revisions where each file or directory was modified in the
other columns. Column headers can be clicked to sort the directory
entries in order by a column, and clicked again to reverse the sort
order.</p>
<p>
<!-- If using directory.ezt template -->
File names are links to <a href="help_log.html">log views</a>
showing a list of revisions where a file was modified. Revision
numbers are links to either
<a href="help_rootview.html#view-markup">view</a>
or <a href="help_rootview.html#view-checkout">download</a> a file
(depending on its file type). The links are reversed for directories.
Directory revision numbers are links to <a href="help_log.html">log
views</a>, while directory names are links showing the contents of those
directories.
<!-- If using dir_alt.ezt template -->
<!--
File and directory names are links to retrieve their contents.
File links may be either
<a href="help_rootview.html#view-markup">view</a>
or <a href="help_rootview.html#view-download">download</a> links
depending on the file type. Directory links go to directory
listings. Revision numbers are links to <a href="help_log.html">log
views</a> showing lists of revisions where a file or directory was
modified.
-->
Also, in CVS repositories with the
<a href="help_rootview.html#view-graph">graph view</a> enabled, there
will be small
<img src="images/cvsgraph_16x16.png" width="16" height="16" alt="graph">
icons next to file names which are links to revision graphs.</p>
<p>Depending on how ViewCVS is configured, there may be more options
at the bottom of directory pages:</p>
<ul>
<li><a name="option-search"><strong>Regular expression
search</strong></a> - If enabled, will show a form field accepting
a search string (a
<a href="http://doc.python.org/lib/re-syntax.html">python regular
expression</a>). Once submitted, only files that have at least
one occurance of the expression will show up in directory listings.
</li>
<li><a name="option-tarball"><strong>Tarball download</strong></a> -
If enabled, will show a link to download a gzipped tar archive of
the directory contents.</li>
</ul>
</td></tr></table>
<hr />
<address><a href="mailto:viewcvs-dev@lyra.org">ViewCVS Group</a></address>
<!-- Created: Thu Oct 25 22:08:29 CEST 2001 -->
<!-- hhmts start -->
<p>Last modified: Tue Nov 13 20:40:02 CEST 2001</p>
<!-- hhmts end -->
</body>
</html>

56
templates/docroot/help_log.html
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: Classic Log View</title>
<title>ViewCVS Help: Log View</title>
<link rel="stylesheet" href="help.css" type="text/css" />
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
</head>
@ -15,16 +15,14 @@
src="images/logo.png" alt="ViewCVS logotype" /></a>
</td>
<td>
<h1>ViewCVS Help: Classic Log View</h1>
<h1>ViewCVS Help: Log View</h1>
</td>
</tr>
<tr><td>
<h3>Help</h3>
<a href="help_rootview.html">General</a><br />
<a href="help_dirview.html">Directory&nbsp;View</a><br />
<strong>Classic&nbsp;Log&nbsp;View</strong><br />
<a href="help_logtable.html">Alternative&nbsp;Log&nbsp;View</a><br />
<a href="help_query.html">Query&nbsp;Database</a><br />
<strong>Log&nbsp;View</strong><br />
<h3>Internet</h3>
<a href="http://viewcvs.sf.net/index.html">Home</a><br />
@ -34,33 +32,43 @@
</td><td colspan="2">
<p>
The log view displays the revision history of the selected source
file. For each revision the following information is displayed:
</p>
file or directory. For each revision the following information is
displayed:
<ul>
<li>the revision number (clickable to download it)</li>
<li>a link to view this revision annotated</li>
<li>a link to select this revision for diffs (see below)</li>
<li>the date and age of this change</li>
<li>and the author of this modification.</li>
<li>The CVS branch (usually <code>MAIN</code>, if not on a branch).</li>
<li>Possibly a list of CVS tags bound to this revision (if any).</li>
<li>The size of this change measured in added and removed lines of
code.</li>
<li>Links to view Diffs to the previous revision or possibly to
an arbitrary selected revision (if any, see above).</li>
<li>The revision number. In Subversion repositories, this is a
link to the <a href="help_rootview.html#view-rev">revision
view</a></li>
<li>For files, links to
<a href="help_rootview.html#view-markup">view</a>,
<a href="help_rootview.html#view-checkout">download</a>, and
<a href="help_rootview.html#view-annotate">annotate</a> the
revision. For directories, a link to
<a href="help_dirview.html">list directory contents</a></li>
<li>A link to select the revision for diffs (see below)</li>
<li>The date and age of the change</li>
<li>The author of the modification</li>
<li>The CVS branch (usually <em>MAIN</em>, if not on a branch)</li>
<li>Possibly a list of CVS tags bound to the revision (if any)</li>
<li>The size of the change measured in added and removed lines of
code. (CVS only)</li>
<li>The size of the file in bytes at the time of the revision
(Subversion only)</li>
<li>Links to view diffs to the previous revision or possibly to
an arbitrary selected revision (if any, see above)</li>
<li>If the revision is the result of a copy, the path and revision
copied from</li>
<li>If the revision precedes a copy or rename, the path at the
time of the revision</li>
<li>And last but not least, the commit log message which should tell
about the reason for this change.</li>
about the reason for the change.</li>
</ul>
<p>
At the bottom of such a page you will find a form which allows
At the bottom of the page you will find a form which allows
to request diffs between arbitrary revisions.
</p>
</td></tr></table>
<hr />
<address><a href="mailto:viewcvs-dev@lyra.org">ViewCVS Group</a></address>
<!-- Created: Thu Oct 25 22:08:29 CEST 2001 -->
<!-- hhmts start -->
<p>Last modified: Wed Dec 12 13:56:52 CET 2001</p>
<!-- hhmts end -->
</body>
</html>

67
templates/docroot/help_logtable.html
View File

@ -1,67 +0,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>ViewCVS Help: Log Table View</title>
<link rel="stylesheet" href="help.css" type="text/css" />
</head>
<body>
<table>
<col class="menu" />
<col />
<tr>
<td><a href="http://viewcvs.sf.net/index.html"><img
src="images/logo.png" alt="ViewCVS logotype" /></a>
</td>
<td>
<h1>ViewCVS Help: Log Table View</h1>
</td>
</tr>
<tr><td>
<h3>Help</h3>
<a href="help_rootview.html">General</a><br />
<a href="help_dirview.html">Directory&nbsp;View</a><br />
<a href="help_log.html">Classic&nbsp;Log&nbsp;View</a><br />
<strong>Alternative&nbsp;Log&nbsp;View</strong><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 />
<a href="http://viewcvs.sf.net/upgrading.html">Upgrading</a><br />
<a href="http://viewcvs.sf.net/contributing.html">Contributing</a><br />
<a href="http://viewcvs.sf.net/license-1.html">License</a><br />
</td><td colspan="2">
<p>
The table based log view must be enabled in the site wide
ViewCVS configuration file.
</p>
<p>
It displays the revision history of the selected source
file in a table containing the following columns:
</p>
<ul>
<li><strong>Revision</strong>: The revision number.</li>
<li><strong>Tasks</strong>: This column contains several links to view
a revision.</li>
<li><strong>Diffs</strong>: Several links to view the changes between this
and other revisions.</li>
<li><strong>Branches and Tags</strong>: Displays the branch and a pulldown
menu button displaying all tags bound to that revision</li>
<li><strong>Age:</strong>The revision's check in-time</li>
<li><strong>Author:</strong>The revision's author</li>
<li><strong>Log:</strong>Log message describing the changes made in the
revision</li>
</ul>
<p>
At the bottom of such a page you will find a form which allows
to request diffs between arbitrary revisions.
</p>
</td></tr></table>
<hr />
<address><a href="mailto:viewcvs-dev@lyra.org">ViewCVS Group</a></address>
<!-- Created: Thu Oct 25 22:08:29 CEST 2001 -->
<!-- hhmts start -->
<p>Last modified: Sat Dec 8 23:26:52 CET 2001</p>
<!-- hhmts end -->
</body>
</html>

136
templates/docroot/help_rootview.html
View File

@ -21,8 +21,7 @@
<h3>Help</h3>
<strong>General</strong><br />
<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_log.html">Log&nbsp;View</a><br />
<h3>Internet</h3>
<a href="http://viewcvs.sf.net/index.html">Home</a><br />
@ -30,7 +29,7 @@
<a href="http://viewcvs.sf.net/contributing.html">Contributing</a><br />
<a href="http://viewcvs.sf.net/license-1.html">License</a><br />
</td><td colspan="2">
<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
@ -39,63 +38,104 @@
data to help you find the information you are looking for:</p>
<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 name="view-dir" href="help_dirview.html"><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><a name="view-log" 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><a name="view-markup"><strong>File Contents View (Markup
View)</strong></a> - 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><a name="view-checkout"><strong>File Download (Checkout
View)</strong></a> - 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><a name="view-annotate"><strong>File Annotate View</strong></a> -
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><a name="view-diff"><strong>File Diff View</strong></a> - 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><a name="view-tarball"><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>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><a name="view-query"><strong>Directory Query View</strong></a> -
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>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>
<li><a name="view-rev"><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><a name="view-graph"><strong>Graph View</strong></a> - 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>
<h3><a name="multiple-repositories">Multiple Repositories</a></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>
generated page to allow for quick access to any repository.</p>
<h3>More Information</h3>
<h3><a name="sticky-revision-tag">Sticky Revision and Tag</a></h3>
<p>By default, ViewCVS will show the files and directories and revisions
that currently exist in the repository. But it's also possible to browse
the contents of a repository at a point in its past history by choosing
a "sticky tag" (in CVS) or a "sticky revision" (in Subversion) from the
forms at the top of directory and log pages. They're called sticky
because once they're chosen, they stick around when you navigate to
other pages, until you reset them. When they're set, directory and log
pages only show revisions preceding the specified point in history. In
CVS, when a tag refers to a branch or a revision on a branch, only
revisions from the branch history are shown, including branch points and
their preceding revisions.</p>
<h3><a name="dead-files">Dead Files</a></h3>
<p>In CVS directory listings, ViewCVS can optionally display dead files.
Dead files are files which used to be in a directory but are currently
deleted, or files which just don't exist in the currently selected
<a href="#sticky-revision-tag">sticky tag</a>. Dead files cannot be
shown in Subversion repositories. The only way to see a deleted file in
a Subversion directory is to navigate to a sticky revision where the
file previously existed.</p>
<h3><a name="artificial-tags">Artificial Tags</a></h3>
<p>In CVS Repositories, ViewCVS adds artificial tags <em>HEAD</em> and
<em>MAIN</em> to tag listings and accepts them in place of revision
numbers and real tag names in all URLs. <em>MAIN</em> acts like a branch
tag pointing at the default branch, while <em>HEAD</em> acts like a
revision tag pointing to the latest revision on the default branch. The
default branch is usually just the trunk, but may be set to other
branches inside individual repository files. CVS will always check out
revisions from a file's default branch when no other branch is specified
on the command line.</p>
<h3><a name="more-information">More Information</a></h3>
<p>More information about <em>ViewCVS</em> is available from
<a href="http://viewcvs.sourceforge.net/">viewcvs.sourceforge.net</a>.
@ -122,14 +162,8 @@
</p>
</blockquote>
<!-- insert repository access instructions here -->
</td></tr></table>
<hr />
<address><a href="mailto:viewcvs-dev@lyra.org">ViewCVS Group</a></address>
<!-- Created: Thu Oct 25 22:16:29 CEST 2001 -->
<!-- hhmts start -->
<p>Last modified: Tue Nov 13 20:41:02 CEST 2001</p>
<!-- hhmts end -->
</body>
</html>