You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Shai Erera (JIRA)" <ji...@apache.org> on 2011/06/30 05:21:28 UTC

[jira] [Created] (LUCENE-3261) Faceting module userguide

Faceting module userguide
-------------------------

                 Key: LUCENE-3261
                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
             Project: Lucene - Java
          Issue Type: Improvement
          Components: modules/facet
            Reporter: Shai Erera
            Assignee: Shai Erera
            Priority: Minor


In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.

This document is like the file format document, or any other document we put under site-versioned. So we have two places:
* facet/docs
* site/userguides

Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.

I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


[jira] [Updated] (LUCENE-3261) Faceting module userguide

Posted by "Shai Erera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-3261?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Shai Erera updated LUCENE-3261:
-------------------------------

    Attachment: facet-userguide.pdf

Attaching the userguide from LUCENE-3079.

> Faceting module userguide
> -------------------------
>
>                 Key: LUCENE-3261
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: modules/facet
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>            Priority: Minor
>         Attachments: facet-userguide.pdf
>
>
> In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.
> This document is like the file format document, or any other document we put under site-versioned. So we have two places:
> * facet/docs
> * site/userguides
> Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.
> I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


[jira] [Resolved] (LUCENE-3261) Faceting module userguide

Posted by "Shai Erera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-3261?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Shai Erera resolved LUCENE-3261.
--------------------------------

    Resolution: Fixed

Committed revision 1175340 (3x).
Committed revision 1175341 (trunk).

> Faceting module userguide
> -------------------------
>
>                 Key: LUCENE-3261
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: modules/facet
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>            Priority: Minor
>             Fix For: 3.5, 4.0
>
>         Attachments: LUCENE-3261.patch, facet-userguide.pdf
>
>
> In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.
> This document is like the file format document, or any other document we put under site-versioned. So we have two places:
> * facet/docs
> * site/userguides
> Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.
> I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


[jira] [Updated] (LUCENE-3261) Faceting module userguide

Posted by "Shai Erera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-3261?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Shai Erera updated LUCENE-3261:
-------------------------------

    Lucene Fields: [New, Patch Available]  (was: [New])
    Fix Version/s: 4.0
                   3.5

> Faceting module userguide
> -------------------------
>
>                 Key: LUCENE-3261
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: modules/facet
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>            Priority: Minor
>             Fix For: 3.5, 4.0
>
>         Attachments: LUCENE-3261.patch, facet-userguide.pdf
>
>
> In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.
> This document is like the file format document, or any other document we put under site-versioned. So we have two places:
> * facet/docs
> * site/userguides
> Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.
> I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


[jira] [Commented] (LUCENE-3261) Faceting module userguide

Posted by "Uwe Schindler (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-3261?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13105970#comment-13105970 ] 

Uwe Schindler commented on LUCENE-3261:
---------------------------------------

When looking into the TARBALL of Lucene 3.4, I missed this great guide in the facet contrib directory. Would it not be a good idea to include it in the module root dir?

> Faceting module userguide
> -------------------------
>
>                 Key: LUCENE-3261
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: modules/facet
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>            Priority: Minor
>         Attachments: facet-userguide.pdf
>
>
> In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.
> This document is like the file format document, or any other document we put under site-versioned. So we have two places:
> * facet/docs
> * site/userguides
> Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.
> I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


[jira] [Commented] (LUCENE-3261) Faceting module userguide

Posted by "Shai Erera (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/LUCENE-3261?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13107361#comment-13107361 ] 

Shai Erera commented on LUCENE-3261:
------------------------------------

Yes, we should include it. I wasn't sure about the source format though ... if I add the .odt version, is that acceptable? Should I maybe add both .odt and .pdf and we release just the PDF? Or .. perhaps I'll just convert it to HTML. I'll see how much work is needed for that.

> Faceting module userguide
> -------------------------
>
>                 Key: LUCENE-3261
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: modules/facet
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>            Priority: Minor
>         Attachments: facet-userguide.pdf
>
>
> In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.
> This document is like the file format document, or any other document we put under site-versioned. So we have two places:
> * facet/docs
> * site/userguides
> Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.
> I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


[jira] [Updated] (LUCENE-3261) Faceting module userguide

Posted by "Shai Erera (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/LUCENE-3261?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Shai Erera updated LUCENE-3261:
-------------------------------

    Attachment: LUCENE-3261.patch

Patch against 3x. Adds userguide.html as well as fixes facet/build.xml to include the example code with the javadocs.

I think this is ready to commit.

> Faceting module userguide
> -------------------------
>
>                 Key: LUCENE-3261
>                 URL: https://issues.apache.org/jira/browse/LUCENE-3261
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: modules/facet
>            Reporter: Shai Erera
>            Assignee: Shai Erera
>            Priority: Minor
>             Fix For: 3.5, 4.0
>
>         Attachments: LUCENE-3261.patch, facet-userguide.pdf
>
>
> In LUCENE-3079 I've uploaded a userguide for the faceting module. I'd like to discuss where is the best place to include the module. We include it with the code (in our SVN), so that it's always attached to some branch (or in other words a release). That way we can have versions of it per releases that reflect API changes.
> This document is like the file format document, or any other document we put under site-versioned. So we have two places:
> * facet/docs
> * site/userguides
> Unlike the site, which its PDFs are built automatically by Forrest, we cannot convert ODT to PDF with it, so it's a challenge to put it there. What we do today (in our SVN) is whoever updates the userguide, creates a PDF too, that's easy from OpenOffice.
> I'll upload the file later when I'm in front of it.

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

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org