1 API

The following is the list of modules provided by this library. The stylesheet and the script that present this chapter in a browser are written beside it, as dokgen.css and dokgen.js; the manual says how a build points at them.


1.1 (iter-vitae defaults)

1.1.1 Overview

1.1.2 Variables

Variable: address-lines
()
Variable: display-name
()
Variable: document-theme
ef-cyprus
Variable: driver-licenses
()
Variable: education
()
Variable: interests-hobbies
()
Variable: job-title
()
()
Variable: jobs
()
Variable: language-proficiency
((en (1 . "Elementary") (2 . "Limited working") (3 . "Professional working") (4 . "Full professional") (5 . "Native or bilingual")) (nl (1 . "Elementair") (2 . "Beperkt werkzaam") (3 . "Professioneel werkzaam") (4 . "Volledig professioneel") (5 . "Moedertaal of tweetalig")) (es (1 . "Elemental") (2 . "Laboral limitado") (3 . "Profesional") (4 . "Profesional pleno") (5 . "Nativo o bilingüe")))
Variable: languages
()
Variable: personal-contact
()
()
Variable: profile-picture
#f
Variable: short-intro
()
Variable: skills
()
Variable: titles
((education (en . "Education") (nl . "Opleiding") (es . "Educación")) (driver-license (en . "Driving licence") (nl . "Rijbewijs") (es . "Permiso de conducir")) (interests-hobbies (en . "Interests") (nl . "Interesses") (es . "Intereses")) (language (en . "Languages") (nl . "Talen") (es . "Idiomas")) (language-name (en . "Language") (nl . "Taal") (es . "Idioma")) (my-links (en . "Me on the Internet") (nl . "Mijn links") (es . "Enlaces")) (speaking (en . "Speaking") (nl . "Spreken") (es . "Expresión oral")) (reading (en . "Reading") (nl . "Lezen") (es . "Lectura")) (writing (en . "Writing") (nl . "Schrijven") (es . "Expresión escrita")) (short-intro (en . "Profile") (nl . "Profiel") (es . "Perfil")) (professional-summary (en . "Professional Summary") (nl . "Professioneel profiel") (es . "Resumen profesional")) (skills (en . "Skills") (nl . "Vaardigheden") (es . "Habilidades")) (additional-information (en . "Additional Information") (nl . "Aanvullende informatie") (es . "Información adicional")) (work-experience (en . "Work Experience") (nl . "Werkervaring") (es . "Experiencia profesional")))

1.2 (iter-vitae html)

1.2.1 Overview

1.2.2 Procedures

Procedure: iter-vitae-curriculum-page KEY: #:locale #:persona #:resources

Undocumented procedure.

Procedure: sxml->xml tree OPT: port escape?

Serialize the sxml tree tree as XML. The output will be written to the current output port, unless the optional argument port is present.


1.3 (iter-vitae main)

1.3.1 Overview

  • main — An undocumented procedure.

1.3.2 Procedures

Procedure: main KEY: #:args

Undocumented procedure.


1.4 (iter-vitae pdf)

1.4.1 Overview

1.4.2 Procedures

Procedure: browser-command

Undocumented procedure.

Procedure: render-html-to-pdf html pdf KEY: #:browser

Print html to pdf with headless Chromium/Chrome.


1.5 (iter-vitae prelude)

1.5.1 Overview

1.5.2 Macros

Macro: get-setting x

Get a setting for iter-vitae, either from persona or from default values.

1.5.3 Parameters

Parameter: font-base

Default value:

"https://jointhefreeworld.org/static-assets/fonts/"

1.5.4 Procedures

Procedure: asset-css name OPT: resources

Undocumented procedure.

Procedure: assq-ref-all-or-lang al k

Undocumented procedure.

Procedure: build-asset-library files

Undocumented procedure.

Procedure: decode-html-entities value

Undocumented procedure.

Procedure: delete-file-tree path

