Add Document Map
Zachary Martin
Doc map that is sticky to the side similar to what Google Docs has. This makes it easier when creating extremely long documents. (Submitted via Intercom)
Log In
pixojoy
Table of Contents 🙌 Table of Contents 🙌 Table of Contents 🙌
Bruce Cannon
Excited to find that this feature is now live (it is off by default, and enabling it is buried). To find it, open the new collapsed docs sidebar, click "Aa", scroll down to bottom, and switch on "sticky table of contents."
Bruce Cannon
Uh oh, got too excited too soon! This feature is not ready for prime time. Big problems:
- it is not site-wide, or even doc-wide, it is page level only. This means that if you have 500 pages in your doc, you need to go into page settings and switch it on, ON EVERY SINGLE PAGE.
- It is not an admin feature, it is a user level feature. This means that if you delete the /tc on-page widget and switch on sticky TOC instead, it is now visible for all users, which is not bad as it should be a system-level admin switch anyway. But since it's a user-level switch, any other page editor can switch it off again, and IT DISAPPEARS FOR EVERYONE.
- Worst of all: it is called "sticky toc" but it is not. When you enable it in the sidebar page settings, it makes an icon appear. But the TOC itself is hidden by default, which is bad. But the really bad thing is, when you click on the new TOC icon it shows, but when you edit the page IT DISAPPEARS AGAIN. You can only see it when you are not interacting with the page!
tl;dr: just not good enough yet
Bruce Cannon
Another update! This things actually does work well, and as intended, some of the time! What I've discovered is that, while the sticky TOC cannot be controlled globally, as it should be, and must be enabled manually on every single page (ugh!) it can work well, and as expected, and as other products implement it, under some conditions:
- Can't have the page tree left sidebar open
- Can't have the right sticky sidebar open
- Can't have the page set to full width.
If your page meets all those requirements, you can see the sticky TOC on small laptop screens. It's nice!
Except it has a bug in that the TOC viewport does not scroll to keep it's current-location highlight always visible, as you move up and down a document. If they fix that, it will be super useful.
A
Aerin Paulo
In general it makes the way Docs works more usable especially for wiki purposes. It would be nice, too, if Docs worked more like Dashboards, with the secondary menu you can toggle open/closed, and that's where the document tree/map could hide.
Mark H
Use case: We're using Docs for real-time sales call scripts. As a sales person gets on the phone, he/she can start going off the script.
However, as the responses come in from the other end of the phone, the ability for the sales person to "click" and get dropped into the relevant rebuttal gets hard.
They have to scroll back up to the top, look for the relevant rebuttal based on what the person on the other end of the phone said... and then click.
Having a sticky sidebar makes this problem go away and makes it super quick.
Kasey
yes please! so needed!
Pavel Pronin
Good idea.
Google docs is a great example of a doc's map.
Thibault de Changy
( i ) RECAP - How to activate the TOC "widget" : simply type "/tc" where you want your Doc's TOC on it.
Thibault de Changy
My suggestion would be to implement the TOC within the Doc listing in the left sidebar. Each Doc could allow to open/close its TOC, while the actual Doc name and Toc position are colored.
Bruce Cannon
Thibault de Changy:
I like this idea. I mocked it up a while back and it was a bit tough to use. Nice and compact though. Maybe if it auto-opened it would work.
Another option is a third accordion level. Clickup already has two. And then you can have any or all views open at any time.
But most other services put doc map on the right side, so too nav many columns don't push the editor too far over to one side of the screen...
Thibault de Changy
Bruce Cannon: All right, It's maybe about preference.. I try to think UX essentially, and what I suggested was basically inspired from what we see in API documentations. Everything on the left in a single, not that wide, column, and without having to switch from one side to the other. Quite a funny and not that easy UI/UX question in the end :-D
Bruce Cannon
Thibault de Changy: Yes, good point! I hope you discovered that the CSS I shared can just as easliy put the TOC on the left as on the right :)
Bruce Cannon
This is how doc map works in clickup in browser on desktop. I use it on every page (force TOC to side using CSS), while waiting for an official implementation :)
Thibault de Changy
Hi Bruce Cannon: Can you share your CSS pls ?
Bruce Cannon
Thibault de Changy:
Add stylebot extension to chrome. Paste in the first rule set.
Fine tune if needed using chrome dev tools. The three extra sections are additional small tweaks you may or may not want. Enjoy! (don't include the bold parts, this editor stripped out their enclosing comment symbols)
Grab the TOC, pin it to the side, and make it scrollable
.cu-table-content {
height: 90%;
overflow-x: hidden;
overflow-y: scroll;
position: fixed;
right: 5px;
top: 40px;
transform: scale(0.9);
width: 20%;
z-index: 10;
}
Shove the whole editor over to the left a bit to compensate:
div.cu-dashboard-doc-main__container {
margin-left: -10%;
}
Get rid of the white bar at the bottom of pages, because it's confusing when it hides content:
.cu-dashboard-doc-container__scroll-container {
max-height: 100%;
}
.cu-dashboard-doc-container__scroll-container_task-tray {
max-height: 100%;
}
Remove strikethrough on checklist items to make task lists easier to read:
.ql-editor ol li[data-list=checked], ul li[data-checked=true], ul[data-checked=true] li {
color: #999999;
font-style: italic;
text-decoration: none;
}
Thibault de Changy
Bruce Cannon: Thanks for the code, but for now nothing happens (even trying to solve the cu-table-content issue, trying class or ID). Did I miss some setting to activate a TOC option in Clickup ? Is there any JS to be added ?
Bruce Cannon
Thibault de Changy: hey Thibault, I am worried to annoy clickup with too big a digression thread, write me and I will help you set it up! It's easy but likely I skimmed a step or two. We can do a screen share and be done in no time. My initials at my firstname lastname dot com.
I re-read your comment more carefully, and see things I dropped the ball on:
- I dropped the dot in front of the first rule set, it's a class.
- You must place a TOC widget somewhere on your page, all the CSS does is move it if already there, it doesn't create it.
- I neglected to mention also: a. open advanced mode b. click Edit CSS and c. paste all the above into the big empty window (reminder: without the descriptions!).
Thibault de Changy
Bruce Cannon: All right I found by chance how to activate the TOC "widget" as you say - We have to type "/tc"
Then, if we want we can use your CSS that I reduced to its core as follow :
/
Grab the TOC, pin it to the side, and make it scrollable
/.cu-table-content {
height: 90%;
overflow-x: hidden;
overflow-y: scroll;
position: fixed;
right: 5px;
top: 40px;
transform: scale(0.9);
width: 20%;
z-index: 10;
}
Zeb
Bruce Cannon: Love this!
Bruce Cannon
Zeb: praise from on high, I like it! I hope you will consider a doc map, Zeb. So useful!!
Bruce Cannon
For the designers/devs, here are some competitive examples to evaluate: Archbeee, Google Docs, Slab, Slite.
Load More
→