Change exercise type selection and allow for more flexible info box layout #21

St0rml · 2025-07-30T14:31:57Z

As mentioned in #20 this PR aims to simplify the way the exercise type selection between "exercise" and "submission" is done.
This PR includes changes to the template_example main.typ to communicate the new method to select type, specify info key-value-pairs as well as information on how the layout of the info-box (title-sub) can be modified.

I tried to make the two most basic cases ("exercise" or "submission" type with default key-value-pairs already supplied in the template_example) really un-conmplicated. The user can now just change the top-level parameter exercise-type to exercise or submission and the info-box (title-sub) will adapt accordingly.

Please let me know what you think!

Also, this Branch includes the fix proposed in #19

St0rml · 2025-07-30T17:06:14Z

Sorry for the commit history. Git is hard. I accidently pushed to the wrong bransh...

JeyRunner

@St0rml thank you for your contribution! Adding a parameter to differentiate between submission and exercise looks like a good addition. I added some review comments. Also @FussballAndy as the original author of the exercise template should have a look.

JeyRunner · 2025-08-02T16:00:18Z

templates/tudaexercise/template/locales.typ

-  lecturer: "Lecturer",
-  term: "Term",
-  date: "Due"
+  group: "Exercise group:",


I would not put the separation character in the translation dict since it's the same for both languages.

JeyRunner · 2025-08-02T16:01:49Z

templates/tudaexercise/template/title.typ

-} else {
-  panic("title-sub has unsupported type. Expected content, function or none. Got " + type(title-sub))
-}
+#let resolve-info-layout(exercise-type, info, info-layout, dict) = {


Since this function is quite complex, I would add a bit of documentation. The original submission function had very good documentation.

JeyRunner · 2025-08-02T16:03:05Z

templates/tudaexercise/template/tudaexercise.typ

 /// 
 /// - body (content): 
 #let tudaexercise(
+  exercise-type: "exercise",


Add some doc for the new parameter (including possible values).

JeyRunner · 2025-08-02T16:03:11Z

templates/tudaexercise/template/tudaexercise.typ

    lecturer: none,
  ),

+  info-layout: (


Add some doc for the new parameter.

FussballAndy · 2025-08-04T12:18:57Z

templates/tudaexercise/template/title.typ

-} else {
-  panic("title-sub has unsupported type. Expected content, function or none. Got " + type(title-sub))
-}
+/// Creates the subline content. If `info-layout` is a dict, the subline gets filled following the order specified by the keys in the `info-layout` dict. If a key is present in the `info` but not in `info-layout`, it does not show up in the subline. 


This should probably be broken into multiple lines

FussballAndy · 2025-08-04T12:20:42Z

templates/tudaexercise/template/title.typ

+
+
+  let default_keys_exercise = ("term", "date", "sheet")
+  let default_keys_submission= ("group", "tutor", "lecturer")


A space before the = would add more consistency

FussballAndy · 2025-08-04T12:21:05Z

templates/tudaexercise/template/title.typ

