Hi,
Currently we are working on the project setup for Command Assistant on
OpenSolaris.org. This project needs to be endorsed by 1i8n community. So
can I ask you help to review the project information attached below and
give an approval? Thanks.
Regars,
Jeffrey
* Project Name: Command Assistant
* Community Groups:
o Academic and Research
o Documentation
o Globalization
* Participants:
o Lead:
+ chenpu(pu.chen at sun.com)
o Others:
+ Christof(Christof.Pintaske at Sun.COM)
+ Shinobu(Shinobu.Matsuzuka at Sun.COM)
+ Yong Sun(Yong.sun at sun.com)
* Project Description
The purpose of this project (Command Assistant) is to provide
an easy access to OpenSolaris documentations manpages and javadoc
in the context of specific command usage to users.
The project information is available at:
https://global.sfbay.sun.com/twiki/bin/view/S3G/SearchTool
* Problem Area:
OpenSolaris has great technology. OpenSolaris has better set
of documentation than Linux distributions in general. However,
the information access is not always straightforward.
* Business Summary
By providing this service to the OpenSolaris users, we can
offer an easy information access to users. For example, when
a user is trying to figure out how to use "zpool" command,
he/she can find the exact use of zpool command examples
in the document with one single click from the desktop.
This would allow users better and easier way of learning
OpenSolaris technology, hence contributing to OpenSolaris
adoption. In adition, we can offer "sponsored links"
as well such that the users will have quicker access to
subscription and trainings.
* Technical Description:
Details:
Feature Description
---------------------------------------------------------------------
Solaris Command Search User can search Solaris Commands
Reverse Matching Search concept/topic to commands
Context Provide short description for each search
result
Multi-language support User can search in their languages
Classified information Search results are customized to different
categories
Manpage Search the Solaris manpages
Javadoc Search the Javadoc
------------ Interact ------------- ---------------
| Client APP | <==========> | Web Service | ----> | Lucene Engine |
------------ ------------- ---------------
| |
| --------------- |
--------------------
---> | Command Index | --->| Lucene
Index Files |
---------------
--------------------
Client Application
Java based GUI application. It interacts with server to get results.
Server side
Java based Web Service. It bases on Lucene engine to provides
matching
functions.
Command Assistant has the ability to parse the actual contents, that
means it knows,
* which is "command"
* which is "command descriptions"
* which is "examples of command"
* ....
The source(contents), that Command Assistant parsed/indexed, are not
only the html files. Those html documents published on docs.sun.com
were generated from SGML provided by IPG. Compare to the final html
file, SGML can provides us more informations. Please see the SGML
segment below,
--------------------------------------------------------
<title>Creating a Mirrored Storage Pool</title><para>To create a
mirrored pool, use the <literal>mirror</literal> keyword,followed
by any number of storage devices that will comprise the mirror.
Multiple mirrors can be specified by repeating the <literal>mirror
</literal> keyword on the command line. The following command creates
a pool with two, two-way mirrors:</para><screen># <userinput>zpool
create tank mirror c1d0 c2d0 mirror c3d0 c4d0</userinput>
</listitem><listitem><para>Capacity and reads can be monitored by
using the <command>zpool iostat</command>
-------------------------------------------------------
There are lots of useful markups in the SGML file, like <title>,
<userinput> and command. Before indexing the contents, Command
Assistant parsed those SGML files based on the markups.
The index files used by Lucene will be generated by automated scripts,
and then will be uploaded to OpenSolairs.com.
