feat: add ability to select us-letter with correct margins (#79)

yunanwg · Jan 21, 2025 · 7ebaeb4 · 7ebaeb4
1 parent 95e6b16
commit 7ebaeb4
Show file tree

Hide file tree

Showing 25 changed files with 48 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ It is recommended to:
 For the time being, upgrade can be achieved by manually "find and replace" the import statements in batch in your favorite IDE. For example:
 
 ```typst
-#import "@preview/brilliant-cv:2.0.0" -> #import "@preview/brilliant-cv:2.0.3"
+#import "@preview/brilliant-cv:2.0.0" -> #import "@preview/brilliant-cv:2.0.4"
 ```
 
 **Make sure you read the release notes to notice any breaking changes. We estimate that there would still be some as Typst has not reached to a stable release neither.**

diff --git a/lib.typ b/lib.typ
@@ -29,9 +29,16 @@
   // Page layout
   set text(font: fontList, weight: "regular", size: 9pt)
   set align(left)
+  let paper_size = metadata.layout.at("paper_size", default: "a4")
   set page(
-    paper: "a4",
-    margin: (left: 1.4cm, right: 1.4cm, top: 1cm, bottom: 1cm),
+    paper: {paper_size},
+    margin: {
+      if paper_size == "us-letter" {
+        (left: 2cm, right: 1.4cm, top: 1.2cm, bottom: 1.2cm)
+        } else {
+        (left: 1.4cm, right: 1.4cm, top: 1cm, bottom: 1cm)
+      }
+    },
     footer: _cvFooter(metadata),
   )
 
@@ -61,9 +68,16 @@
   // Page layout
   set text(font: fontList, weight: "regular", size: 9pt)
   set align(left)
+  let paper_size = metadata.layout.at("paper_size", default: "a4")
   set page(
-    paper: "a4",
-    margin: (left: 1.4cm, right: 1.4cm, top: 1cm, bottom: 1cm),
+    paper: {paper_size},
+    margin: {
+      if paper_size == "us-letter" {
+        (left: 2cm, right: 2cm, top: 1.2cm, bottom: 1.2cm)
+        } else {
+        (left: 1.4cm, right: 1.4cm, top: 1cm, bottom: 1cm)
+      }
+    },
     footer: _letterFooter(metadata),
   )
   set text(size: 12pt)

diff --git a/metadata.toml.schema.json b/metadata.toml.schema.json
@@ -31,6 +31,11 @@
           "description": "Spacing before entry descriptions",
           "pattern": "^[0-9]+pt$"
         },
+        "paper_size" : {
+          "type": "string",
+          "description": "Sets paper size and standard marigins, Optional values: us-letter. Default is a4.",
+          "pattern": "^(a4|us-letter|#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3}))$"
+        },
         "fonts": {
           "type": "object",
           "properties": {

diff --git a/template/cv.typ b/template/cv.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cv
+#import "@preview/brilliant-cv:2.0.4": cv
 #let metadata = toml("./metadata.toml")
 #let importModules(modules, lang: metadata.language) = {
   for module in modules {

diff --git a/template/letter.typ b/template/letter.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": letter
+#import "@preview/brilliant-cv:2.0.4": letter
 #let metadata = toml("./metadata.toml")
 
 

diff --git a/template/metadata.toml b/template/metadata.toml
@@ -14,6 +14,9 @@ language = "en"
     before_entry_skip = "1pt"
     before_entry_description_skip = "1pt"
 
+    # Optional: sets paper size and margins. Possible values: a4 (default), us-letter
+    paper_size = "a4"
+
     [layout.fonts]
         regular_fonts = ["Source Sans Pro", "Source Sans 3"]
         header_font = "Roboto"

diff --git a/template/modules_en/certificates.typ b/template/modules_en/certificates.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvHonor
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvHonor
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvHonor = cvHonor.with(metadata: metadata)

diff --git a/template/modules_en/education.typ b/template/modules_en/education.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry, hBar
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry, hBar
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_en/professional.typ b/template/modules_en/professional.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_en/projects.typ b/template/modules_en/projects.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_en/publications.typ b/template/modules_en/publications.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvPublication
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvPublication
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 

diff --git a/template/modules_en/skills.typ b/template/modules_en/skills.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvSkill, hBar
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvSkill, hBar
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 

diff --git a/template/modules_fr/certificates.typ b/template/modules_fr/certificates.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvHonor
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvHonor
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvHonor = cvHonor.with(metadata: metadata)

diff --git a/template/modules_fr/education.typ b/template/modules_fr/education.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry, hBar
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry, hBar
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_fr/professional.typ b/template/modules_fr/professional.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_fr/projects.typ b/template/modules_fr/projects.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_fr/publications.typ b/template/modules_fr/publications.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvPublication
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvPublication
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 

diff --git a/template/modules_fr/skills.typ b/template/modules_fr/skills.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvSkill, hBar
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvSkill, hBar
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 

diff --git a/template/modules_zh/certificates.typ b/template/modules_zh/certificates.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvHonor
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvHonor
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvHonor = cvHonor.with(metadata: metadata)

diff --git a/template/modules_zh/education.typ b/template/modules_zh/education.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry, hBar
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry, hBar
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_zh/professional.typ b/template/modules_zh/professional.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_zh/projects.typ b/template/modules_zh/projects.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvEntry
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvEntry
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 #let cvEntry = cvEntry.with(metadata: metadata)

diff --git a/template/modules_zh/publications.typ b/template/modules_zh/publications.typ
@@ -1,5 +1,5 @@
 // Imports
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvPublication
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvPublication
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 

diff --git a/template/modules_zh/skills.typ b/template/modules_zh/skills.typ
@@ -1,5 +1,5 @@
 // Import
-#import "@preview/brilliant-cv:2.0.3": cvSection, cvSkill, hBar
+#import "@preview/brilliant-cv:2.0.4": cvSection, cvSkill, hBar
 #let metadata = toml("../metadata.toml")
 #let cvSection = cvSection.with(metadata: metadata)
 

diff --git a/typst.toml b/typst.toml
@@ -1,6 +1,6 @@
 [package]
 name = "brilliant-cv"
-version = "2.0.3"
+version = "2.0.4"
 entrypoint = "lib.typ"
 authors = ["Yunan Wang <https://github.com/mintyfrankie>"]
 license = "Apache-2.0"