Undocumented procedure.

Procedure: external-url value

Undocumented procedure.

Procedure: format-date-range value

Undocumented procedure.

Undocumented procedure.

Procedure: language-proficiency-label persona locale level

Undocumented procedure.

Procedure: load-asset-library OPT: resources

Undocumented procedure.

Procedure: locale-code locale

Undocumented procedure.

Procedure: log msg . args

Undocumented procedure.

Procedure: log-error msg . args

Undocumented procedure.

Procedure: log-info msg . args

Undocumented procedure.

Procedure: log-message msg

Undocumented procedure.

Procedure: make-directories path

Undocumented procedure.

Procedure: mk-class xs

Undocumented procedure.

Procedure: persona-profile-picture persona

Undocumented procedure.

Procedure: personal-contact-value persona key

Undocumented procedure.

Undocumented procedure.

Procedure: plain-text value

Undocumented procedure.

Procedure: resolve-profile-picture value OPT: base-directory

Undocumented procedure.

Procedure: self-hosted-faces KEY: #:base

The ‘@font-face’ block that declares the three families, each file addressed from base – the ‘font-base’ parameter unless one is given.

Procedure: tel-url value

Undocumented procedure.

Procedure: temporary-directory

Undocumented procedure.


1.6 (iter-vitae renderer)

This module turns a persona file into the documents a reader gets.

The persona is loaded as the module (iter-vitae persona), and every setting is read from it with get-setting, falling back to (iter-vitae defaults) for anything the file leaves out. The chosen theme, a pair of procedures in (iter-vitae theme registry), turns those settings into SXML, and a writer renders it: html.scm serialises the page, text.scm flattens the ATS body, and pdf.scm prints the HTML through a browser.

Mermaid diagram, as source:

flowchart LR
  persona["persona .scm"] --> settings["get-setting + defaults"]
  settings --> theme["theme registry: persona to SXML"]
  theme --> html["html.scm: index.html"]
  theme --> text["text.scm: resume.txt"]
  html --> pdf["pdf.scm: resume.pdf"]

--all-locales and --all-themes write the same document once per locale and once per theme below one freshly cleared destination, which is why the destination’s lifecycle belongs to the caller here and not to a writer.

1.6.1 Overview

1.6.2 Procedures

Procedure: persona-locales persona KEY: #:fallback

Undocumented procedure.

Procedure: render-curriculum KEY: #:locale #:destination #:resources #:file #:format #:all-locales? #:all-themes?

Undocumented procedure.


1.7 (iter-vitae text)

1.7.1 Overview

1.7.2 Procedures

Procedure: render-plain-text KEY: #:locale #:persona

Render persona as a plain-text resume for locale.


1.8 (iter-vitae theme ats)

1.8.1 Overview

1.8.2 Procedures

Procedure: ats-html-template KEY: #:title #:body #:locale #:persona #:resources

Undocumented procedure.

Procedure: ats-main-body KEY: #:locale #:persona

Undocumented procedure.


1.9 (iter-vitae theme ef-cyprus-faces)

1.9.1 Overview

1.9.2 Variables

