Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature request] - New entry type "Chapter" #263

Closed
8 tasks done
jcgerhard opened this issue Mar 1, 2018 · 8 comments
Closed
8 tasks done

[Feature request] - New entry type "Chapter" #263

jcgerhard opened this issue Mar 1, 2018 · 8 comments
Labels
enhancement Feature requests and code enhancements stale An issue that hasn't been active for a while...

Comments

@jcgerhard
Copy link

Operating system

  • Windows
  • macOS
  • Linux
  • Android
  • iOS

Application

  • Desktop
  • Mobile
  • Terminal

Preface

While joplin runs very stable on macOS/iOS now and has IMHO the capability to rise above a simple todo-list or note-taking app, I am going more and more over to use it in a wiki- or maybe rather a knowledgebase-like style. That means, having longer articles/entries that contains a lot of different headings and paragraphs. This is a perfect and fast way to build up portable and "syncable" wikis and manuals for desktop and mobile - available at any time, no matter where you are or where you create or edit them.


Problem

It is very hard to navigate through such kind of content because of its length and complexity.


Idea

A new feature respectively a new type of entry that I would like to call a chapter.


Description

Basically, a chapter is an extended note type that adds an additional view/column with an auto-generated table of content next to the content area.
The table of content and its numbering is created by recognizing and counting every element that follows the markdown header formatting syntax like...

# Heading Level 1
## Heading Level 2
### Heading Level 3

...and furthermore, the counting is used for auto-numbering the headings in the content and the toc view consecutively.
The toc entries are clickable links so that you can jump directly to the corresponding positions.
The toc has a fixed position so that you can scroll through the content but always have it in reach.
On mobile it's stucked directly under the title and stays there even if scrolling through long pages.

For a better understanding please see the preview examples below...


Preview Desktop

joplin-chapters


Preview Desktop Menu

joplin-menu


Preview Mobile

joplin-mobile


Conclusion

This would be an outstanding usefully and unique feature setting joplin apart from its "competitors". I didn't find a comparable app that offers such a function and from my point of view it makes joplin an allround-information-management tool for daily and extensive usage even if you have to deal with large notes.

@jcgerhard
Copy link
Author

...maybe it's better to be able to toggle (show/hide) the table of content on the mobile app, because it could also get very long and hog to much of the display.

@laurent22 laurent22 added the enhancement Feature requests and code enhancements label Mar 7, 2018
@laurent22
Copy link
Owner

I guess it's mostly a UI thing since the existing Markdown format can already support multiple levels of headings.

Perhaps it should be something like in Word - a table of content that can be added to a note and be automatically updated? If that TOC is built in Markdown (with hash links) it will automatically work in all the apps without a need for custom UI.

@jcgerhard
Copy link
Author

Good morning @laurent22,

absolutely right...should be an UI/UX thing. All needed information for a TOC can be taken out of the markdown code of the respective note.
Maybe you can have a look at https://typora.io/. In my opinion one of the best and well-designed markdown editor available. It has an "outline"-view that does exactly what I meant.
While typing headlines and subs and subsubs using the markdown hashtag syntax (#,##,###...and so on) it builds a very nice table of content instantly on the left side.
I made an example as you can see below. Typora also has a settings-feature to choose, if you want to have the TOC collapsible or not. If you have to read long notes/articles every day this is an outstanding feature that brings a lot of comfort!

Example - Settings

example-3

Example - Non-Collapsible TOC

example-2

Example - Collapsible TOC

example-1


I could imagine, that the mechanism in the background is just iterating over the markdown code, recognizes each hashtag-headline and creates an appropriate nested html-list or something like that.
Maybe it's possible to add such a function to joplin...would be absolutely awesome, unique and first and foremost very helpful!!!

@inmabermejo
Copy link

This feature would be the greatest addition and a clear advantage over Evernote and similar apps. It has been requested by Evernote community for years (I'm following this up since 2011), but no answers about it yet.

For the ones that work with long notes, this is a lifesaver.

@stale
Copy link

stale bot commented Sep 22, 2019

Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs. You may also label this issue as "backlog" and I will leave it open. Thank you for your contributions.

@stale stale bot added the stale An issue that hasn't been active for a while... label Sep 22, 2019
@cast-away
Copy link

not stale

@stale stale bot removed the stale An issue that hasn't been active for a while... label Sep 22, 2019
@stale
Copy link

stale bot commented Dec 21, 2019

Hey there, it looks like there has been no activity on this issue recently. Has the issue been fixed, or does it still require the community's attention? This issue may be closed if no further activity occurs. You may comment on the issue and I will leave it open. Thank you for your contributions.

@stale stale bot added the stale An issue that hasn't been active for a while... label Dec 21, 2019
@stale
Copy link

stale bot commented Dec 28, 2019

Closing this issue after a prolonged period of inactivity. If this issue is still present in the latest release, please feel free to create a new issue with up-to-date information.

@stale stale bot closed this as completed Dec 28, 2019
@lock lock bot locked and limited conversation to collaborators Jan 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement Feature requests and code enhancements stale An issue that hasn't been active for a while...
Projects
None yet
Development

No branches or pull requests

4 participants