Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Related Pages API #132

Open
8 tasks
cjbrooks12 opened this issue Jun 2, 2018 · 0 comments
Open
8 tasks

Related Pages API #132

cjbrooks12 opened this issue Jun 2, 2018 · 0 comments
Labels
api proposal A proposal for a new API opened in Core and implemented by plugins core Project Type: Core functionality enhancement Task Type: New features, additional options for existing features, etc.
Projects

Comments

@cjbrooks12
Copy link
Contributor

The Related Pages API would be another modular list type attached to the Page object, and would have an API similar to Menu Items. Implementations of these modular types would return a list of pages they find to be related to the current page, and can do it in a any way and with any options they need.

The display of these pages is very free-form, and could be displayed as a list of thumbnails, links, and even converted directly/added to the page's Menu (probably just as a MenuItem type that is 'related' and wraps these related pages).

The Apache Lucene integration (#77) would be implemented as a type in this relation.

Open Questions:

  • Would this API return the pages directly, or return wrappers around pages, similar to how Menu Items do.
  • If there was a wrapper, how would we order these pages? What metric could be shared amongst all implementers that would be able to correctly merge related pages from different relations in a way that is accurate?

To-Do:

  • Add RelatedPages as a ModularList type
  • Add several implementations, either in Core or as a new plugin
    • Apache Lucene for similar by page content
    • Previous/next pages
    • Raw queries, using the PageRelation
    • Siblings/children in a wiki
    • Classes that implement/extend the current page class in Javadoc
    • Other items in the taxonomy
@cjbrooks12 cjbrooks12 added enhancement Task Type: New features, additional options for existing features, etc. core Project Type: Core functionality under consideration Issue Status: Under consideration labels Jun 2, 2018
@cjbrooks12 cjbrooks12 added this to Triage in Backlog via automation Jun 2, 2018
@cjbrooks12 cjbrooks12 added api proposal A proposal for a new API opened in Core and implemented by plugins and removed under consideration Issue Status: Under consideration labels Jun 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api proposal A proposal for a new API opened in Core and implemented by plugins core Project Type: Core functionality enhancement Task Type: New features, additional options for existing features, etc.
Projects
Backlog
  
Triage
Development

No branches or pull requests

1 participant