Variable: a-face
"cursor-pointer font-bold font-sans hover:text-asparagus-300 hover:underline md:my-3 md:text-lg my-2 text-asparagus-700 text-md"
Variable: address-face
"font-sans md:my-2 md:text-md my-1 text-onyx-500 text-sm"
Variable: bullet-face
"font-sans leading-6 md:leading-7 md:ml-4 md:text-lg ml-2 text-md text-onyx-500"
Variable: display-name-face
"font-light font-serif lg:text-6xl md:text-5xl my-3 text-4xl text-onyx-300"
Variable: first-td-face
"font-bold md:px-5 md:py-2 md:text-md px-3 py-1 text-onyx-100 text-sm"
Variable: h2-special-face
"font-light font-sans hover:underline md:text-2xl my-1 no-underline text-asparagus-700 text-xl uppercase"
Variable: h4-face
"font-light md:my-2 md:text-2xl my-1 text-onyx-500 text-xl uppercase"
Variable: h5-em-face
"font-light md:text-md text-onyx-300 text-sm"
Variable: h5-face
"font-light md:text-lg text-md text-onyx-700"
Variable: h5-strong-face
"font-medium md:text-lg text-md text-onyx-700"
Variable: hr-face
"border-t-2 border-t-onyx-200 md:my-4 my-2"
Variable: p-face
"font-sans leading-7 max-w-prose md:text-lg my-4 text-md text-onyx-500 w-full"
Variable: small-a-face
"cursor-pointer font-bold font-sans hover:text-asparagus-300 hover:underline md:my-2 md:text-md my-1 no-underline text-asparagus-700 text-sm"
Variable: table-face
"bg-stone-300 md:my-8 md:rounded-xl my-4 rounded-lg shadow-md table-auto text-center w-full"
Variable: td-face
"md:px-5 md:py-2 md:text-md px-3 py-1 text-onyx-100 text-sm"
Variable: th-face
"font-light md:px-4 md:text-md px-2 py-1 text-sm uppercase whitespace-nowrap"
Variable: top-row-face
"md:py-2 py-1"

1.10 (iter-vitae theme ef-cyprus)

1.10.1 Overview

1.10.2 Procedures

Procedure: ef-cyprus-html-template KEY: #:title #:body #:locale #:persona #:resources

Undocumented procedure.

Procedure: ef-cyprus-main-body KEY: #:locale #:persona

Undocumented procedure.


1.11 (iter-vitae theme fatum-faces)

1.11.1 Overview

1.11.2 Variables

Variable: a-face
"cursor-pointer font-bold font-sans hover:text-jeans-blue-300 hover:underline md:my-3 md:text-lg my-2 text-jeans-blue-700 text-md"
Variable: address-face
"font-sans md:my-2 md:text-md my-1 text-onyx-500 text-sm"
Variable: bullet-face
"font-sans leading-6 mb-2 md:leading-7 md:ml-4 md:text-lg ml-2 text-md text-onyx-500"
Variable: display-name-face
"font-light font-sans lg:text-6xl md:text-5xl my-3 text-4xl text-onyx-300"
Variable: first-td-face
"font-bold md:px-5 md:py-2 md:text-md px-3 py-1 text-onyx-100 text-sm"
Variable: h2-special-face
"font-light font-sans hover:underline md:text-2xl my-1 no-underline text-jeans-blue-700 text-xl uppercase"
Variable: h4-face
"font-light md:my-2 md:text-2xl my-1 text-onyx-500 text-xl uppercase"
Variable: h5-em-face
"font-light md:text-md text-onyx-300 text-sm"
Variable: h5-face
"font-semibold md:text-lg text-md text-onyx-700"
Variable: h5-strong-face
"font-semibold md:text-lg text-md text-onyx-700"
Variable: hr-face
"border-t-2 border-t-onyx-300 md:my-4 my-2"
Variable: p-face
"font-sans leading-7 max-w-prose md:text-lg my-4 text-md text-onyx-500 w-full"
Variable: small-a-face
"cursor-pointer font-bold font-sans hover:text-jeans-blue-300 hover:underline md:my-2 md:text-md my-1 no-underline text-jeans-blue-700 text-sm"
Variable: table-face
"bg-stone-300 md:my-8 md:rounded-xl my-4 rounded-lg shadow-md table-auto text-center w-full"
Variable: td-face
"md:px-5 md:py-2 md:text-md px-3 py-1 text-onyx-100 text-sm"
Variable: th-face
"font-light md:px-4 md:text-md px-2 py-1 text-sm uppercase whitespace-nowrap"
Variable: top-row-face
"md:py-2 py-1"

1.12 (iter-vitae theme fatum)

1.12.1 Overview

1.12.2 Procedures

