[hibernate-issues] [Hibernate-JIRA] Commented: (HSEARCH-1014) Write documentation for spatial indexing and queries

[Sanne Grinovero (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HSEARCH-1014?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=44699#comment-44699 ] 

Sanne Grinovero commented on HSEARCH-1014:
------------------------------------------

Yes we use docbook, you can find the sources in
{code}hibernate-search-documentation/src/main/docbook/en-US/{code}

You can find some free docbook editors, but personally I've learned the tags by looking at existing paragraphs and I prefer to edit the XML directly; AFAIR Hardy uses XMLMind.
This is my favourite script to check my edits are being built/rendered correctly:
{code}pushd hibernate-search-documentation
mvn org.jboss.maven.plugins:maven-jdocbook-plugin:2.2.3:translate org.jboss.maven.plugins:maven-jdocbook-plugin:2.2.3:resources org.jboss.maven.plugins:maven-jdocbook-plugin:2.2.3:generate
firefox ./target/docbook/publish/en-US/html_single/index.html
popd
{code}
When satisfied with the html rendering, I usually give a look to how PDF is looking as well.

> Write documentation for spatial indexing and queries
> ----------------------------------------------------
>
>                 Key: HSEARCH-1014
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HSEARCH-1014
>             Project: Hibernate Search
>          Issue Type: Sub-task
>          Components: query
>            Reporter: Emmanuel Bernard
>            Assignee: Nicolas Helleringer
>
> Both a how to and an explanation on the benchmark for grid vs boolean query.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira