Skip to content

Commit

Permalink
Fixed grammatical issues, improved readability and clarified some text.
Browse files Browse the repository at this point in the history
  • Loading branch information
krestenlaust committed Jan 26, 2024
1 parent adff796 commit d9bc1bc
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 13 deletions.
14 changes: 6 additions & 8 deletions report-template/chapters/introduction.typ
Original file line number Diff line number Diff line change
Expand Up @@ -51,23 +51,21 @@ To add a source, you just have to reference your `.bib` file like the following
#bibliography("sources/sample.bib")
```

In this project it's located in `main.typ`. Now it can be referred the same way a figure is referred: `@einstein` @einstein. A reference only shows up in the bibliography section if it has at least one mention.
In this project it is located in `main.typ`. Once a source is included as shown above, it can be referred the same way a figure is referred: `@einstein` @einstein. A reference only shows up in the bibliography section, if it has been mentioned at least once.


== Getting Started
How do I start?
You can start by modifying this template, or using the empty report template.

=== Write Typst Collaboratively
You can use #link("https://typst.app/")[Typst.app] to write collaboratively. Just download #link("https://github.com/krestenlaust/AAU-Typst-Template/")[this project] as zip, and upload the following to an empty typst project:
You can use #link("https://typst.app/")[Typst.app] to write collaboratively. Just download #link("https://github.com/krestenlaust/AAU-Typst-Template/")[this project] as zip, and upload either template to the empty typst project:

- main.typ
- template.typ
- (folder) AAUgraphics
- (folder) Chapters
- (folder) chapters
- (folder) sources

== Other Functions
This is the lorem ipsum function:
This is the lorem ipsum function, it can be useful to get a sense of the layout:
#lorem(20)

=== Contributions
#lorem(40)
2 changes: 1 addition & 1 deletion report-template/chapters/technical_elements.typ
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Below is an example of how to make it a figure.
@code:scala-snippet shows how to put a piece of code into a figure, and this text shows how to reference it.

=== Line numbers
So you want line numbers as well? This isn't natively supported#footnote([This is most likely because of the KISS-principle.]), but the community has developed a couple packages to solves this.
So you want line numbers as well? This isn't natively supported, but the community has developed a couple packages to solves this.

// TODO: Write section about using line numbers.

Expand Down
8 changes: 4 additions & 4 deletions report-template/chapters/understanding_typst.typ
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
= Command- and Markup-Mode
Typst has two modes of text. This text right here is written directly in markup mode. The default mode of a document is always markup mode. To enter command mode for a single command, the \# is used.
Typst has two modes of text. This text right here is written directly in markup mode. The default mode of a document is always markup mode. To enter command mode for a single command, the `#` is used.

rect()
#rect()

To enter markup mode in a command context/mode, use [], previously shown, this can be thought of as similar to a string in a general-purpose programming language#footnote("Typst also has a concept of strings (using double quotes \"), used primarily in functions, like this one right here.")#footnote([This could've also been written using this mode. This way its easier to markup *things* than in a string.]).
To enter markup mode in a command context/mode, use [], previously shown, this can be thought of as similar to a string in a general-purpose programming language#footnote("Typst also has a concept of strings (using double quotes \"), used primarily in functions, like this one right here.")#footnote([This could've also been written using the content mode (`[...]`). This way it's easier to markup *things* than in a string.]).

These two operators combined can be used for the following:
The operators can be combined to cancel each other out like so:
#[This is exactly the same as] writing the text like this.


To enter command-mode for multiple commands, use {}#footnote([This is generally only used in the template file, it's pretty rare to need to use multiple commands in a row, in documents like this one.])
To enter command-mode for multiple commands, you can use curly braces like so: `{...}`#footnote([This is generally only used in the template file, it's pretty rare to need to use multiple commands in a row, in documents like this one.])

== Further reading & Assistance
The Typst documentation has, for the most part, matured enough to answer any question. The documentation is located at https://typst.app/docs. Furthermore, the documentation site often appears in Google search results.
Expand Down

0 comments on commit d9bc1bc

Please sign in to comment.