+  if exercise-type not in ("exercise", "submission") {
+    panic("Exercise template only supports types 'exercise' and 'submission'")
+  } else  {


Maybe change this into an assert, thus the if nesting also becomes redundant

FussballAndy · 2025-08-04T12:23:43Z

templates/tudaexercise/template/tudaexercise.typ

 ///   - `author` 
 ///   
-///   Additionally the following items are used by the `exercise` `title-sub`:
+///   Additionally the following items are used by the `exercise-type` `submission`:


Unless I misunderstood the code, the items are used by both types, thus making this line a bit redundant. It was originally there to signal that with the default subline style the following items were taken into account.

FussballAndy · 2025-08-04T12:24:48Z

templates/tudaexercise/template/title.typ

+    for layout-key in info-layout.at("right") {
+      right-items = sort-info-to-list(right-items, info, layout-key)
+    }
+    for layout-key in info-layout.at("left") {
+      left-items = sort-info-to-list(left-items, info, layout-key)  
+    }


A check whether left and right is present would probably be a good idea. Alternatively provide default values

FussballAndy · 2025-08-04T12:25:46Z

templates/tudaexercise/template/title.typ

+            if info-key == "date" {
+              info-value = format-date(info-value, dict.locale) 
+            }
+            target-list.push([#dict.at(info-key) #info-value])


Hence the dict now doesn't contain the separator anymore it would need to be added here.
Additionally I would like to have the exercise type be as close to the LaTeX template as possible. This would make it s.t. the date becomes "Due: X.Y.Z" whereas in LaTeX it is only displayed as X.Y.Z

FussballAndy · 2025-08-04T12:27:26Z

templates/tudaexercise/template/title.typ

      v(6pt)
      line(length: 100%, stroke: stroke)
-      if title-sub != none {
+      if info-layout != none {


One thing I noticed too late in the title-sub approach was that when no keys beside the ones for the headline were present there would be an empty bar rendered. I think this could be a nuisance for users. Perhaps we should also check whether info actually contains keys to be displayed in the subline.

FussballAndy · 2025-08-04T12:32:24Z

templates/tudaexercise/template/title.typ

+        // This case makes sure the default submission keys don't get mistaken for custom keys
+        // I.e. we don't want submission keys ("group", "tutor", "lecturer") showing up, if
+        // exercise-type isn't "submission"!


This behaviour should probably also be noted in the doc comment for tudaexercise

St0rml · 2025-08-09T16:27:04Z

Okay, so I implemented the changes you suggested. Thank you for your detailed feedback and being kind with my beginner-mistakes (it is my first "real" typst project)
let me know if I can change anything else :)

FussballAndy

One thing I noticed is that maybe there is a slight misunderstanding on what submission should actually do. The main idea was to not just use submission specific keys and allow aligning content left and right, but rather to also add a different style of how the keys are displayed. The entire thing is mostly based on Rubos-TUDA-Template. And what it does is that it displays the keys more like this:

So sort of [*key*: value].

Whereas exercise was supposed to still look like the original LaTeX template.

This should perhaps still be reflected.

FussballAndy · 2025-08-12T12:04:19Z

templates/tudaexercise/template/tudaexercise.typ

-/// 
-/// - title-sub (content, function, none): The content of the subline in the title card.
-///   By default the `title-sub.exercise` style.
+///   them. Furthermore items `term`, `date` and `sheet` will only show when using 


I think you listed the wrong items here

FussballAndy · 2025-08-12T12:04:43Z

templates/tudaexercise/template/tudaexercise.typ

+///     ```
+///   Left aligns left, and vice versa. The order of the keywords in the list, defines the 
+///   order of the info displayed in the subline.
+///   For complete customization set `info-layout: false` and define any content in the


Shouldn't this be none instead of false now?

FussballAndy · 2025-08-12T12:21:42Z

templates/tudaexercise/template/title.typ

+  let sort-info-to-list(target-list, info-dict, filter-key) = {
+    for (info-key, info-value) in info-dict.pairs() {
+      if info-key in default_keys {
+        if info-key == filter-key {
+          if info-key == "date" {
+            target-list.push([#format-date(info-value, dict.locale)])
+          } else {
+            target-list.push([#dict.at(info-key) #info-value])
+          }
+        }
+      } // This case makes sure the default submission keys don't get mistaken for custom keys
+      // I.e. we don't want submission keys ("group", "tutor", "lecturer") showing up, if
+      // exercise-type isn't "submission"!
+      else if info-key not in default_keys_submission {
+        if info-key == filter-key {
+          target-list.push([#info-value])
+        }
+      }
+    }
+    return target-list
+  }


The entire function could maybe be changed s.t. instead of constantly appending a single element to a list, it rather takes in an array of all the keys and then returns an array with the corresponding content.

#let sort-info-to-list(wanted, info-dict) = { return wanted .filter(key => key in info-dict and (key in default_keys or not key in default_keys_submission)) .map(key => if key == "date" { format-date(info-dict.at(key), dict.locale) } else { [#dict.at(key, default: key) #info-dict.at(key)] }) }

This could do the trick

FussballAndy · 2025-10-31T08:27:35Z

Hi, are there any updates on this? I am planning to do some updates to the template and this is a bigger rework that could potentially influence other things.
If you currently have no time, for a temporary solution I would propose that

we rename title-sub to info-layout as I feel like that is a more intuitive name (both the argument and the file/export name)
reorganise the title-sub module/exports to only have exercise and submission exported
make it so that no additional info results in no title-sub/info bar. (maybe come up with a better name for the region?)
I feel like those would already add some usability improvement whilst still keeping the original intact.

implement change to creation of info based on exercise type

03a9058

St0rml force-pushed the change_exercise_selection_model branch from 1bcbaef to 03a9058 Compare July 30, 2025 17:05

JeyRunner reviewed Aug 2, 2025

View reviewed changes

St0rml added 5 commits August 3, 2025 17:51

catch info-layout: false option for complete custom subline

0f52ba9

dont render key for custom key-value pairs

565dc22

formatting

ca2f569

remove title-sub.typ from lib.typ and tudaexercise

b87fd05

remove title-sub import from main.typ

117d0a2

This was referenced Aug 3, 2025

Change the way to differentiate between tudaexercise-exercise and -submission #20

Open

autmatic term mechanism for exercises #23

Merged

St0rml and others added 4 commits August 3, 2025 23:20

fix if clause for custom subline

37c4b3b

add documentation

9dd687b

more documentation

d99accd

Merge branch 'main' into change_exercise_selection_model

0c9d7a6

St0rml force-pushed the change_exercise_selection_model branch from 6308689 to 0c9d7a6 Compare August 3, 2025 22:03

St0rml added 2 commits August 4, 2025 00:04

improve documentation

1c38ac5

remove title-sub import from main.typ

b3e370d

FussballAndy suggested changes Aug 4, 2025

View reviewed changes

St0rml added 11 commits August 9, 2025 16:38

linebreaks in code docu, title.typ

5dc3ab3

format title.typ

057fdab

replace if nesting and panic with assert

a03f941

format

661d9a1

update documentation for info (dictionary)

ae3d9ef

adapt documentation

240e0e3

fix assert and check if items "right", "left" in info-layout

3360f8f

adapt the way date gets displayed

2d1c1c3

format

6a336ad

hide subline completely when no relevant items present in info

2ca5a67

documentation updates

fcbe5eb

small fix, when info-layout is set to none

fdda054

St0rml mentioned this pull request Aug 9, 2025

New and Unified Translation System #26

Open

FussballAndy reviewed Aug 12, 2025

View reviewed changes



		let default_keys_exercise = ("term", "date", "sheet")
		let default_keys_submission= ("group", "tutor", "lecturer")

Change exercise type selection and allow for more flexible info box layout #21

Are you sure you want to change the base?

Change exercise type selection and allow for more flexible info box layout #21

Uh oh!

Conversation

St0rml commented Jul 30, 2025

Uh oh!

St0rml commented Jul 30, 2025

Uh oh!

JeyRunner left a comment

Choose a reason for hiding this comment

Uh oh!

JeyRunner Aug 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

St0rml commented Aug 9, 2025

Uh oh!

FussballAndy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FussballAndy commented Oct 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JeyRunner Aug 2, 2025 •

edited

Loading