Improved partials editing support

When you’re working on a large documentation project where many document contents are assembled using the include macro, editing of the included bits can be cumbersome.

When editing the page containing the include you have all the necessary context (e.g., attribute values) available, but all you see in the editor is the include macro. When editing the included bit (e.g. an Antora partial) you see the content of the included bit, but you’re missing the context and as a consequence may end up having unresolved attributes. Neither option is ideal.

Being able to edit the partial content in place where it’s included or conversely being able to specify the context when editing the partial directly would make the editing workflow easier I think.

[ahus1]

Hi @pepijnve - I’ve revisited this issue after some time. Reading it again, I consider “placing a dummy image in the shared component” would provide the best preview in the scenario you describe above: A dummy could be just the right size to show how the content should look like.

I would prefer to put a dummy image (to show a nice preview) instead of disabling the error message in the editor for partials and showing a broken image in the preview.

As the dummy image is something that is already available, I close this issue as “nothing more to do”.

If you find other corner issues with partials, please let me know, and I’ll re-open the issue.

[ahus1]

There is always more than one way to do things. I outline some that come to my mind.

For a future version of the plugin: The automatic checks shouldn’t show false positives. I could disable the “AsciiDocLinkResolve” inspection on all partials. What do you think?

To get rid of the squiggly line with the current version of the plugin:

1. place a dummy image in the shared component. You could even place some dummy attribute values in the shared component’s component descriptor. This would give you a good preview when editing a partial; you wouldn’t need to the split preview every time.
2. suppress the error - use Ctrl+Enter for that and the menu. See image below. The resulting snippet would be

// suppress inspection "AsciiDocLinkResolve"
image::setup.png[]