[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gforge-commits] gforge/docs/docbook/docbook/user_guide/sitewide_functi
From: |
gsmet |
Subject: |
[Gforge-commits] gforge/docs/docbook/docbook/user_guide/sitewide_functions project_help.xml, NONE, 1.1 snippet.xml, NONE, 1.1 trove.xml, NONE, 1.1 index.xml, NONE, 1.1 search.xml, NONE, 1.1 |
Date: |
Tue, 02 Mar 2004 10:58:42 -0600 |
Update of
/cvsroot/gforge/gforge/docs/docbook/docbook/user_guide/sitewide_functions
In directory
db.perdue.net:/tmp/cvs-serv22607/docs/docbook/docbook/user_guide/sitewide_functions
Added Files:
project_help.xml snippet.xml trove.xml index.xml search.xml
Log Message:
converted doc from Maven xdoc to XML Docbook
--- NEW FILE: project_help.xml ---
<section id="ug_sitewide_project_help">
<title>Project Help</title>
<para>This feature allows users to search for help for their
projects.</para>
</section>
--- NEW FILE: snippet.xml ---
<section id="ug_sitewide_snippet">
<title>Snippet Library</title>
<para>
The Snippet Library function of gforge is very interesting; it
allows to collect all the type of information/knowledge which is not a complete
piece of code and which is usually difficult to organize/share.
</para>
<para>
A typical example are sophicistated shell commands, javascript
functions, perl one-liner, SQL expressions that perform special queries, an
algorithm, etc.
</para>
<section>
<title>Inserting a new snippet</title>
<para>
You can insert a new Snippet by clicking on the
<guimenuitem>Submit a New Snippet</guimenuitem> link.
</para>
<para>
A form appears, where the following information can be
inserted:
</para>
<variablelist>
<varlistentry>
<term>Title</term>
<listitem>
<para>Insert the title of the snippet.
This will be displayed in the list of the snippets.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description</term>
<listitem>
<para>Insert the description of the
snippet. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>Type</term>
<listitem>
<para>Select the type of the snippet:
function, full script, Howto, class, Readme.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>License</term>
<listitem>
<para>Select the license you want to
use for your snippet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Language</term>
<listitem>
<para>Select the language of the
snippet (if it is language dependant).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Category</term>
<listitem>
<para>Classify your snippet in
categories tree.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Version</term>
<listitem>
<para>You should insert here the
version of the snippet. For a new snippet, insert 1.0.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Code</term>
<listitem>
<para>Paste here the code of the
snippet.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>Browsing snippets</title>
<para>
You can browse snippets by clicking the
<guimenuitem>Browse</guimenuitem> link.
</para>
<para>
You can browse snippets by Language or by Category. The
resulting table shows the list of all snippets of the Language/Category. You
can click on the snippet number to view the detail of the snippet.
</para>
</section>
<section>
<title>Modifying a snippet</title>
<para>
You cannot modify an existing snippet, but you can add
a new version of the snippet by clicking on the Submit a new version link on
the bottom part of the detail page of the snippet.
</para>
<para>
Adding a new version does not delete the old version,
all previous versions will be available.
</para>
</section>
</section>
--- NEW FILE: trove.xml ---
<section id="ug_sitewide_trove">
<title>Trove map</title>
<para>This allows users to classify their projects in a tree so that
they can be found more easily.</para>
</section>
--- NEW FILE: index.xml ---
<section>
<title>Site-wide functions</title>
<section>
<title>Introduction</title>
<para>
The side-wide functions are available anytime, they are
not dependent on the single projects.
</para>
<para>
The site-wide functions handle data that are not
relevant to a single project, as code fragments, project classification,
project helps, etc.
</para>
<para>
The single site-wide functions available to the users
are:
</para>
<itemizedlist>
<listitem><para>Project help</para></listitem>
<listitem><para>Search</para></listitem>
<listitem><para>Snippet Library</para></listitem>
<listitem><para>Trove map</para></listitem>
</itemizedlist>
</section>
<xi:include href="search.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="trove.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
<xi:include href="snippet.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="project_help.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
--- NEW FILE: search.xml ---
<section id="ug_sitewide_search">
<title>Searching in gforge</title>
<para>
You can search in gforge for the following arguments:
</para>
<variablelist>
<varlistentry>
<term>People</term>
<listitem>
<para>You can search for login name or the
complete username. The search is not case sensitive. Inserted text must be at
least 3 characters.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Software/Group</term>
<listitem>
<para>You can search for software groups.
Inserted text must be at least 3 characters.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Skill</term>
<listitem>
<para>You can search for skills inserted by the
users. Only public skills profiles can be searched. Inserted text must be at
least 3 characters.</para>
</listitem>
</varlistentry>
</variablelist>
<para>
You can search for People or Software groups by selecting the
item in the combo box and inserting the search text in the text box.
</para>
<para>
If the user is inside one of the Trackers, a voice Tracker
appears in the combo box.
</para>
<para>
If the user is inside a forum, a voice Forum appears in the
combo box.
</para>
</section>
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gforge-commits] gforge/docs/docbook/docbook/user_guide/sitewide_functions project_help.xml, NONE, 1.1 snippet.xml, NONE, 1.1 trove.xml, NONE, 1.1 index.xml, NONE, 1.1 search.xml, NONE, 1.1,
gsmet <=