the-notebookinator / notebookinator Goto Github PK

Requested Feature

I'd like to be able to render a specific entry on its own, without any of the frontmatter and appendix.

• single entry
• no frontmatter
• no appendix

Current Implementation

You must include the following for the entry to actually render in the preview

#show notebook.with(/*...*/)

Motivation

This would make it easier to work on individual entries and quickly check that everything looks correct without any scrolling in the pdf preview.

(Optional) Possible Implementations and Alternatives

• open the pdf to a specific page but i couldn't figure out how to do this
• dont provide cover page -> radial theme creates a placeholder cover page

Requested Feature

Leah from 929T has offered to have this format implemented as a theme

Motivation

The theme is gorgeous ✨ .

Requested Feature

Each of the themes currently use different fonts, but there isn't a good way to package fonts with a library in Typst.

Possible Implementation

• Have the fonts included in the resources, and create a script that automatically installs them.
• Wait until the Typst template system is finalized, and packaging fonts with templates is possible.

Requested Feature

I propose that we add plots and pie charts to the other themes, in order to have them match the functionality of the Radial theme

Current Implementation

Currently only the Radial theme supports plots and pie charts. It wraps the CeTZ plotting API to make it less verbose, and customize it to look nice.

Motivation

It would be nice to have this functionality in all of the themes, as these tools are really useful to have natively.

(Optional) Possible Implementations and Alternatives

Right now the major obstacle is that we haven't found a way to reduce code duplication while implementing these new components. The decision matrices already suffer from this problem, and they abstract all of their calculations away to a helper function.

An approach we could take is to only change the colors between themes. This means that we could provide a generic plot and pie chart component, and then have a colors parameter, which each theme could override, and present as a component.

Requested Feature

Make a section in the documentation that describes how to create a theme with the Notebookinator that doesn't contribute as a template.

Current Implementation

There is no section about this topic.

Motivation

Many people may want to alter pre-existing themes without making an entirely new theme.

(Optional) Possible Implementations and Alternatives

Currently the errors provided to the user are vague and confusing. Even simple things such as informing the user when they provide arguments in an unintended way would go a long way to improving this situation.

It might be a good idea to standardize the user facing component API so that we can guarantee component compatibility across themes.

I propose we do this with some sort of component constructor function. Here's an example:

// themes/linear/components/pro-con.typ
#let pro-con = make-pro-con((pros, cons)) => {

  table(
    // ...
  )
})

The make-pro-con function can just return another function that then gets assigned to the pro-con variable.

This would guarantee cohesion without need for more in depth code review, and would also allow the make-pro-con function to parse the arguments first, allowing for error handling. This might also help us close #28 , since it would allow us to handle incorrectly passed arguments in once place, instead of on a per-component basis.

The end goal would be to make switching themes guarantee to work without compiler errors.

Expected Behavior

Normally there is a border around the pages of the linear theme that looks like this:

Observed Behavior

However when the content in an entry spans multiple pages, this border is missing

Steps to Reproduce

Place the following code in a .typ file inside of the root of the Notebookinator, and then compile that file to see the bug.

#import "/lib.typ": *
#import themes.linear: linear-theme, components

#show: notebook.with(
  theme: linear-theme,
)

#create-frontmatter-entry(title: "Table of Contents")[
  #lorem(2000)
]

Environment

• Typst Version: 0.11.1
• Notebookinator Version: 1.0.1
• Operating System: NixOS Linux

See title. Currently the gallery build is acting as a form of integration testing for the project, so having this report errors correctly is extremely important.

Expected Behavior

The radial TOC page numbers mismatch both the physical and logical page numbers.

Environment

• Typst Version: 0.11.0
• Notebookinator Version: 1.0.0

Requested Feature

The documentation doesn't have enough explanation for the Implementing Your Own Theme section.

Current Implementation

See "Implementing Your Own Theme" section.

Motivation

People struggle to make their own themes and cannot fully rely on the documentation.

A port of 515R Revision's theme to the notebookinator.

515R's Spin Up notebook can be found here:
https://www.vexforum.com/t/515r-spin-up-notebook/113933

Requested Feature

The Radial theme really needs a nice looking default cover.

Current Implementation

Currently the Radial theme doesn't have a fleshed out default cover design, it just creates the words "Radial Cover".

The new Typst 0.11.0 update came with a total overhaul to the introspection API, breaking a lot of the existing code we have. They also introduced a new keyword: context. This means we will have to replace every instance of the word context with another variable name.

Environment

• Typst Version: 0.11.0
• Notebookinator Version: latest commit
• Operating System: Linux