lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Cassandra Targett (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SOLR-11766) Ref Guide: redesign Streaming Expression reference pages
Date Thu, 01 Feb 2018 14:47:00 GMT

    [ https://issues.apache.org/jira/browse/SOLR-11766?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16348668#comment-16348668
] 

Cassandra Targett commented on SOLR-11766:
------------------------------------------

bq. Out of curiosity, is it possible to add javascript widgets, such as a filter mechanism
for categories of expression, or a text box that culls the boxes on the quick ref page as
you type? 

Yes, it is possible, and besides the search box it's done already for the in-page TOC and
the inline tabs as seen on a page like https://lucene.apache.org/solr/guide/7_2/adding-custom-plugins-in-solrcloud-mode.html.
Because JS only runs on the HTML pages when they're loaded, it doesn't impact the PDF at all
(as long as there isn't any information that's only in the script, which wouldn't happen,
I think, with what you're describing). We even have the ability to set up a layout that would
only call a custom JS on Streaming Expression pages and not every other page that doesn't
need it. I would really like to add something like that, but am hampered by my inability to
write such a thing on my own. 

> Ref Guide: redesign Streaming Expression reference pages
> --------------------------------------------------------
>
>                 Key: SOLR-11766
>                 URL: https://issues.apache.org/jira/browse/SOLR-11766
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation, streaming expressions
>            Reporter: Cassandra Targett
>            Assignee: Cassandra Targett
>            Priority: Major
>         Attachments: Stream-collapsed-panels.png, StreamQuickRef-sample.png, Streaming-expanded-panel.png
>
>
> There are a very large number of streaming expressions and they need some special info
design to be more easily accessible. The current way we're presenting them doesn't really
work. This issue is to track ideas and POC patches for possible approaches.
> A couple of ideas I have, which may or may not all work together:
> # Provide a way to filter the list of commands by expression type (would need to figure
out the types)
> # Present the available expressions in smaller sections, similar in UX concept to https://redis.io/commands.
On that page, I can see 9-12 commands above "the fold" on my laptop screen, as compared to
today when I can see only 1 expression at a time & each expression probably takes more
space than necessary. This idea would require figuring out where people go when they click
a command to get more information.
> ## One solution for where people go is to put all the commands back in one massive page,
but this isn't really ideal
> ## Another solution would be to have an individual .adoc file for each expression and
present them all individually.
> # Some of the Bootstrap.js options may help - collapsing panels or tabs, if properly
designed, may make it easier to see an overview of available expressions and get more information
if interested.
> I'll post more ideas as I come up with them.
> These ideas focus on the HTML layout of expressions - ideally we come up with a solution
for PDF that's better also, but we are much more limited in what we can do there.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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


Mime
View raw message