Bug 135433 - Add support for "TK" keyword for content writing
Summary: Add support for "TK" keyword for content writing
Status: RESOLVED WORKSFORME
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Writer (show other bugs)
Version:
(earliest affected)
6.4.3.2 release
Hardware: All All
: medium enhancement
Assignee: Not Assigned
URL:
Whiteboard:
Keywords: needsUXEval
Depends on:
Blocks:
 
Reported: 2020-08-04 11:38 UTC by L Duperval
Modified: 2020-08-11 13:21 UTC (History)
4 users (show)

See Also:
Crash report or crash signature:


Attachments
Example implementation from Mediium (6.84 KB, image/png)
2020-08-04 11:39 UTC, L Duperval
Details
Macro to insert image page margin (1.75 KB, text/plain)
2020-08-06 15:47 UTC, Regina Henschel
Details

Note You need to log in before you can comment on or make changes to this bug.
Description L Duperval 2020-08-04 11:38:18 UTC
Description:
Hi,

In the content writing/copywriting world, we often use the code "TK" to identify a section of the text that needs to be reviewed.

I would like a possibility to highlight this as a change so it can be identified easily when scanning the document.

So, for example, if I write this paragraph and I'm not too sure what to do, I would put TK and then, when I'm reviewing the document, I would like to see a change par (or a paragraph highlight of sorts) signaling that I need to pay particular attention to this section.

(Some people might choose to used TBD instead of TK, but the standard is TK).

Steps to Reproduce:
1. Write a sentence with TK in it (all caps, complete word)
2. A highlight appears on the left-hand margin of the paragraph.


Actual Results:
New feature

Expected Results:
See attached image


Reproducible: Always


User Profile Reset: No



Additional Info:
Nothing.
Comment 1 L Duperval 2020-08-04 11:39:09 UTC
Created attachment 163931 [details]
Example implementation from Mediium
Comment 2 Heiko Tietze 2020-08-05 13:24:46 UTC
https://en.wikipedia.org/wiki/To_come_(publishing)

In other words a "// TODO: foo" comment. Sounds like a legacy convention to me worth to look for alternatives. Or am I wrong?
Comment 3 L Duperval 2020-08-05 23:59:56 UTC
You could say it's like a TODO but I see it more like a change marker. When you review changes, anything that's been modified is highlighted in the margin, so it catches your eye as you are skimming. I'm looking for something similar for this feature. The keyword could be configurable (TK, TBD, TODO, for example).
Comment 4 Heiko Tietze 2020-08-06 10:28:11 UTC
I dislike the idea to parse the text. TK (and any other text) can be inserted with a different context (https://www.urbandictionary.com/define.php?term=TK). How about a dedicated command that set's the flag for a paragraph instead? And to integrate it with existing features we could show it like comments, maybe with another shape.
Comment 5 Regina Henschel 2020-08-06 15:47:57 UTC
Created attachment 164008 [details]
Macro to insert image page margin

I think, that such markers can be made with an image in the page margin. Such can be done with a macro and the macro can be bound to an icon or shortcut. Such can be provided by an extension.

The attachment contains a principle macro for such task. To test it, put a small image with filename 'warning.png' into your user folder where the file 'registrymodifications.xcu' is located. You can make an empty module in the Basic IDE and then import the attached macro into it.
Comment 6 Heiko Tietze 2020-08-07 11:02:04 UTC
(In reply to Regina Henschel from comment #5)
> Macro to insert image page margin

Nice solution, could be finalized and submitted to the extension site. Not responding to a keyword though. Should we resolve as WF, L., and realize the feature per extension?
Comment 7 L Duperval 2020-08-07 12:20:06 UTC
Hi,

I've been dealing with a lot of unexpected situations so I haven't tried it yet. I promise to look at this today and let you know.
Comment 8 L Duperval 2020-08-09 02:51:22 UTC
I took a look and I made it work. Something to improve is to make it a character anchor. That way, if I add more information in the paragraph, the image moves with the text too. I will probably need to fiddle with the code a bit on my end, but it does the trick. I found how to make it a character (easy enough) but I didn't try to make it fit in the margin correctly.

Thanks!
Comment 9 Heiko Tietze 2020-08-11 13:21:27 UTC
(In reply to L Duperval from comment #8)
> I took a look and I made it work. 

Please consider to share at https://extensions.libreoffice.org/ when done. Resolving the request as WFM.