Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add macro for TODO boxes #22

Merged
merged 3 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions common/utils.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#let TODO(body, color: yellow) = {
rect(
width: 100%,
radius: 3pt,
stroke: 0.5pt,
fill: color,
)[
#body
]
}
75 changes: 12 additions & 63 deletions proposal.typ
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#import "proposal_template.typ": *
#import "common/titlepage.typ": *
#import "common/metadata.typ": *
#import "common/utils.typ": TODO

#set document(title: titleEnglish, author: author)

Expand Down Expand Up @@ -29,61 +30,33 @@
)


// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: red,
)[
Before you start with your thesis, have a look at our guides on confluence! \ https://confluence.ase.in.tum.de/display/EduResStud/How+to+thesis
#TODO(color: red)[ // Remove this block
Before you start with your thesis, have a look at our guides on Confluence!
#link("https://confluence.ase.in.tum.de/display/EduResStud/How+to+thesis")
]

#set heading(numbering: none)
= Abstract
// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: yellow,
)[
#TODO[ // Remove this block
*Abstract*

- Provide a brief summary of the proposed work
- What is the main content, the main contribution?
- What is your methodology? How do you proceed?
]

#set heading(numbering: "1.1")
= Introduction

// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: yellow,
)[
#TODO[ // Remove this block
*Introduction*

- Introduce the reader to the general setting
- What is the environment?
- What are the tools in use?
]


= Problem

// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: yellow,
)[
#TODO[ // Remove this block
*Problem description*

- What is/are the problem(s)?
- Identify the actors and use these to describe how the problem negatively influences them.
- Do not present solutions or alternatives yet!
Expand All @@ -93,16 +66,8 @@


= Motivation

// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: yellow,
)[
#TODO[ // Remove this block
*Thesis Motivation*

- Outline why it is important to solve the problem
- Again use the actors to present your solution, but don’t be to specific
- Be visionary!
Expand All @@ -111,33 +76,17 @@
#pagebreak(weak: true)

= Objective

// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: yellow,
)[
#TODO[ // Remove this block
*Thesis Objective*

- What are the main goals of your thesis?
]


= Schedule

// TODO: Remove this block
#rect(
width: 100%,
radius: 10%,
stroke: 0.5pt,
fill: yellow,
)[
#TODO[ // Remove this block
*Thesis Schedule*

- When will the thesis Start (Always 15th of Month)
- Create a rough plan for your thesis (separate the time in sprints with a length of 2-4 Weeks)
- When will the thesis start
- Create a rough plan for your thesis (separate the time in sprints with a length of 2-4 weeks)
- Each sprint should contain several work items - Again keep it high-level and make to keep your plan realistic
- Make sure the work-items are measurable and deliverable
- No writing related tasks! (e.g. ”Write Analysis Chapter”)
Expand Down
Loading