search

asciidoctor / asciidoctor.org

:globe_with_meridians: Asciidoctor project site. Composed in AsciiDoc. Baked with Awestruct.
https://asciidoctor.org
Other
323 stars 803 forks source link

Add instructions on using an include with content on a list item (clo… #877

Closed danyill closed 5 years ago

danyill commented 5 years ago

Closes #876

mojavelinux commented 5 years ago

@danyill I applied some revisions (okay, a lot). Let me know what you think.

It's important to distinguish the primary text of a list item from the complex content. I tried to do that in my edits.

danyill commented 5 years ago

LGTM. Thank you for taking the time to review. I felt uncomfortable using a word like a "trick" but couldn't think of a better way of expressing it. I think what you've written is clearer.

Out of curiosity, while are you fully qualifying the xref against the user manual (e.g. <<user-manual.adoc##dropping-the-principal-text>>) here?

mojavelinux commented 5 years ago

Thanks for reviewing, @danyill!

Out of curiosity, while are you fully qualifying the xref against the user manual (e.g. <<user-manual.adoc##dropping-the-principal-text>>) here?

Technically, it's not necessary to make the reference work. But we're doing it that way so that it can be more easily migrated to Antora. Once we've made that switch, it will become the page ID you recognized.

mojavelinux commented 5 years ago

Btw, I also removed the other explicit IDs for the same reason. Once we're in Antora, everything will get reworked.