#967 Don't highlight arbitrary capitalized comments as TODO

[Anonymous]

Currently, any arbitrary capitalized comment, e.g. %TODO, % FIXME, % ASK are highlighted as TODO item (green by default). This has been changed from only %TODO (without space!) previously used.

This was the resolution to a feature request that can be found here:
http://sourceforge.net/p/texstudio/feature-requests/773/

I find this solution problematic, because capitalization is also often used for important latex-related comments (e.g. % DO NOT CHANGE THIS LINE) or abbreviations. Highlighting them as TODO is not desired.

The end-user should have the possibility to define phrases or only TODO and FIXME should be highlighted. The purpose of that highlighting is pointing the writer to places where he still has some work to do. If notes or even arbitrary comments are highlighted the same way, this is not achieved.

[Till Fischer]

remark (i filed this request but wasn't logged in):

It should be considered to hightlight TODO not only if it appears in comments but also when in regular text. Most TODOs of mine should also be visible in the produced PDF.

[Denis Bitouzé]

Most TODOs of mine should also be visible in the produced PDF.

You may be interested in the todonotes package or similar ones.

[Till Fischer]

I know respective packages. What I didn't know was that "\todo" is also highlighted by TeXstudio. That's nice.

The original problem that there are several unwanted highlights when the first two characters of a comment are capitalized still remains though.

[Tim Hoffmann]

This functionality is coded into the language definition for tex. You may adapt it to your needs. See the
user manual.

Since the language definition is basically static, it's not easily possible to make the highlighted commands user-editable (apart for rewriting the language definition). Therefore there will be no change to the current behavior.

Alternatively, you may use two spaces % DO NOT ... as a workaround.

[Till Fischer]

Did you also consider the alternative suggestion "only TODO and FIXME should be highlighted" (i.e. static, not user-editable)?

I ask again because every .tex file I faced up to now contained several green markers throughout the document and almost certainly none of them are todo or fixme items. In fact, it took me pretty long to understand what kind of strange "error" these green lines might be... :-)

[Tim Hoffmann]

I don't want to revert the granted possibility highlighting arbitrary capitalized-word comments, because that was originally requested since some users use more than just TODO and FIXME.

Thinking about it, it really might not be to hard to make a dynamic option for it. However this needs time to look in, which I currently do not have.