{% block title %}{% endblock %}

{% block body %}{% endblock %}

{% block sidebar %}{% endblock %}

{% block relbar2 %}{% endblock %} {%- block footer %} {%- endblock %} -------------- web.pyを作成 -------------- さて、先ほど作成したのはDBを作るbuild部分でしたので、次に実際のWebアプリ部分を作ります。今回はflaskを使いました。 :: #### sphinx part. same as build.py from sphinx.websupport import WebSupport from sphinx.websupport.errors import DocumentNotFoundError ROOT = '/Absolute/Path/To/Your/Document' SRCDIR = ROOT+'/source' BUILDDIR = ROOT+'/build/web' support = WebSupport(SRCDIR, BUILDDIR) #### flask part from flask import Flask, render_template, abort, g, request, jsonify from jinja2 import Environment, FileSystemLoader app = Flask(__name__) # app.debug = True # デバッグ用フラグ app.jinja_env = Environment(loader = FileSystemLoader("_templates/"), extensions=['jinja2.ext.i18n']) app.root_path = BUILDDIR @app.route('/') def index(docname): try: document = support.get_document(docname) except DocumentNotFoundError: abort(404) return render_template('doc.html', document=document) app.jinja_envとかapp.root_pathとかにハマったりしました。もうちょっとうまいやり方があるのかとは思いますがよく分かりません。識者に聞きたいところです。 ------------------ ディレクトリ構成 ------------------ 最終的に以下のようなディレクトリ構成になりました。 :: - ROOT - Makefile - build.py - web.py - _template/ - doc.html - base.html - source/ - conf.py - index.rst - .. - build/ - web <-- build.pyによって自動的に作られる -------------- えいやと実行 -------------- web.pyを実行すると、 :: % python web.py * Running on http://127.0.0.1:5000/ * Restarting with reloader... とか出てくるので、 `http://127.0.0.1:5000/index` とかにアクセスしてみます。index.rstに書いてない人は適当に変えてくださいね。ちゃんと表示された人、おめでとうございます！問題が起きた人、app.debugをTrueにしたりしてなんとかしてください。 -------------------- コメント機能の追加 -------------------- これだけだとなんなんで、WebSupportの特徴である段落ごとにコメントが付けられる機能を追加します。 web.pyに以下の部分を追記します。 :: @app.route('/_add_comment', methods=['POST']) def add_comment(): parent_id = request.form.get('parent', '') node_id = request.form.get('node', '') text = request.form.get('text', '') proposal = request.form.get('proposal', '') username = None print node_id, parent_id, text comment = support.add_comment(text, node_id=node_id, parent_id=parent_id, username=username, proposal=proposal) return jsonify(comment=comment) @app.route('/_get_comments') def get_comments(): username = None node_id = request.args.get('node', '') data = support.get_data(node_id, username=username) return jsonify(**data) build.pyで作成されるwebsupport.jsが"_get_comments"や"_add_comment"というURLにアクセスしてきますので、それに対応したコメント追加機能を提供します。本当はユーザ名で識別したり、モデレーターによるコメントの削除や提案の受理なんかができるんですけど、今回はめんどいので見送ります。表示されてるdeleteとかacceptとかいう文字はそういう提案の受理なんかに使われるようです。 ---------- 検索機能 ---------- WebSupportは `Xpian `_ や `Whoosh `_ を使った検索が出来ます。このうちpure pythonなWhooshを使ってみます。事前にWhooshを使えるようにしておいてください。 build.pyとweb.pyで、WebSupportの引数に"search"として使いたい検索エンジンの名前を付け加えます。 :: support = WebSupport(SRCDIR, BUILDDIR, search='whoosh') web.pyに、検索機能で飛んできた時の処理を付け加えます。 :: @app.route('/search/') def search(): q = request.args.get('q') document = support.get_search_results(q) return render_template('doc.html', document=document) また、ハイライト処理のために、ドキュメントの表示時の動作を以下の関数に差し替えます。 :: @app.route('//') # http://127.0.0.1/index/?highlight= @app.route('/') def index(docname): try: h = request.args.get('highlight', '') if (h): document = support.get_document(docname.rstrip('/')) # delete last "/" document['body'].replace(h, ''+h+'') else: document = support.get_document(docname) except DocumentNotFoundError: abort(404) return render_template('doc.html', document=document) で、こうしておいてから検索ボックスで検索すると、結果が出てきて、クリックするとハイライト表示になります。良かったですね！ … あれ？日本語は…？検索できたり出来なかったり、というか出来ないほうが多いようです。どうやらWebSupportのWhooshを使う部分ではインデックスを作る方式がStemmingAnalyzerという、英語の語幹を利用する方式に決め打たれているようです。というわけで、アドホックな解決法として、N-gramに決め打つパッチを当てます。ちなみに、このパッチではデフォルトのminsize=2, maxsize=4 なN-gramが出来上がります。このあたり、本当はconf.pyに書くことで切り替えられるようにするべきでしょうね。 :: diff -urN sphinx.orig/sphinx/websupport/search/whooshsearch.py sphinx/sphinx/websupport/search/whooshsearch.py --- sphinx.orig/sphinx/websupport/search/whooshsearch.py 2010-12-10 23:24:08.000000000 +0900 +++ sphinx/sphinx/websupport/search/whooshsearch.py 2010-12-10 23:14:32.000000000 +0900 @@ -10,9 +10,10 @@ """ from whoosh import index -from whoosh.fields import Schema, ID, TEXT +from whoosh.fields import Schema, ID, TEXT, NGRAM from whoosh.qparser import QueryParser -from whoosh.analysis import StemmingAnalyzer +# from whoosh.analysis import StemmingAnalyzer +from whoosh.analysis import NgramAnalyzer from sphinx.util.osutil import ensuredir from sphinx.websupport.search import BaseSearch @@ -24,7 +25,7 @@ # Define the Whoosh Schema for the search index. schema = Schema(path=ID(stored=True, unique=True), title=TEXT(field_boost=2.0, stored=True), - text=TEXT(analyzer=StemmingAnalyzer(), stored=True)) + text=NGRAM(stored=True)) def __init__(self, db_path): ensuredir(db_path) この後、build.pyを再び実行すれば、快適な検索が出来ます。やったね！あ、そうそう、N-gramに変更したことにより、出来上がるDBのサイズがかなり大きくなりますのでご注意を。 ----- 注意 ----- WebSupportはまだ発展途上です。今後大幅に変わる可能性もありますので、その点に留意してお使いください。

Navigation