Closed InterLinked1 closed 6 months ago
The full contents of the !!! note
admonition (same with !!! warning
) needs to have the same amount of leading indentation as the surrounding list items for this to render properly. Right now we put it all at the beginning of a line during the XSLT processing.
I think switching to the /// admonition
style might fix this because it doesn't require the leading spaces in the first sentence and it has a closing ///
delimiter. It looks like this...
/// info | Some Title
<any text>
///
I'll try it.
Nope made things worse. I think not using the admonitions at all may be better. Just using **Note: <note text>**
would look like this when used in an enum/param list...
When used in normal text, it'd look like this...
What do you think?
I think the admonitions look better but whatever you think is best.
Nope made things worse. I think not using the admonitions at all may be better. Just using
**Note: <note text>**
would look like this when used in an enum/param list...When used in normal text, it'd look like this...
What do you think?
I liked having a red block for warnings, like in the old docs, since they're mot distinguished than just boldface, but if there's not an easy way to retain that, I guess it is what it is.
I'll take another pass at it tomorrow and see if I can keep the admonitions but still get them to render correctly in both lists and regular paragraphs.
Sorry guys, I don't think there's a way to make admonitions work when they're inside enum lists without serious xslt work and imposing stricter rules on the XML itself. I'll continue to research though.
OK, I think I got it figured out. Checkout the PR and build it if you want to test, otherwise I'll merge it on Wednesday.
https://docs.asterisk.org/Asterisk_21_Documentation/API_Documentation/Dialplan_Functions/CHANNEL/
The note starting at "If not specified, 'audio' is used by default." is never closed.
Looking at the underlying XML documentation in
channels/pjsip/dialplan_functions_doc.xml
, it appears to be correct (the note is properly closed):