null+****@clear*****
null+****@clear*****
2011年 8月 12日 (金) 18:38:04 JST
Kouhei Sutou 2011-08-12 09:38:04 +0000 (Fri, 12 Aug 2011)
New Revision: d29da2850591202377f923fdd4d8ac449d536278
Log:
[doc][suggest] add a place holder for groonga-suggest-create-dataset.
Added files:
doc/source/executables/groonga-suggest-create-dataset.txt
Modified files:
doc/Makefile.am
doc/files.am
doc/source/suggest.txt
doc/source/suggest/completion.txt
doc/source/suggest/correction.txt
doc/source/suggest/suggestion.txt
Modified: doc/Makefile.am (+2 -0)
===================================================================
--- doc/Makefile.am 2011-08-12 06:51:43 +0000 (6b8104f)
+++ doc/Makefile.am 2011-08-12 09:38:04 +0000 (12d5e2c)
@@ -14,6 +14,8 @@ files.am: update-files.sh
update-files
update-files:
+ cd locale/en/LC_MESSAGES && $(MAKE) gettext
+ cd locale/en && $(MAKE) html
cd $(srcdir); ./update-files.sh > files.am
man pdf clean-html:
Modified: doc/files.am (+8 -0)
===================================================================
--- doc/files.am 2011-08-12 06:51:43 +0000 (409cdd1)
+++ doc/files.am 2011-08-12 09:38:04 +0000 (f958524)
@@ -43,6 +43,7 @@ absolute_source_files = \
$(top_srcdir)/doc/source/contribution/report.txt \
$(top_srcdir)/doc/source/example/completion-1.log \
$(top_srcdir)/doc/source/example/correction-1.log \
+ $(top_srcdir)/doc/source/example/suggestion-1.log \
$(top_srcdir)/doc/source/example/tutorial01-1.log \
$(top_srcdir)/doc/source/example/tutorial01-10.log \
$(top_srcdir)/doc/source/example/tutorial01-11.log \
@@ -105,6 +106,7 @@ absolute_source_files = \
$(top_srcdir)/doc/source/executables.txt \
$(top_srcdir)/doc/source/executables/grnslap.txt \
$(top_srcdir)/doc/source/executables/grntest.txt \
+ $(top_srcdir)/doc/source/executables/groonga-suggest-create-dataset.txt \
$(top_srcdir)/doc/source/executables/groonga.txt \
$(top_srcdir)/doc/source/executables/http.txt \
$(top_srcdir)/doc/source/expr.txt \
@@ -211,6 +213,7 @@ source_files_relative_from_doc_dir = \
source/contribution/report.txt \
source/example/completion-1.log \
source/example/correction-1.log \
+ source/example/suggestion-1.log \
source/example/tutorial01-1.log \
source/example/tutorial01-10.log \
source/example/tutorial01-11.log \
@@ -273,6 +276,7 @@ source_files_relative_from_doc_dir = \
source/executables.txt \
source/executables/grnslap.txt \
source/executables/grntest.txt \
+ source/executables/groonga-suggest-create-dataset.txt \
source/executables/groonga.txt \
source/executables/http.txt \
source/expr.txt \
@@ -469,6 +473,8 @@ html_files_relative_from_locale_dir = \
html/_sources/contribution/documentation/c-api.txt \
html/_sources/contribution/documentation/i18n.txt \
html/_sources/contribution/report.txt \
+ html/_sources/example/completion-1.log \
+ html/_sources/example/correction-1.log \
html/_sources/example/tutorial01-1.log \
html/_sources/example/tutorial01-10.log \
html/_sources/example/tutorial01-11.log \
@@ -531,6 +537,7 @@ html_files_relative_from_locale_dir = \
html/_sources/executables.txt \
html/_sources/executables/grnslap.txt \
html/_sources/executables/grntest.txt \
+ html/_sources/executables/groonga-suggest-create-dataset.txt \
html/_sources/executables/groonga.txt \
html/_sources/executables/http.txt \
html/_sources/expr.txt \
@@ -642,6 +649,7 @@ html_files_relative_from_locale_dir = \
html/executables.html \
html/executables/grnslap.html \
html/executables/grntest.html \
+ html/executables/groonga-suggest-create-dataset.html \
html/executables/groonga.html \
html/executables/http.html \
html/expr.html \
Added: doc/source/executables/groonga-suggest-create-dataset.txt (+50 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/executables/groonga-suggest-create-dataset.txt 2011-08-12 09:38:04 +0000 (fd523b1)
@@ -0,0 +1,50 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+groonga-suggest-create-dataset
+==============================
+
+NAME
+----
+
+groonga-suggest-create-dataset - Defines schema for a suggestion dataset
+
+SYNOPSTIS
+---------
+
+::
+
+ groonga-suggest-create-dataset [options] DATABASE DATASET
+
+DESCTIPION
+----------
+
+groonga-suggest-create-dataset creates a dataset for :doc:`/suggestion`. A database has many datasets. This command just defines schea for a suggestion dataset.
+
+OPTIONS
+-------
+
+None.
+
+EXIT STATUS
+-----------
+
+TODO
+
+FILES
+-----
+
+TODO
+
+EXAMPLE
+-------
+
+TODO
+
+SEE ALSO
+--------
+
+:doc:`/suggest`
+.. :doc:`groonga-suggest-httpd`
+.. :doc:`groonga-suggest-learner`
Modified: doc/source/suggest.txt (+1 -1)
===================================================================
--- doc/source/suggest.txt 2011-08-12 06:51:43 +0000 (6d3ad52)
+++ doc/source/suggest.txt 2011-08-12 09:38:04 +0000 (ca7406c)
@@ -5,7 +5,7 @@
Suggest
=======
-Groonga has suggest feature. This section describes how to use it and how it works.
+Groonga has the suggest feature. This section describes how to use it and how it works.
.. toctree::
:maxdepth: 2
Modified: doc/source/suggest/completion.txt (+1 -1)
===================================================================
--- doc/source/suggest/completion.txt 2011-08-12 06:51:43 +0000 (acaffdc)
+++ doc/source/suggest/completion.txt 2011-08-12 09:38:04 +0000 (7379717)
@@ -153,7 +153,7 @@ How to use
.. {"sequence": "1", "time": 1312950805.86057, "item": "engine", "type": "submit"}
.. ]
-Groonga provides :doc:`commands/suggest` command to use
+Groonga provides :doc:`/commands/suggest` command to use
completion. `--type complete` option requests completion.
For example, here is an command to get completion results by
Modified: doc/source/suggest/correction.txt (+4 -4)
===================================================================
--- doc/source/suggest/correction.txt 2011-08-12 06:51:43 +0000 (b19ae95)
+++ doc/source/suggest/correction.txt 2011-08-12 09:38:04 +0000 (be5cbbc)
@@ -101,7 +101,7 @@ How to use
.. {"sequence": "1", "time": 1312950810.86057, "item": "search", "type": "submit"}
.. ]
-Groonga provides :doc:`commands/suggest` command to use
+Groonga provides :doc:`/commands/suggest` command to use
completion. `--type correct` option requests corrections
For example, here is an command to get correction results by
@@ -127,9 +127,9 @@ user inputs the query with the following sequence:
3. 2011-08-10T13:33:24+09:00: sae
4. 2011-08-10T13:33:24+09:00: saer
5. 2011-08-10T13:33:24+09:00: saerc
- 5. 2011-08-10T13:33:25+09:00: saerch (submit!)
- 5. 2011-08-10T13:33:29+09:00: serch (correcting...)
- 6. 2011-08-10T13:33:30+09:00: search (submit!)
+ 6. 2011-08-10T13:33:25+09:00: saerch (submit!)
+ 7. 2011-08-10T13:33:29+09:00: serch (correcting...)
+ 8. 2011-08-10T13:33:30+09:00: search (submit!)
Groonga can be learned from the input sequence by the
following command::
Modified: doc/source/suggest/suggestion.txt (+1 -1)
===================================================================
--- doc/source/suggest/suggestion.txt 2011-08-12 06:51:43 +0000 (c253201)
+++ doc/source/suggest/suggestion.txt 2011-08-12 09:38:04 +0000 (bfb609e)
@@ -81,7 +81,7 @@ How to use
.. {"sequence": "1", "time": 1312950808.86057, "item": "web search realtime", "type": "submit"}
.. ]
-Groonga provides :doc:`commands/suggest` command to use
+Groonga provides :doc:`/commands/suggest` command to use
completion. `--type suggest` option requests suggestion
For example, here is an command to get completion results by