Lucene - Core
  1. Lucene - Core
  2. LUCENE-1876

Some contrib packages are missing a package.html

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.9
    • Component/s: modules/other
    • Labels:
      None
    • Lucene Fields:
      New

      Description

      Dunno if we will get to this one this release, but a few contribs don't have a package.html (or a good overview that would work as a replacement) - I don't think this is hugely important, but I think it is important - you should be able to easily and quickly read a quick overview for each contrib I think.

      So far I have identified collation and spatial.

      1. LUCENE-1876.patch
        22 kB
        Robert Muir
      2. LUCENE-1876.patch
        19 kB
        Robert Muir
      3. collation-package.html
        8 kB
        Steve Rowe

        Activity

        Hide
        Robert Muir added a comment -

        Committed revision 810923.

        thanks Steven!

        Show
        Robert Muir added a comment - Committed revision 810923. thanks Steven!
        Hide
        Robert Muir added a comment -

        added package.htmls for the two user-level spatial pkgs (tier and geohash)

        plan to commit this patch tomorrow.

        Show
        Robert Muir added a comment - added package.htmls for the two user-level spatial pkgs (tier and geohash) plan to commit this patch tomorrow.
        Hide
        Robert Muir added a comment -

        Mark, sure. I would absolutely love it if someone who has a good understanding of spatial could comment on what the packages do, I will create the html files and update the patch!

        Show
        Robert Muir added a comment - Mark, sure. I would absolutely love it if someone who has a good understanding of spatial could comment on what the packages do, I will create the html files and update the patch!
        Hide
        Mark Miller added a comment -

        You want to take this issue Robert?

        Show
        Mark Miller added a comment - You want to take this issue Robert?
        Hide
        Robert Muir added a comment -

        Steven Rowe's supplied docs for collation, plus some package.htmls for a couple more contribs.

        Show
        Robert Muir added a comment - Steven Rowe's supplied docs for collation, plus some package.htmls for a couple more contribs.
        Hide
        Robert Muir added a comment -

        Steven, thanks, I think this writeup really is hugely important for this package.

        the existing javadocs assumes you know what collation does, and the changes entry really understates what you can do with this:

         2. LUCENE-1435: Added contrib/collation, a CollationKeyFilter
            allowing you to convert tokens into CollationKeys encoded usign
            IndexableBinaryStringTools.  This allows for faster RangQuery when
            a field needs to use a custom Collator.  (Steven Rowe via Mike
            McCandless)
        

        So I think its good for someone to understand they can use this package for more than just range queries: sorting and searching!

        Show
        Robert Muir added a comment - Steven, thanks, I think this writeup really is hugely important for this package. the existing javadocs assumes you know what collation does, and the changes entry really understates what you can do with this: 2. LUCENE-1435: Added contrib/collation, a CollationKeyFilter allowing you to convert tokens into CollationKeys encoded usign IndexableBinaryStringTools. This allows for faster RangQuery when a field needs to use a custom Collator. (Steven Rowe via Mike McCandless) So I think its good for someone to understand they can use this package for more than just range queries: sorting and searching!
        Hide
        Steve Rowe added a comment -

        Here is package.html for contrib/collation, with content mostly stolen from class comments and test cases.

        The Turkish collation example is mostly stolen from Robert Muir's TestTurkishCollation.java from LUCENE-1581.

        Show
        Steve Rowe added a comment - Here is package.html for contrib/collation, with content mostly stolen from class comments and test cases. The Turkish collation example is mostly stolen from Robert Muir's TestTurkishCollation.java from LUCENE-1581 .
        Hide
        Mark Miller added a comment -

        also db and remote

        Show
        Mark Miller added a comment - also db and remote

          People

          • Assignee:
            Robert Muir
            Reporter:
            Mark Miller
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development