royale-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Carlos Rovira <carlosrov...@apache.org>
Subject Re: Royale Doc Table-of-Contents UX (was Re: Royale Documentation Page Layout Proposal)
Date Sun, 28 Jan 2018 09:56:02 GMT
Hi Alex,

for TOC. One think that's very important to me: Please only *two levels* in
TOC. For simplicity and clarity. Like the demo page I did. It's the
standard right now and a three level only created confusion. Again see
Angular and React sites to match what they did and take it as a reference.

For states. I think the trick here is that a .md page has some variables
that will make the right top level branch open in TOC and as well make the
right sub option appears as selected (strong type) and without link. As we
are dealing with static GitHub pages I think there's no concept of
component, only that all pages has the TOC added to the sidebar.



2018-01-27 1:18 GMT+01:00 Andrew Wetmore <cottage14@gmail.com>:

> What you describe sounds fine to me. I don't think we need to worry about
> breadcrumbs and state and helping people go backwards through their series
> of clicks.
>
> On Fri, Jan 26, 2018 at 8:09 PM, Alex Harui <aharui@adobe.com.invalid>
> wrote:
>
> > Breaking out a separate thread on this...
> >
> > Thinking about this some more, I think I can generate an interactive
> > control with Jekyll, but I don't know how to make it retain state.  I
> > think that might require cookies and/or frames.
> >
> > For example, let's say the TOC looked like:
> >
> > Welcome
> > --High Level View
> > --Features
> > ----AS3
> > ----MXML
> > Get Started
> > --Download
> > --Hello World
> >
> > I've already implemented logic in the template to auto-expand the tree to
> > the document for folks who have direct links.  So, if you do a Google
> > Search and find the link to the MXML page, when you go to that page, the
> > ToC will automatically look like:
> >
> > Welcome
> > --High Level View
> > --Features
> > ----AS3
> > ---*MXML*
> > Get Started
> >
> >
> >
> > If you hit the main doc page, the ToC starts out collapsed so that Get
> > Started isn't pushed down by a bunch of Welcome sub-topics.  So the ToC
> > initially looks like:
> >
> > Welcome
> > Get Started
> >
> > Now let's say you expand both Welcome and Get Started so you see:
> >
> > Welcome
> > --High Level View
> > --Features
> > Get Started
> > --Download
> > --Hello World
> >
> > Then you click on Features.  The logic that opens trees to direct links
> is
> > going to cause the ToC to look like:
> >
> >
> > Welcome
> > --High Level View
> > --Features
> > Get Started
> >
> > Even though you had expanded "Get Started" it will collapse when going to
> > the Features page.  That's because, without frames, each page is its own
> > HTML page.  No state about the ToC is retained or shared.
> >
> > If folks are ok with that, I can probably get that to work.
> >
> > Thoughts?
> > -Alex
> >
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>
>
>
>
>
> <https://www.avast.com/sig-email?utm_medium=email&utm_
> source=link&utm_campaign=sig-email&utm_content=webmail>
> Virus-free.
> www.avast.com
> <https://www.avast.com/sig-email?utm_medium=email&utm_
> source=link&utm_campaign=sig-email&utm_content=webmail>
> <#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>
>



-- 
Carlos Rovira
http://about.me/carlosrovira

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message