xref export broken?

andy

Still digging my way into adoc studio... I remember from other projects that it can be tricky to setup xref to work with multiple files. My expectation was a sensible default in Adoc Studio, but this doesn't seem to be the case.

I created a new project, added a composite and a standalone file and tried to link to the sample sections in the initial file and the composite file. However, the links are both broken. The one to the sample file points to
<a href="../Document.html#Any%20Questions?">Questions?</a>
the one to the composite file to
<a href="Composite%20Document/Chapter%201.adoc#Chapter%201">asdf</a>
The former won't work as the two html documents end up in the same folder. The latter won't work because the composite file is transformed into a single 'Composite Document.html'.

Export was done on the wohle project with default settings.

Any hints?

fblome

You have found a strange behavior. I made a quick test and it worked, but then I made another one and it doesn't.
So we have to inspect this. Unfortunately half of Germany enjoys today a day off and on Friday a bridge day, this includes our developers 🤷‍♂️ If possible I'd like to move this issue to Monday. If not, I have to wake up a developer 😆

In any case I would recommend that you give in the target document an anchor. This makes it more robust when you change the headline afterwards:

[#my_anchor]
== My headline

In the referencing document you enter:

Click for xref:/Document.adoc#my_anchor[more information].

Thanks. I'll keep you posted.

fblome

BTW; If I remember correctly you are in the testing phase for adoc Studio. If this collides with the 14 days from the App Store, please drop me a note. I am able to support you.

fblome

I found a workaround!

Simply delete any former export folder and restart the export. Then everything should work.
Can you confirm?

Thanks
Frank

andy

Thank you very much for the quick reply and sorry for not replying sooner myself. It seems I don't have mail notifications set up here. As I'm also in Germany, I wasn't too eager checking the result 😉

Unfortunately, the links still don't work for me across the composite and the standalone documents. They are also autocompleted differently. Here's the links back to the sample document from standalone and composite:
xref:Document.adoc#Any Questions?[qa]
vs
xref:/Document.adoc#Any Questions?[qa]

Vicky

'Any Questions?' is your anchor ID? An anchor may not use spaces or a question mark. Try setting it as

[#any_questions]
== Any Questions?

and in the referencing part:

xref:/Document.adoc#any_questions[Any Questions?]

andy

Any Questions? is the heading from the 'Document.adoc' sample file. The problem remains the very same (apart from that, it should also work for headings without anchors.
xref:Document.adoc#any_questions[qa]
vs.
xref:/Document.adoc#any_questions[qa]
Those translate to broken links, because the composite Document is exportet in the same folder as the standalone ones. A workaround is to fix the path manually. After all, it seems this is not a problem of the export but the autocomplete.

Vicky

andy Hi, would you care sending us the project so we can test the current behavior against an improved one using your specific use case(s)?

Just compress your project folder and send it to us to support@projectwizards.net

Thanks

andy

Side note: This is the mail notification I got for your post

{!! $translator->trans('flarum-subscriptions.email.new_post.body', [
'{recipient_display_name}' => $user->display_name,
'{poster_display_name}' => $blueprint->post->user->display_name,
'{title}' => $blueprint->post->discussion->title,
'{url}' => $url->to('forum')->route('discussion', ['id' => $blueprint->post->discussion_id, 'near' => $blueprint->post->number]),
'{content}' => $blueprint->post->content
]) !!}

Am I missing something?

Vicky

andy hmm, that's strange. This is how my mail notification arrives in my mail app

But we'll look into it.

Vicky

Thanks for sending us the project. We are going to test your report and use it to verify any changes needed.