Skip to content

Commit

Permalink
Add shortcodes for 'question' and 'answer'
Browse files Browse the repository at this point in the history
  • Loading branch information
lauft committed Jul 18, 2024
1 parent 00ff9a8 commit fd2896a
Show file tree
Hide file tree
Showing 230 changed files with 1,461 additions and 841 deletions.
10 changes: 7 additions & 3 deletions content/support/faq/faq.general.001.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ question: "How do I contribute to documentation?"

Back to the [FAQ](/support/faq)

### Q: How do I contribute to documentation?

{{< question>}}
# How do I contribute to documentation?
I would like to contribute a small change to the documentation.

In general, how should I go about submitting patches to the documentation?
I cannot find a Git repository containing the documentation.
{{< /question >}}

A: All our public repositories are listed here: https://github.com/GothenburgBitFactory
{{< answer >}}
All our public repositories are listed here: https://github.com/GothenburgBitFactory

Simply clone, modify, and create a pull-request.
{{< /answer >}}
10 changes: 6 additions & 4 deletions content/support/faq/faq.general.002.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "Are there any plans to create a package for <system>?"

Back to the [FAQ](/support/faq)

### Q: Are there any plans to create a package for <system>?

A: We don't do packaging, the community generally steps up.
{{< question >}}
### Are there any plans to create a package for \<system\>?
{{< /question >}}
{{< answer >}}
We don't do packaging, the community generally steps up.
Contact your distro and make a request.

{{< /answer >}}
10 changes: 7 additions & 3 deletions content/support/faq/faq.general.003.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@ title: "Taskwarrior - FAQ"
topic: "General"
question: "What is the project's coding style?"
---
Back to the [FAQ](/support/faq)

Q: Is there somewhere information about the coding style for the different programming languages used?

A: Make all changes and additions such that they blend in perfectly with the surrounding code, so it looks like only one person worked on the source, and that person is rigidly consistent.
{{< question "What is the project's coding style?" >}}
Is there somewhere information about the coding style for the different programming languages used?
{{< /question >}}
{{< answer >}}
Make all changes and additions such that they blend in perfectly with the surrounding code, so it looks like only one person worked on the source, and that person is rigidly consistent.

That's the general guideline, but to be more explicit about it, here are some of the rules:

Expand All @@ -16,3 +19,4 @@ That's the general guideline, but to be more explicit about it, here are some of
* No cuddled braces

https://github.com/GothenburgBitFactory/taskwarrior/blob/develop/doc/devel/contrib/coding_style.md
{{< /answer >}}
10 changes: 6 additions & 4 deletions content/support/faq/faq.general.004.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
title: "Taskwarrior - FAQ"
topic: "General"
question: "Which principles build the foundation for task?"
question: "Which principles build the foundation for Taskwarrior?"
---

Back to the [FAQ](/support/faq)

Q: Which principles build the foundation for task?

A:
{{< question >}}
### Which principles build the foundation for Taskwarrior?
{{< /question >}}
{{< answer >}}
* Open source is the best way to write software
* Open formats like JSON don't restrict users
* Flexibility with lots of features yields strange and wonderful real-world use-cases
* Scriptability is good
* Performance is important
{{< /answer >}}
8 changes: 5 additions & 3 deletions content/support/faq/faq.task.001.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ question: "How do I implement Pomodoro?"
---

Back to the [FAQ](/support/faq)

### Q: How do I implement Pomodoro?

{{< question >}}
### How do I implement Pomodoro?
{{< /question >}}
{{< answer >}}
Taskwarrior currently doesn't support the pomodoro technique, not because it doesn't have all the necessary features, but because it has no way to notify the user if a given point in time has arrived.
Remember: most of the time, Taskwarrior isn't running.

You can however use the pomodoro timer or any other timer software (KTeaTimer, Gnome's Tea Timer, Gnome's pomodoro shell extension, pyStopWatch, or any of the many timers out there), together with Taskwarrior to manage and prioritize your ToDo list.
{{< /answer >}}
8 changes: 5 additions & 3 deletions content/support/faq/faq.task.002.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@ question: "How do I remove an attribute?"
---

Back to the [FAQ](/support/faq)

### Q: How do I remove an attribute?

{{< question >}}
### How do I remove an attribute?
{{< /question >}}
{{< answer >}}
Modify the attribute and give it a blank value:

```
$ task 16 modify due:
```

Taskwarrior doesn't store blank values, so it deletes the attribute.
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.003.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "How do I list tasks that have no project?"

Back to the [FAQ](/support/faq)

### Q: How do I list tasks that have no project?

{{< question >}}
### How do I list tasks that have no project?
{{< /question >}}
{{< answer >}}
There are a few ways:

```
Expand All @@ -27,3 +29,4 @@ $ task project.not: list
$ task project != '' list
$ task +PROJECT list
```
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.004.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "How do I filter tasks containing words that are also commands?"

Back to the [FAQ](/support/faq)

### Q: How do I filter tasks containing words that are also commands?

{{< question >}}
### How do I filter tasks containing words that are also commands?
{{< /question >}}
{{< answer >}}
I have tasks with descriptions such as:

```
Expand Down Expand Up @@ -37,3 +39,4 @@ $ task -- info

The `--` operator is a directive that tells Taskwarrior to just treat all subsequent arguments as plain words.
It is also a good way to add a description that might contain things like `dep:`, `proj:`, tags or modifiers.
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.005.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@ question: "How do I hide the change history when using the info report?"

Back to the [FAQ](/support/faq)

### Q: How do I hide the change history when using the `info` report?

{{< question >}}
### How do I hide the change history when using the `info` report?
{{< /question >}}
{{< answer >}}
You need to turn off journaling, like this:

```
$ task config journal.info off
```

See `man taskrc` for more details.
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.006.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "How do I list tasks scheduled today?"

Back to the [FAQ](/support/faq)

### Q: How do I list tasks scheduled today?

{{< question >}}
### How do I list tasks scheduled today?
{{< /question >}}
{{< answer >}}
To filter tasks within a date range:

```
Expand All @@ -21,3 +23,4 @@ Alternately, do this:
$ task scheduled.after:today and scheduled.before:tomorrow list
```

{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.007.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "How do I bring back a task that I completed or deleted by mistake?"

Back to the [FAQ](/support/faq)

### Q: How do I bring back a task that I completed or deleted by mistake?

{{< question >}}
### How do I bring back a task that I completed or deleted by mistake?
{{< /question >}}
{{< answer >}}
Simply changing the `status` of the task to `pending` is enough, Taskwarrior takes care of the rest:

```
Expand All @@ -20,3 +22,4 @@ Here is how to see the 10 most recently completed or deleted tasks, with the mos
```
$ task limit:10 \( status:completed or status:deleted \) rc.report.all.sort:end- all
```
{{< /answer >}}
6 changes: 5 additions & 1 deletion content/support/faq/faq.task.008.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ question: "How do I improve output readability?"

Back to the [FAQ](/support/faq)

### Q: How do I improve output readability?
{{< question >}}
### How do I improve output readability?
{{< /question >}}

{{< answer >}}
You can use line breaks which allow blank lines between sort keys.
See [Report](/docs/report/#custom-reports) for details.
You can also use alternating line colors setting, which helps visually separate the tasks.
Expand All @@ -20,3 +23,4 @@ $ task color legend
```

Most color themes already support this.
{{< /answer >}}
6 changes: 5 additions & 1 deletion content/support/faq/faq.task.009.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ question: "How do I set the wait date to be 2 days before the due date?"

Back to the [FAQ](/support/faq)

### Q: How do I set the wait date to be 2 days before the due date?
{{< question >}}
### How do I set the wait date to be 2 days before the due date?
{{< /question >}}

{{< answer >}}
Taskwarrior can do date math, so use this:

```
Expand All @@ -22,3 +25,4 @@ You can also verify that date using the `calc` command:
$ task calc eom-2days
2018-01-30T00:00:00
```
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.010.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "How do I create a traditional GTD Next Actions list?"

Back to the [FAQ](/support/faq)

### Q: How do I create a traditional GTD Next Actions list?

{{< question >}}
### How do I create a traditional GTD Next Actions list?
{{< /question >}}
{{< answer >}}
I am looking to create a custom report that lists all pending tasks without a project and the single most urgent from each project.

The report you describe is not possible as a single custom report because it combines multiple independent filters.
Expand All @@ -19,3 +21,4 @@ Like this:
<https://taskwarrior.org/download/gtdnext.sh>

It's a bash script, and easily modifiable.
{{< /answer >}}
9 changes: 6 additions & 3 deletions content/support/faq/faq.task.011.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ question: "How do you run a report listing recurring task templates?"

Back to the [FAQ](/support/faq)

Q: List recurring task templates
{{< question >}}
### List recurring task templates

How do you run a report listing recurring task templates?

A: Using the built in reports:
{{< /question >}}
{{< answer >}}
Using the built in reports:

task status:recurring all
Note that you have to use `all` because the rest of the built in reports impose a status filter like `status:pending` or similar.
Expand All @@ -26,3 +28,4 @@ report.templates.filter=status:recurring
A: As a hack, you can also use `task status:recurring or status:recurring list`, which would translate to the filter `status:pending and status:recurring or status:recurring`.

A: 'info' and 'export' also have no filter.
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.012.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ question: "Why have attribute modifiers rather than the more readable and algebr

Back to the [FAQ](/support/faq)

### Q: Why have attribute modifiers (`urgency.over:10`) rather than the more readable and algebraic form (`urgency>10`)?

{{< question >}}
### Why have attribute modifiers (`urgency.over:10`) rather than the more readable and algebraic form (`urgency>10`)?
{{< /question >}}
{{< answer >}}
Taskwarrior already supports both forms.
The algebraic form requires that you escape any characters that the shell will otherwise interpret.

Expand Down Expand Up @@ -40,3 +42,4 @@ noword desc.noword:Hello desc !~ '\bHello\b' Boundaried word non-ma
```

See 'man task', for the `ATTRIBUTE MODIFIERS` and `EXPRESSIONS AND OPERATORS` sections.
{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.013.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ question: "How do I pipe a UUID into another task command?"

Back to the [FAQ](/support/faq)

### Q: How do I pipe a UUID into another task command?

{{< question >}}
### How do I pipe a UUID into another task command?
{{< /question >}}
{{< answer >}}
You can use Bash subprocess syntax to achieve this:

```
$ task $(task _uuids +FOO) modify -FOO +BAR
```

{{< /answer >}}
7 changes: 5 additions & 2 deletions content/support/faq/faq.task.014.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@ question: "How do I get the UUID of the last task added?"

Back to the [FAQ](/support/faq)

### Q: How do I get the UUID of the last task added?

{{< question >}}
### How do I get the UUID of the last task added?
{{< /question >}}
{{< answer >}}
There is a `LATEST` virtual tag for just this.
It corresponds to the most recently added task.

```
$ task +LATEST uuids
```
{{< /answer >}}
6 changes: 5 additions & 1 deletion content/support/faq/faq.task.015.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ question: "How do I change many due dates using one command?"

Back to the [FAQ](/support/faq)

### Q: How do I change many due dates using one command?
{{< question >}}
### How do I change many due dates using one command?
{{< /question >}}

{{< answer >}}
Something come up yesterday and completely derailed my day.
As a result, I have many tasks that need to be rescheduled to today.
What command can I use to change the due date of tasks I missed yesterday to be due today?
Expand All @@ -19,3 +22,4 @@ $ task +OVERDUE mod due:today
```

Depending on whether you want all overdue tasks or not, you'll need to adjust the filter.
{{< /answer >}}
6 changes: 5 additions & 1 deletion content/support/faq/faq.task.016.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ question: "How do I search for tasks?"

Back to the [FAQ](/support/faq)

### Q: How do I search for tasks?
{{< question >}}
### How do I search for tasks?
{{< /question >}}

{{< answer >}}
There are several ways to search the description and annotations of your tasks.
The first is to simply look for a search term:

Expand All @@ -27,3 +30,4 @@ Regular expressions support sophisticated search terms:
```
$ task /[A-Z]../ list
```
{{< /answer >}}
6 changes: 5 additions & 1 deletion content/support/faq/faq.task.017.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ question: "How do I create a task that recurs on more than one day of the week?"

Back to the [FAQ](/support/faq)

### Q: How do I create a task that recurs on more than one day of the week?
{{< question >}}
### How do I create a task that recurs on more than one day of the week?
{{< /question >}}

{{< answer >}}
This is not supported, but you can simulate this by creating multiple tasks due weekly on different days:

```
$ task add Do the thing due:monday recur:weekly
$ task add Do the thing due:friday recur:weekly
```
{{< /answer >}}
Loading

0 comments on commit fd2896a

Please sign in to comment.