Expose file properties to file contents

[pincq]

I would like to use something like %File.status: Second Draft or %File.status: [index] to both read and update the document status / importance / other file property.

1. It reduces how often I have to reach for the mouse.
2. One of my builds is configured to print comments, notes, and body text. Adding the draft stage / status to my notes and top matter section would be useful context when reviewing the exported manuscript.

[vkbo]

I think you need to clarify, because I have absolutely no idea what you're asking for here. 😃

[pincq]

Sorry :)

I would like to reference the file status within the document, and also to change the file status by changing the comment. Similar to the auto-populated tag lists.

I export my manuscript to pdf so I can review them and annotate on my e-ink tablet.
I have found it useful to include comments, synopsis, etc. at the top so I have context for the sections I am reviewing.

To extend the use of a %File special comment type, using it to access other file properties might be useful:

%File.status
%File.importance
%File.wordCount or [file:wordCount]

[vkbo]

I can't remove the existing status/importance implementation because it is free form and people use it in a myriad of different ways and not necessarily as I originally intended. I also cannot change them to be settable by text commands, because the point-and-click path is still available and writing changes to the documents violates a core design principle of novelWriter. Neither do they map to context correctly, because the meta data is per-heading, not per-file. (Which is exactly why status/importance lives in the project tree, not the documents, in the first place.)

I think this lands in the scope of story structure comments or notes instead. If all you're after is to have them exposed in the PDF, then that is already covered. If you're after more granular control, then we can certainly add that. I'm also fine with adding a new comment category since these are generally non-disruptive. They're invisible until someone uses them. However, %File is the wrong context scope here since "file" is a unit that only exists inside the project tree. The app works on chapters and scenes.

We can also view the request from a different angle and see if there are better ways to utilise the status meta data.

1. The information can be injected into the document at build time. We already have fields that will be populated at build, currently used for word count. One thing that may be valuable is allowing the injection of a meta data string under each heading, and let you define the format of that string. It could include word count, file status/importance, dialogue to prose ratio, etc.
2. We could make it easier to set status/importance from keyboard. I'm planning a command syntax feature where typing a trigger character and text will trigger an action. Mostly intended for auto-insert of text, but could easily allow some additional commands. See Add text auto-insert commands #2672.

We can do both of those, although they'd be two different tickets with different dependencies.

[vkbo]

Actually, on point 2 there, I have already thought about adding a command input box similar to what VSCode has. There are a bunch of features that are only available through point and click or tab + arrow navigation. Like open document, and setting various meta data like document label and status. I think that's a better fit for that one.

[vkbo]

Any thoughts on this? I still think my option 1 is the best one here as it allows you to inject this meta data into the manuscript without having to type anything anywhere. Avoiding the point and click or keyboard navigation path is probably best achieved with a command widget like I suggested in the other comment.

[pincq]

Sorry, I've been engrossed in writing!

1. Could the [field:] fields be extended to scope to smaller project item meta data? For example [field:scene.status] or [field:chapter:wordCount]? Printing the status field at build-time would certainly solve for my use case.
2. I am sure there are some UI elements that are more suited to mouse point & click, but a Codium-style ctrl-shift-P or Alt-F2 to access a quick command too would be very welcome.

[vkbo]

Sorry, I've been engrossed in writing!

Lucky you!

1. Could the [field:] fields be extended to scope to smaller project item meta data? For example [field:scene.status] or [field:chapter:wordCount]? Printing the status field at build-time would certainly solve for my use case.

Sure, that was my intention. As a first iteration, I think I will just make it a toggle on the headings tab for the build settings. It could just dump status, word count, character count, and dialogue ratio if enabled, and you'd be able to pick what settings to add it for. That's a pretty simple implementation.

2. I am sure there are some UI elements that are more suited to mouse point & click, but a Codium-style ctrl-shift-P or Alt-F2 to access a quick command too would be very welcome.

Yeah, I thought about this for finding and opening documents too. I'll branch out a new feature ticket for that.