Skip to content

Commit

Permalink
Update documentation about todo tool window
Browse files Browse the repository at this point in the history
  • Loading branch information
slideclimb committed Dec 6, 2024
1 parent b05efd4 commit ccf430e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
16 changes: 16 additions & 0 deletions Writerside/topics/Code-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,19 @@ An example:

On Linux, the Mendeley format is also supported, which is of the form
`file = {:home/user/.local/share/data/Mendeley Ltd./Mendeley Desktop/Downloaded/filename.pdf:pdf;:home/user/.local/share/data/Mendeley Ltd./Mendeley Desktop/Downloaded/filename2.pdf:pdf}`

## TODO view

_Since b0.9.9_

<ui-path>View | Tool Windows | TODO</ui-path>

The TODO view by default shows all `todo` comments and `\todo{}` and `\missingfigure{}` commands.
Highlighting of the commands in the IDE by default is currently not enabled due to API limitations, but can be achieved by adding the following patterns to <ui-path>File | Settings | Editor | TODO </ui-path>:

- `\\todo\b`, case sensitive is `true`
- `\\missingfigure\b`, case sensitive is `true`

However, this adds the items to the tool window a second time.
To avoid this, create a filter and include all patterns.
Magic.
2 changes: 1 addition & 1 deletion src/nl/hannahsten/texifyidea/index/LatexTodoSearcher.kt
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import nl.hannahsten.texifyidea.util.magic.CommandMagic
import nl.hannahsten.texifyidea.util.matches

/**
* Provides the "to do" item in the toolwindow and highlighting in the editor.
* Provides the "to do" item in the toolwindow.
*/
@Suppress("UnstableApiUsage")
class LatexTodoSearcher : QueryExecutorBase<IndexPatternOccurrence, IndexPatternSearch.SearchParameters>() {
Expand Down

0 comments on commit ccf430e

Please sign in to comment.