Commit 75d124d6 authored by Antoine Beaupré's avatar Antoine Beaupré

update status

parent 1e1b6d56
......@@ -107,16 +107,23 @@ The search interface itself would be a CGI or WSGI tool (if written in
Python) interface that would hook into the webserver to perform
searches.
Currently only a browser-based, Javascript search tool implements basic
``whatis(1)`` functionality. It looks up the manpage using a
Originally, only a browser-based Javascript search tool implemented basic
``whatis(1)`` functionality. It looked up the manpage using a
`XMLHttpRequest <https://en.wikipedia.org/wiki/XMLHttpRequest>`__ to see
if the requested page exists and redirects appropriately. It doesn't
look at different locales yet. A prototype of a CGI-based approach was
written in `Flask`_, see the :ref:`framework` section for more
information about that choice.
if the requested page exists and redirects appropriately. It didn't
look at different locales yet.
A prototype of a CGI-based approach was then written in `Flask`_. The
search engine will look at the filesystem for a given pattern and,
optionnally, section, suite and locale parameters. It doesn't show all
suites by default and prefers to show all matching manpages, behaving
like a *names-only* ``apropos(1)``.
See the :ref:`framework` section for more information about the
decision to use Flask..
This should be extended to a full search interface, using ``omega``'s
web interface or other pluggable interfaces.
web interface or another pluggable interfaces.
Software evaluation
-------------------
......
......@@ -43,10 +43,17 @@ important to implement to make this software complete.
- search functionality, in that order
1. whatis(1): find manpages by name (done with custom Javascript)
1. whatis(1): find manpages by name (done by Flask app)
2. apropos(1): find manpages by description
3. full text search
- i18n: we parse all languages, but should auto-detect the web
browser's language with fallbacks and everything. Apache
auto-negociation? Could be like debian.org language menus...
The trick is to guess the language list again, similar to the suites
issue. The new search box can lookup different locales in the
backend, but doesn't have the list of locales in the frontend.
Nice to have
------------
......@@ -73,9 +80,6 @@ Those are not really necessary but could improve the service.
- hook pyflakes in test suite (quality section)
- static code analysis with pylint (analysis section)
- i18n: we parse all languages, but should auto-detect the web
browser's language with fallbacks and everything. Apache
auto-negociation? Could be like debian.org language menus...
- embed test suite in main program
- consider a plugin system for extending to more than manpages, would
provide the default for ``--plugin``
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment