search

asterisk / documentation

The Asterisk Documentation Project.
https://docs.asterisk.org/
Other
26 stars 22 forks source link

astxml2markdown.xslt: Change processing of "note" and "warning" #66

Closed gtjoseph closed 3 months ago

gtjoseph commented 3 months ago

Using admonitions for notes and warnings in the API documentation resulted in bad formatting when used in parameter lists or enums. Instead we now just leave them in-line and wrapped with **Info: <text>** or **Warning: <text>**.

Resolves: #65

jcolp commented 3 months ago

I barely speak XSLT, does anyone else?

gtjoseph commented 3 months ago

@seanbright While I'm here... The "replaceable" elements are currently rendered as italic. Do you think maybe monospaced is better?

The filename parameter instead of The filename parameter

seanbright commented 3 months ago

I think <replaceable> is fine as italic as long as <literal> is monospaced

gtjoseph commented 3 months ago

I think <replaceable> is fine as italic as long as <literal> is monospaced

<literal> is single-quoted currently... this is 'literal' text