Closed Bug 914797 Opened 11 years ago Closed 11 years ago

Redesign: TOC should indent subheadings

Categories

(developer.mozilla.org Graveyard :: Design, defect)

Product:
developer.mozilla.org Graveyard
Component:
Design
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: sheppy, Unassigned)

References

Details

Subheadings in redesign should be indented slightly; as it stands, it's just one straight list and the hierarchy is lost.
Had the same thought initially, but the non-indented version also works well. Simple and visually appealing without introducing much confusion. How were these styled in Sean's designs?
Exactly the way that I've implemented them...
I find it very confusing, personally. This makes them all look like top-level headings to my eye. Even if you leave the numbers in (which I still don't want to do), it looks very muddled to me with everything looking top-level like this.
If this is what Sean recommended, I recommend we keep it that way. We can always revisit this bug if other users report the same confusion.
Status: NEW → RESOLVED
Closed: 11 years ago
Resolution: --- → WORKSFORME
The TOC is useless this way, but whatever. Totally unreadable jumble of crap. You don't format outlines this way; they need to be indented. Everyone learns this in like 5th grade.
Let me clarify: when I said "crap" I wasn't referring to the design itself, per se. The problem here is that to my brain, without indentation, the text becomes a jumbled mess (a "jumble of crap") that I can't read. I simply can't process it this way. Maybe it's beautiful. Maybe most people can make sense of it. I can't. It doesn't look like a hierarchical table of contents this way to my brain. It's just a jumbled mess of words I can't make heads or tails of. That's all I mean here. I don't intend to offend David's work on implementing the design (or the UX and design folks for their work). I just can't read this, so it's not usable for me as it stands. If that's just me, well, I guess I'll get by without TOCs I can read, somehow. But I can't possibly imagine this is just me. Can't we at least have a small amount of indentation, to emphasize that this is a hierarchy and not just a simple list?
Sean, we are getting many bug reports about this. What do you think?
Flags: needinfo?(smartell)
So you're saying the TOC was given no indentation by design? Really? I find that really hard to believe. It really does look like a bug, or that styling is currently missing. Every vestige of my documentation writer's soul screams "wrong" when I see it ;-) Agree 100% with sheppy on this.
It is possible to have a non indented TOC by design, but in that case, it requires other visual means to figure the hierarchy. Otherwise (like it is right now), it's too flat to be understandable without conscientiously processing it by the user. A TOC that need to be process that way is close to useless for users IMO. As an aside content, a TOC should never needs hard attention to be understood, especially in a context such as MDN where the users have to focus on more important content.
Yet no one said anything during the initial design review. This should have been identified months ago. Not that it's a difficult change, but should have been brought up earlier. (I know you may not have been at Moz yet, but my comments are general.) (In reply to Chris Mills from comment #10) > So you're saying the TOC was given no indentation by design? Really? I find > that really hard to believe. It really does look like a bug, or that styling > is currently missing. Every vestige of my documentation writer's soul > screams "wrong" when I see it ;-) > > Agree 100% with sheppy on this.
(In reply to David Walsh :davidwalsh from comment #12) > Yet no one said anything during the initial design review. This should have > been identified months ago. Not that it's a difficult change, but should > have been brought up earlier. I strongly agree with that. However, it's good to remind that the public call for comments on the design was more than blurry up to recently. They will be other thing like that that will pop up in the upcoming weeks. It's difficult and painful for everybody.
True, David, true. It is not ideal to get such feedback at such a late stage. At least it is not something that will require too painful and fundamental a set of changes to fix. (In reply to David Walsh :davidwalsh from comment #12) > Yet no one said anything during the initial design review. This should have > been identified months ago. Not that it's a difficult change, but should > have been brought up earlier. > > (I know you may not have been at Moz yet, but my comments are general.) > > (In reply to Chris Mills from comment #10) > > So you're saying the TOC was given no indentation by design? Really? I find > > that really hard to believe. It really does look like a bug, or that styling > > is currently missing. Every vestige of my documentation writer's soul > > screams "wrong" when I see it ;-) > > > > Agree 100% with sheppy on this.
I'd like to reopen this bug, so we can consider it alongside the other beta feedback.
Status: RESOLVED → REOPENED
Resolution: WORKSFORME → ---
Blocks: 927422
No longer blocks: 910513
So it looks like the problem here is the immediate visibility of the hierarchy in the TOC. Habber what are the possible solutions? Is indentation the only one or is there alternative?
Flags: needinfo?(hhabstritt.bugzilla)
I logged in to say I too am finding it hard to get the initial hierarchy without the indentation. P.S can the word in the heading be corrected from intent to indent? Bug did not turn up in initial search.
(In reply to amajjd from comment #17) > I logged in to say I too am finding it hard to get the initial hierarchy > without the indentation. > > P.S can the word in the heading be corrected from intent to indent? Bug did > not turn up in initial search. Fixed - sorry about that!
Summary: Redesign: TOC should intent subheadings → Redesign: TOC should indent subheadings
Blocks: 928583
Commits pushed to master at https://github.com/mozilla/kuma https://github.com/mozilla/kuma/commit/9189ba2e8d196d027fb253ab191f556239626b9c fix bug 947832, 944560, 937136, 914797, 914946 - Remove TOC counters and indent listing https://github.com/mozilla/kuma/commit/ccfa5791f9471046c541dad989d456b276d99f1a Merge pull request #1783 from darkwing/toc-spacing fix bug 947832, 944560, 937136, 914797, 914946 - Remove TOC counters and indent listing
Status: REOPENED → RESOLVED
Closed: 11 years ago → 11 years ago
Resolution: --- → FIXED
Flags: needinfo?(smartell)
Flags: needinfo?(hhabstritt.bugzilla)
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.