chenpu wrote: > Hi Evan, > > Beside the search function, Command Assistant Client App also provides > some other features, for example "clip board". User can save their > desired contents into "clip board" and write comments on them, and then > those contents can be reviewed off-line anytime. > Well, I don't mean to differ this case, but if possible, it might be good to have a web based client as well, so that I can access the service even without a Solaris environment at hand.
Thanks, -Evan > Regards, > Jeffrey > > Evan Yan ??: > >> What's the consideration of choosing a Java based client other than a >> web based client? >> >> Thanks, >> -Evan >> >> Yong Young Sun wrote: >> >> >>> Template Version: @(#)sac_nextcase %I% %G% SMI >>> This information is Copyright 2008 Sun Microsystems >>> 1. Introduction >>> 1.1. Project/Component Working Name: >>> Command Assistant >>> 1.2. Name of Document Author/Supplier: >>> Author: Pu Chen >>> 1.3 Date of This Document: >>> 15 December, 2008 >>> >>> 2. Project Summary >>> 2.1. Project Description: >>> OpenSolaris has great technology. OpenSolaris has better set >>> of documentation than Linux distributions in general. However, >>> the information access is not always straightforward. >>> >>> 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. >>> >>> 2.2. Risks and Assumptions: >>> n/a >>> >>> 4. Technical Description >>> 4.1. 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.org. >>> >>> 4.2. Bug/RFE Number(s): >>> None >>> >>> 4.3. In Scope: >>> Sun managered documents. >>> >>> 4.4. Out of Scope: >>> N/A >>> >>> 4.5. Interfaces: >>> Client Interfaces: All of the following interfaces are marked >>> as "Committed" >>> >>> /usr/bin/commandassistant >>> /usr/lib/commandassistant/CommnadAssistant.jar >>> /usr/lib/commandassistant/lib/jaxb-api.jar >>> /usr/lib/commandassistant/lib/sjsxp.jar >>> /usr/lib/commandassistant/lib/jsr173_api.jar >>> /usr/lib/commandassistant/lib/jaxws-api.jar >>> /usr/lib/commandassistant/lib/jsr250-api.jar >>> /usr/lib/commandassistant/lib/FastInfoset.jar >>> /usr/lib/commandassistant/lib/jaxb-xjc.jar >>> /usr/lib/commandassistant/lib/streambuffer.jar >>> /usr/lib/commandassistant/lib/jaxws-rt.jar >>> /usr/lib/commandassistant/lib/http.jar >>> /usr/lib/commandassistant/lib/saaj-api.jar >>> /usr/lib/commandassistant/lib/jsr181-api.jar >>> /usr/lib/commandassistant/lib/jaxws-tools.jar >>> /usr/lib/commandassistant/lib/saaj-impl.jar >>> /usr/lib/commandassistant/lib/stax-ex.jar >>> /usr/lib/commandassistant/lib/jaxb-impl.jar >>> /usr/lib/commandassistant/lib/activation.jar >>> >>> WebServices Interface: "Committed" >>> http://ww.opensolaris.org/commandassistant/service?wsdl >>> >>> 4.6. Doc Impact: >>> None >>> >>> 4.7. Admin/Config Impact: >>> None >>> >>> 4.8. HA Impact: >>> None >>> >>> 4.9. I18N/L10N Impact: >>> The client application is i18ned, and it supports multi-languages. >>> >>> 4.10. Packaging & Delivery: >>> >>> SERVER SIDE COMPONENTS VERSION LICENSE TERMS >>> ----------------------------------------------------------- >>> Assistant Tool Web Service 1.0.0 CDDL >>> Apache Lucene 2.4.0 2.4.0 Apache LicenseV2.0 >>> >>> Server side components will be hosted on OpenSolaris.org. >>> CommandAssistantWebService.war >>> >>> CLIENT SIDE COMPONENTS VERSION LICENSE TERMS >>> ----------------------------------------------------------- >>> Assistant Tool Client 1.0.0 CDDL >>> >>> Client side components will be shipped with OpenSolairs in >>> OpenSolairs package repository. >>> >>> 4.11. Security Impact: >>> None >>> >>> 4.12. Dependencies: >>> * JDK 1.5+ >>> >>> 6. Resources and Schedule >>> 6.4. Steering Committee requested information >>> 6.4.1. Consolidation C-team Name: >>> Globalization >>> 6.5. ARC review type: FastTrack >>> 6.6. ARC Exposure: open >>> >>> >>> >>> >> >> > >
