diff --git a/Template-Example-guide.pdf b/Template-Example-guide.pdf index 0a09e37..f2759b7 100644 Binary files a/Template-Example-guide.pdf and b/Template-Example-guide.pdf differ diff --git a/chapters/01-Introduction.typ b/chapters/01-Introduction.typ index 59c2d18..4a04a2b 100644 --- a/chapters/01-Introduction.typ +++ b/chapters/01-Introduction.typ @@ -1,4 +1,9 @@ -#import "../template.typ": * +#import "/template.typ": * + +// Keep the import above, the following is just an example + + += Introduction Fist, in the `thesis.typ` file, adapt the configuration to match your requirements. For further configuration, look in the upper part of the `template.typ` file, @@ -13,26 +18,19 @@ but one could translate it... To configure your the language of your thesis, set the `language` parameter to either `en` (default) or `de`. -*Note* that the template needs to know your first chapter, -you can supply it if it is not "Introduction" using the `first_chapter_title` parameter. - #figure(```typ #show: thesis.with( ... - first_chapter_title = "Introduction but with another title", + company: ( + name: "Hewlett Packard Enterprise", + image: "assets/hpe.svg", + ), language: "en", ) ```, kind: "code", supplement: "Code example", - caption: [Code example explaining how to configure language and a different first chapter] + caption: [Code example explaining how to configure language and your company] ) -// By default, the template will *not* apply a pagebreak -// on non-top-level headings to avoid headings without content -// on the same page but can be enabled. -// The threshold percentage on the page can be configured -// by providing the `heading_pagebreak_percentage` propery like `0.7` or `none`. -// Top-level headings will always have a (weak) pagebreak. - == Bibliography As for bibliography / reference listing, @@ -53,15 +51,19 @@ To switch between bibliography formats, change the above to the following: caption: [Code example on how to use different bibliography formats with this template] ) -By default, this template displayes ISBNs in the Bibliography. +By default, this template displays ISBNs in the Bibliography. If no DOI is known, the ISBN is shown instead, and as a fallback the URL if available. This deviates from the normal/usual IEEE citation style. -Do disable this behaiviour and use the normal IEEE, +To disable this behavior and use the normal IEEE, set ```typ customized_ieee_citations = false```. +You can provide a reference to a good reference @tanenbaum_os[p. 123] like: +#box[```typ @tanenbaum_os```] or #box[```typ @tanenbaum_os[p. 123]```]. +They will also show up in the bibliography. + == Proposed Structure -But of cause, you can do it as you like. +Of cause, you can do it as you like... Put each chapter in the `chapter/` directory, prefixed i.e. with `01-` if it is the first chapter. @@ -78,22 +80,29 @@ If your chapter gets too large for one file, create a subdirectory in `chapters` with the chapters name, and create files for the different sections. +At the beginning of each `.typ` file, place the following to have all functions accessible: +```typ +#import "/template.typ": * +``` + == Acronyms -These are implemented provided by this template, not typst itself. +These are implemented provided by this template, not Typst itself. You can use them like: ```typ #acro("HPE") -#acro("HPE", pref: true) // To prefer the long version +#acro("HPE", pref: "long") // To prefer the long version #acro("JSON", append: "-schemata") ``` + #acro("HPE") -+ #acro("HPE", pref: true) // To prefer the long version ++ #acro("HPE", pref: "long") // To prefer the long version + #acro("JSON", append: "-schemata") +Now, once used, acronyms, for example like #acro("HPE"), are displayed in their short form by default. + == TODO marker Well, if you are too lazy to write now, @@ -106,7 +115,7 @@ just add a todo-marker. For example: #todo([I could probably write more on how to use this template and Typst in general, if I wouldn't be too lazy...]) -And the template makes sure it is well readable in the PDF and not forgotten. +And the template makes sure it is well readable in the PDF and and refrains you from signing a document which includes these TODO-markers. == Once you are done @@ -115,3 +124,5 @@ Use the `signature` property. Set it to `hide`, to leave some blank space for you to sign manually, e.g. in a printed version. Or put in the path to your signature image or svg. + +Note that having TODO-markers in your document will refrain you from compiling a signed document to ensure they are not forgotten. diff --git a/literature.bib b/literature.bib new file mode 100644 index 0000000..fc8d8c2 --- /dev/null +++ b/literature.bib @@ -0,0 +1,11 @@ +@book{tanenbaum_os, + title = {Modern Operating Systems}, + author = {Tanenbaum, Andrew S. and Bos, Herbert}, + date = {2015}, + edition = {4. ed}, + publisher = {Prentice Hall}, + location = {Boston}, + isbn = {978-0-13-359162-0 978-1-292-06142-9}, + langid = {english}, + pagetotal = {1101} +} diff --git a/literature.yml b/literature.yml deleted file mode 100644 index db249af..0000000 --- a/literature.yml +++ /dev/null @@ -1,2 +0,0 @@ -# format: https://github.com/typst/hayagriva/blob/main/docs/file-format.md - diff --git a/template.typ b/template.typ index aef0d91..3116f9f 100755 --- a/template.typ +++ b/template.typ @@ -137,7 +137,7 @@ // Path to your bibliography file // You may use `.yml` for Hayagriva format // or `.bib` for BibLaTeX format - bibliography_path: "literature.yml", + bibliography_path: "literature.bib", // Citation style: // Customized includes ISBNs and // writes DOI in capital letters @@ -188,6 +188,7 @@ // suggested font and font size by the DHBW style guide #set text( font: "Libertinus Serif", + // font: "New Computer Modern", // font: "New Computer Modern Sans", size: 12pt, hyphenate: false, diff --git a/thesis.pdf b/thesis.pdf deleted file mode 100644 index 190b194..0000000 Binary files a/thesis.pdf and /dev/null differ diff --git a/thesis.typ b/thesis.typ index 72e2a98..5cbec12 100755 --- a/thesis.typ +++ b/thesis.typ @@ -16,6 +16,10 @@ language: "en", supervisor: "Someone", signature: none, // TODO + bibliography_path: "literature.bib", + additional_preamble: ( + // You could put files to place before the table of contents here + ) ) // NOTE: https://www.dhbw.de/fileadmin/user_upload/Dokumente/Dokumente_fuer_Studierende/191212_Leitlinien_Praxismodule_Studien_Bachelorarbeiten.pdf @@ -25,19 +29,9 @@ // incl. graphics and tables // - must document: task, process of implementation, solutions and results -= Introduction - +// Include your chapters here #include "./chapters/01-Introduction.typ" -#pagebreak() - -= Technical Background - -== Spell checking - -You can use #link("https://github.com/crate-ci/typos")[Typos], -but I am too lazy to explain. - = Summary and Conclusion #lorem(250) diff --git a/typos.toml b/typos.toml deleted file mode 100644 index e5b8a95..0000000 --- a/typos.toml +++ /dev/null @@ -1,10 +0,0 @@ - -[default.extend-words] -Mosquitto = "Mosquitto" -Hashi = "Hashi" # HashiCorp Vault - -[files] -extend-exclude = [ - "/template.typ", - "/images/" -]