diff --git a/README.md b/README.md index bf8754d..ef1c479 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,16 @@ For detailed installation instructions, please refer to the [official installati Nix and Docker users, please refer to the official installation guide for detailed instructions. ## Usage +### Set thesis metadata +Fill in your thesis details in the `common/metadata.typ` file: +* Degree (Bachelor or Master) +* Your study program +* English and German title +* Advisor and supervisor +* Your name (without e-mail address or matriculation number) +* The start and submission date + +### Build PDFs locally Once you have installed Typst, you can use it like this: ```sh # Creates `thesis.pdf` in working directory. diff --git a/common/metadata.typ b/common/metadata.typ new file mode 100644 index 0000000..9c0bc5d --- /dev/null +++ b/common/metadata.typ @@ -0,0 +1,10 @@ +// Enter your thesis data here: +#let titleEnglish = "(Title English)" +#let titleGerman = "(Title German)" +#let degree = "Bachelor" +#let program = "Information Systems" +#let supervisor = "Prof. Dr. Stephan Krusche" +#let advisors = ("Jolanda Krümelmonster, M.Sc.",) +#let author = "(Author)" +#let startDate = "(Start Date)" +#let submissionDate = "(Handover Date)" \ No newline at end of file diff --git a/proposal.typ b/proposal.typ index 3968a63..8d672ec 100644 --- a/proposal.typ +++ b/proposal.typ @@ -1,28 +1,30 @@ #import "proposal_template.typ": * #import "common/titlepage.typ": * +#import "common/metadata.typ": * + #titlepage( - title: "(Title English)", - titleGerman: "(Title German)", - degree: "Bachelor", - program: "Information Systems", - supervisor: "Prof. Dr. Stephan Krusche", - advisors: ("Jolanda Krümelmonster, M.Sc.",), - author: "(Author)", - startDate: "(Start Date)", - submissionDate: "(Handover Date)" + title: titleEnglish, + titleGerman: titleGerman, + degree: degree, + program: program, + supervisor: supervisor, + advisors: advisors, + author: author, + startDate: startDate, + submissionDate: submissionDate ) #show: project.with( - title: "(Title English)", - titleGerman: "(Title German)", - degree: "Bachelor", - program: "Information Systems", - supervisor: "Prof. Dr. Stephan Krusche", - advisors: ("Jolanda Krümelmonster, M.Sc.",), - author: "(Author)", - startDate: "(Start Date)", - submissionDate: "(Handover Date)" + title: titleEnglish, + titleGerman: titleGerman, + degree: degree, + program: program, + supervisor: supervisor, + advisors: advisors, + author: author, + startDate: startDate, + submissionDate: submissionDate ) diff --git a/thesis.typ b/thesis.typ index 7ca11c9..3bc9eba 100644 --- a/thesis.typ +++ b/thesis.typ @@ -5,32 +5,33 @@ #import "thesis_typ/acknowledgement.typ": * #import "thesis_typ/abstract_en.typ": * #import "thesis_typ/abstract_de.typ": * +#import "common/metadata.typ": * #cover( - title: "(Title English)", - degree: "Bachelor", - program: "Information Systems", - author: "(Author)", + title: titleEnglish, + degree: degree, + program: program, + author: author, ) #titlepage( - title: "(Title English)", - titleGerman: "(Title German)", - degree: "Bachelor", - program: "Information Systems", - supervisor: "Prof. Dr. Stephan Krusche", - advisors: ("Jolanda Krümelmonster, M.Sc.",), - author: "(Author)", - startDate: "(Start Date)", - submissionDate: "(Handover Date)" + title: titleEnglish, + titleGerman: titleGerman, + degree: degree, + program: program, + supervisor: supervisor, + advisors: advisors, + author: author, + startDate: startDate, + submissionDate: submissionDate ) #disclaimer( - title: "(Title English)", - degree: "Bachelor", - author: "(Author)", - submissionDate: "(Handover Date)" + title: titleEnglish, + degree: degree, + author: author, + submissionDate: submissionDate ) #acknowledgement() @@ -40,15 +41,15 @@ #abstract_de() #show: project.with( - title: "(Title English)", - titleGerman: "(Title German)", - degree: "Bachelor", - program: "Information Systems", - supervisor: "Prof. Dr. Stephan Krusche", - advisors: ("Jolanda Krümelmonster, M.Sc.",), - author: "(Author)", - startDate: "(Start Date)", - submissionDate: "(Handover Date)" + title: titleEnglish, + titleGerman: titleGerman, + degree: degree, + program: program, + supervisor: supervisor, + advisors: advisors, + author: author, + startDate: startDate, + submissionDate: submissionDate ) = Introduction