Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Index behaviour #211

Open
CxRes opened this issue Oct 5, 2023 · 1 comment
Open

Clarify Index behaviour #211

CxRes opened this issue Oct 5, 2023 · 1 comment

Comments

@CxRes
Copy link

CxRes commented Oct 5, 2023

Surrounding a word in triple brackets, so that it is added to the index is causing the word to vanish?

Input:

This (((!vanishes))).

This also (((vanishes))).

Output

<t>This <iref item="vanishes" primary="true"/>.</t>

<t>This also <iref item="vanishes"/>.</t>

This seems counter-intuitive since one would expect the word that they index to remain.

Also:

*[not]: (((not)))

This does not go away.

will render with the "not"!

@cabo
Copy link
Owner

cabo commented Oct 6, 2023

It is often necessary to go to a base form for an index entry, so most likely you'd wanted to say

This vanishes (((vanish)))

(This is also the way <iref is processed in RFCXML.)

The search-based syntax is indeed different: It is meant to apply itself to text that remains readable as markdown text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants