SCDoc: redesign TOC and menubar again #3831

nhthn · 2018-06-29T21:21:20Z

a lot of changes here:

fix 3.9 help Table of Contents is unwieldy to use #3771 by somewhat reverting back to the old TOC dropdown. there was no way to avoid disturbing scrolling with the popout TOC, so i removed the feature entirely.
the menubar is floating again.
fixes print friendliness issues (SCDoc is not print-friendly #3395) on the side.
adds jQuery.

mossheim · 2018-06-30T16:38:46Z

This looks pretty good to me!

Having some sort of jQuery-like thing available would be nice from what I understand of JavaScript. I don't mind the dependency.

gusano · 2018-06-30T17:41:54Z

HelpSource/scdoc.js

+    $("#toc").appendTo(toc_container);
+
+    toc_items = document.getElementById("toc")
+        .getElementsByTagName("ul")[0].getElementsByTagName("li");


@snappizz why not use zepto selector here instead of vanilla js? Can't you just do (like jquery):

$('#toc ul').eq(0).find('li')

Same below with $('#toc_search')?

it was originally written in vanilla js, and i just haven't bothered to refactor it to use zepto.

@snappizz you use zepto selectors one line above so please, let's either use it or not, but not both

gusano · 2018-06-30T17:43:44Z

@snappizz what exactly is the benefit to using zepto vs jquery?
Not a big fan of it TBH..
Also see my comments above..

nhthn · 2018-07-01T02:22:24Z

zepto is smaller. full jquery functionality is not needed.

gusano · 2018-07-01T08:10:21Z

HelpSource/scdoc.js

+    $("#toc").appendTo(toc_container);
+
+    toc_items = document.getElementById("toc")
+        .getElementsByTagName("ul")[0].getElementsByTagName("li");


@snappizz you use zepto selectors one line above so please, let's either use it or not, but not both

gusano · 2018-07-01T08:10:34Z

HelpSource/scdoc.js

+    toc_items = document.getElementById("toc")
+        .getElementsByTagName("ul")[0].getElementsByTagName("li");
+
+    document.getElementById("toc_search").onkeyup = toc_search;


@snappizz same here

gusano · 2018-07-01T08:10:49Z

HelpSource/scdoc.js

+    toc_link.on("click", function (e) {
+        e.preventDefault();
+        document.getElementById("toc_search").focus();
+        $("#toc").toggle();


@snappizz same here

jamshark70 · 2018-07-05T02:58:35Z

Just tried this branch. It's a massive improvement in usability -- excellent work, Nathan!

The floating menu bar results in one display glitch. I wouldn't have any idea how to fix it. I could live with this more than I could live with the 3.9 workflow, but I guess it's only a matter of time before some user complains.

Jumping to a named anchor positions the anchored text at the top of the window, but the menu bar covers part of the top of the window. So part of the text is hidden.

Open Server help (really, any help file).
In the table of contents, choose a method (e.g. record).
You can't see the method header for record (but the description and arguments are there).

nhthn · 2018-07-05T03:14:18Z

thanks james. i won't have access to my dev environment for the next few days, but i'll use this fix: https://css-tricks.com/hash-tag-links-padding/

This commit loads jQuery into the SCDoc system.

This commit: - Restores the floating menu bar in SCDoc. - Fixes print-friendliness (supercollider#3395) - Redesigns TOC to fix an issue with internal links (supercollider#3831) - Unifies appearance of TOC and index submenu - Refactors a lot of code to use jQuery

nhthn · 2018-07-08T22:41:32Z

i've fixed the internal links issue, upgraded from zepto to jquery, and refactored some more old code to use jQuery.

there's still some non-jQuery code adjacent to jQuery code. i don't wanna hear about that, there's only so much adjacent refactoring i'm willing to do here.

gusano

@snappizz nice one, thank you :)

My complaints were about some non-jquery code in the middle of some jquery code in your additions, not in the older code, so all looks good now!

ps: ah, I still see the anchor link issue James reported

Signed-off-by: Yvan Volochine <yvan.github@gmail.com>

gusano · 2018-07-09T15:16:05Z

@snappizz @jamshark70 I pushed a small fix for the padding glitch on anchor links.. hope you don't mind ;)

nhthn · 2018-07-09T17:19:53Z

thanks yvan, looks good!

prko · 2018-07-10T03:21:25Z

Hi,
I compiled the version from the source code:
https://github.com/supercollider/supercollider
The issue #3395 is fixed. It is great!

However, I have found the following:

directly above the section title, the links are not clicked (See the attachement):
- Please try to click the followings above the section title "Description" in the SinOSC help document:
  - the link 'Osc.sc' in the third line,
  - the link 'Osc' in the fourth line and
  - the link 'FSinOsc' in the fourth line.
- Also, please try to click the followings above the section title "Description" in the same document:
  - the link 'Klang' and
  - the link 'Dynklang'.
The shortcut SHIFT+Enter is broken. It removes text.
The shortcut CMD+Enter evaluate whole codes in a code::.....::

If you already know, I apologise for writing this.

patrickdupuis · 2018-07-10T03:33:34Z

@prko Please open an issue rather than commenting here. This PR is closed.

BTW I am seeing this same issue.

nhthn · 2018-07-10T04:09:18Z

@prko thanks for the report. the link problem is legit and i'll get on that in a moment, but the shortcut issues are a result of other changes (see #3829 and #3777).

nhthn added the comp: SCDoc scdoc syntax, parser, and renderer. for changes to schelp files, use "comp: help" label Jun 29, 2018

nhthn added this to the 3.10 milestone Jun 29, 2018

gusano reviewed Jun 30, 2018

View reviewed changes

gusano requested changes Jul 1, 2018

View reviewed changes

nhthn mentioned this pull request Jul 4, 2018

SCDoc is not print-friendly #3395

Closed

Nathan Ho added 3 commits July 8, 2018 15:33

scdoc: Add jQuery

2ddeb7b

This commit loads jQuery into the SCDoc system.

SCDoc: add vertical offset to internal links

98cf33e

nhthn force-pushed the topic/toc-fixes branch from f13defa to 98cf33e Compare July 8, 2018 22:37

SCDoc: fix text wrapping and dimensions for TOC

2e2a0f5

gusano approved these changes Jul 9, 2018

View reviewed changes

SCDoc: fix css padding for anchor links

e1165c7

Signed-off-by: Yvan Volochine <yvan.github@gmail.com>

telephon merged commit 54208e8 into supercollider:develop Jul 9, 2018

nhthn added this to Done in 3.10 Jul 9, 2018

prko mentioned this pull request Jul 10, 2018

the links above section title in help document is not clicked #3858

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SCDoc: redesign TOC and menubar again #3831

SCDoc: redesign TOC and menubar again #3831

nhthn commented Jun 29, 2018 •

edited

mossheim commented Jun 30, 2018

gusano Jun 30, 2018

nhthn Jul 1, 2018 •

edited

gusano Jul 1, 2018

gusano commented Jun 30, 2018

nhthn commented Jul 1, 2018

gusano Jul 1, 2018

gusano Jul 1, 2018

gusano Jul 1, 2018

jamshark70 commented Jul 5, 2018

nhthn commented Jul 5, 2018

nhthn commented Jul 8, 2018 •

edited

gusano left a comment •

edited

gusano commented Jul 9, 2018 •

edited

nhthn commented Jul 9, 2018

prko commented Jul 10, 2018

patrickdupuis commented Jul 10, 2018

nhthn commented Jul 10, 2018

SCDoc: redesign TOC and menubar again #3831

SCDoc: redesign TOC and menubar again #3831

Conversation

nhthn commented Jun 29, 2018 • edited

mossheim commented Jun 30, 2018

gusano Jun 30, 2018

Choose a reason for hiding this comment

nhthn Jul 1, 2018 • edited

Choose a reason for hiding this comment

gusano Jul 1, 2018

Choose a reason for hiding this comment

gusano commented Jun 30, 2018

nhthn commented Jul 1, 2018

gusano Jul 1, 2018

Choose a reason for hiding this comment

gusano Jul 1, 2018

Choose a reason for hiding this comment

gusano Jul 1, 2018

Choose a reason for hiding this comment

jamshark70 commented Jul 5, 2018

nhthn commented Jul 5, 2018

nhthn commented Jul 8, 2018 • edited

gusano left a comment • edited

Choose a reason for hiding this comment

gusano commented Jul 9, 2018 • edited

nhthn commented Jul 9, 2018

prko commented Jul 10, 2018

patrickdupuis commented Jul 10, 2018

nhthn commented Jul 10, 2018

nhthn commented Jun 29, 2018 •

edited

nhthn Jul 1, 2018 •

edited

nhthn commented Jul 8, 2018 •

edited

gusano left a comment •

edited

gusano commented Jul 9, 2018 •

edited