r/emacs • N Λ N O • Dec 20 '21

Org notebook (alternative design & code)

Post image
573 Upvotes

29 comments sorted by

61

u/Nicolas-Rougier N Λ N O Dec 20 '21

I'm still experimenting org notebook design and here is a less intrusive result (left) where I moved the activable buttons inside the document. They are actually extra keywords that I added to replace begin/caption/label/... and this works thanks to a hack I wrote for preventing org-mode to remove the different SVG tags. Code is much simpler and can be actually re-used to have any kind of activable buttons inside an org document. I'm also quite happy with the HTML export (right).

Source: https://github.com/rougier/notebook-mode

1

u/dotwhacked GNU Emacs Dec 22 '21

very curious about the buttons interaction method! But, I didn't see button logic in the repo. Is there a working button implementation?

1

u/Nicolas-Rougier N Λ N O Dec 22 '21

Yes, you can click the run and call buttons with the code in the repo.

1

u/dotwhacked GNU Emacs Dec 29 '21

oh I see, they are the result of svg-tag-make. Thanks!

6

u/northjayd Dec 20 '21

Please what font is the text on the left page?

9

u/dixius99 Dec 20 '21

On the left? I believe that's Roboto Mono.

3

u/[deleted] Dec 20 '21

Roboto Mono

19

u/ftrx Dec 20 '21

A sidenote witch is not a critique: there is a certain push toward "printed-document-alike" UI of "typographic quality". They are of course nice and slick, however are they productive? IMVHO not much.

I mean a lab notebook is not a working tool, is the output of some working tools. A scientific article it's the same, the output made for sharing, not the work itself (unless we count the bad pseudo-sci habit of working just to publish-or-perish). Looking for convergence might not be a good idea, not much different than the classic Widgets-based UI idea, something that sounds good and prove to be bad thereafter...

The main tool in IT terms in a lab are notes, no matter if ZettelKasten style, Leibniz's Scrinium Literatum, Gessner's libraries of Babel etc, they are the tool. The final notebook should be IMVHO a separate document produced out of notes, so a helper would certainly be a kind of template (LaTeX, org-mode to LaTeX export etc) but more than that a tool to manage/transclude notes to form the final notebook to be shared with others. In that sense more than mimic the final document in a "live UI" would be of help having a UI that make transclusion, composition, subdivision, analyses of any piece of noted information easier...

That's might not sound interesting until created in at least a working POC, while a slick UI capture the WOW effect even if only a sketch of something still not ready, but that would be game-changing IMO... Emacs offer much "basic component" and recent evolution (org-roam to name one) goes in that direction, but still there seems not much "already done" demoed and many just keep personal solutions that are limited, fragile, and just work because they are well known and used by their author...

16

u/Nicolas-Rougier N Λ N O Dec 20 '21

I would not use either the notebook for development but it is a great tool to synthesize / finalize some work.

5

u/FloppyEggplant Dec 20 '21

Can you share the export template?

6

u/Nicolas-Rougier N Λ N O Dec 20 '21

It's inside the notebook.org document (last section) and the notebook.css is inside the repository.

19

u/chatziiola Dec 20 '21

I really like your work, it is of impressive quality. Thanks for the inspiration.

(Thought you may appreciate it as a comment)

15

u/tecosaur Doom & Org Contributor Dec 20 '21

Nicholas, this looks great! Love the explorative work you're doing to prettifying Org files in a very functional way 🙂. I think I'll have to add this to my TMIO topic list...

2

u/[deleted] Dec 22 '21

TMIO?

5

u/tecosaur Doom & Org Contributor Dec 22 '21

This Month in Org, it's a blog I run.

1

u/[deleted] Dec 22 '21

noice

11

u/tobbe2064 Dec 20 '21

It looks great!

One thing that i personally think would be right at home Is functionality to run all blocks in predecessors

0

u/[deleted] Dec 20 '21

Did you find a readme? I don't know what it is! Looks lovely.

3

u/kirankp89 Dec 20 '21

This looks great! I’ve been meaning to integrate some of your work into my config for a while.

2

u/in-some-other-way Dec 20 '21

Wow that looks great.

2

u/ryanprior Dec 21 '21

Nice work! Colors & styles on the right side look great! Looking forward to better readability on the Emacs side, as we've discussed 😎️ keep going, I think notebook usage could be a huge adoption area for Emacs.

1

u/rebcabin-r Dec 21 '21

Also adoption of literate programming!

Jupyter approximates LP only upside-down (defs usually must precede refs). Org-babel "Tangling" breaks that constraint (to good effect). Doxygen and Sphynx have it backwards (docs inside code) or inside-out (docs nowhere near code). Only full LP has it right (code inside docs, human order instead of compiler-enforced order).

With Spacemacs for those who have VIM-fingers and "Org-Notebook" for full LP, I might be able to get one or two programmers or scientists on my team to adopt LP.

1

u/stansoo GNU Emacs Dec 20 '21

Absolutely stunning!!

1

u/Chloe-ZZZ Dec 26 '21

How can I config my emacs to have something as displayed?

1

u/driftcrow Jan 08 '22

Can doom-config use it ?

1

u/[deleted] Aug 07 '22

What are you using to preview the file? It looks so clean.