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 the \todo and \missingfigure commands from the todonotes package to the todo tool window. #3766

Merged
merged 5 commits into from
Dec 6, 2024

Conversation

slideclimb
Copy link
Collaborator

Fix #3673

Summary of additions and changes

  • Added the \todo and \missingfigure commands from the todonotes package to the todo tool window.

Some remarks on limitations and the implementation:

  • The \todo commands are counted twice in the total todo count for a file/project/etc because it matches both the new \todo and the existing todo patterns. We have more control on what appears in the tree, so it only appears once there.
  • According to the dev guide the EP to register these extra places is indexPatternSearch, but the only way seems to be using quite some internal api's. So no guarantees that this keeps working properly in the future.
  • The commands are not highlighted as todo items and are not customisable via the todo settings, as that is currently not possible (see IJPL-172245). Once this is fixed, we can probably change our implementation to only include the Searcher?

How to test this pull request

% todo testaqi
\todo{test}

\missingfigure{test}
  • Updated the documentation, or no update necessary
  • Added tests, or no tests necessary

@slideclimb slideclimb self-assigned this Nov 24, 2024
@PHPirates PHPirates changed the title 3673 todo Added the \todo and \missingfigure commands from the todonotes package to the todo tool window. Nov 25, 2024
@PHPirates PHPirates changed the title Added the \todo and \missingfigure commands from the todonotes package to the todo tool window. Add the \todo and \missingfigure commands from the todonotes package to the todo tool window. Nov 25, 2024
@PHPirates PHPirates added this to the Next milestone Nov 25, 2024
@PHPirates
Copy link
Collaborator

So if a user wants the editor highlighting of \todo's and correct information in the tool window, then the user needs to add a pattern for \todo and then use a filter to filter only on the default and the new \todo pattern?
I think that is nontrivial and should be added to our user documentation.

@PHPirates PHPirates modified the milestones: 0.9.9, Next Nov 29, 2024
@slideclimb slideclimb requested a review from PHPirates December 6, 2024 12:04
@PHPirates PHPirates merged commit 052a869 into master Dec 6, 2024
10 checks passed
@PHPirates PHPirates deleted the 3673-todo branch December 6, 2024 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Treat \todo commands similar to % todo comments
2 participants