Procedure: fatum-html-template KEY: #:title #:body #:locale #:persona #:resources

Undocumented procedure.

Procedure: fatum-main-body KEY: #:locale #:persona

Undocumented procedure.


1.13 (iter-vitae theme fundamental)

1.13.1 Overview

1.13.2 Procedures

Procedure: fundamental-html-template KEY: #:title #:body #:locale #:persona #:resources

Undocumented procedure.

Procedure: fundamental-main-body KEY: #:locale #:persona

Undocumented procedure.


1.14 (iter-vitae theme lapis-faces)

1.14.1 Overview

1.14.2 Variables

Variable: a-face
"cursor-pointer font-bold font-serif hover:text-prussian-blue-300 hover:underline md:my-3 md:text-lg my-2 text-jeans-blue-700 text-md"
Variable: address-face
"font-mono md:my-2 md:text-sm my-1 text-onyx-500 text-xs"
Variable: bullet-face
"font-serif leading-6 mb-2 md:leading-7 md:ml-4 md:text-lg ml-2 text-md text-onyx-500"
Variable: display-name-face
"font-light font-serif lg:text-6xl md:text-5xl my-3 text-4xl text-onyx-700"
Variable: first-td-face
"font-bold font-serif md:px-5 md:py-2 md:text-md px-3 py-1 text-onyx-700 text-sm"
Variable: h2-special-face
"font-mono font-normal hover:underline md:text-md my-1 no-underline text-prussian-blue-300 text-sm tracking-wide uppercase"
Variable: h4-face
"font-mono font-normal md:my-2 md:text-md my-1 text-onyx-500 text-sm tracking-wide uppercase"
Variable: h5-em-face
"font-light font-serif italic md:text-md text-onyx-300 text-sm"
Variable: h5-face
"font-semibold font-serif md:text-lg text-md text-onyx-700"
Variable: h5-strong-face
"font-semibold font-serif md:text-lg text-md text-onyx-900"
Variable: hr-face
"border-t-2 md:my-4 my-2"
Variable: p-face
"font-serif leading-7 max-w-prose md:text-lg my-4 text-md text-onyx-500 w-full"
Variable: small-a-face
"cursor-pointer font-bold font-serif hover:text-prussian-blue-300 hover:underline md:my-2 md:text-md my-1 no-underline text-jeans-blue-700 text-sm"
Variable: table-face
"bg-stone-300 md:my-8 md:rounded-xl my-4 rounded-lg shadow-md table-auto text-center w-full"
Variable: td-face
"font-serif md:px-5 md:py-2 md:text-md px-3 py-1 text-onyx-500 text-sm"
Variable: th-face
"font-mono font-normal md:px-4 md:text-sm px-2 py-1 text-onyx-300 text-xs tracking-wide uppercase whitespace-nowrap"
Variable: top-row-face
"md:py-2 py-1"

1.15 (iter-vitae theme lapis)

1.15.1 Overview

1.15.2 Procedures

Procedure: lapis-html-template KEY: #:title #:body #:locale #:persona #:resources

Undocumented procedure.

Procedure: lapis-main-body KEY: #:locale #:persona

Undocumented procedure.


1.16 (iter-vitae theme registry)

1.16.1 Overview

1.16.2 Procedures

Procedure: normalize-theme theme

Return theme when it is known, otherwise the default theme.

Procedure: theme-procedures theme

Return a pair of the HTML template and body procedures for theme.

1.16.3 Variables

Variable: document-themes
(ats fatum lapis ef-cyprus fundamental)

1.17 (iter-vitae wizard)

1.17.1 Overview

1.17.2 Procedures

Procedure: level-from-answer answer

Undocumented procedure.

Procedure: parse-locales value

Undocumented procedure.

Procedure: persona-source persona OPT: file KEY: #:locales

Undocumented procedure.

Procedure: run-wizard KEY: #:file #:locale #:locales

Undocumented procedure.