Example descriptions in BaseX documentation

On Wed, Jan 15, 2025 at 8:23 PM Amanda Galtman via BaseX-Talk < basex-talk at mailman.uni-konstanz.de> wrote: > Hi, BaseX team. > > I noticed that some examples on the BaseX documentation page > https://docs.basex.org/main/XQuery_Functions > say "The following expressions" to refer to code that appears preceding > the text, not following. > > I don't know enough about the BaseX doc processing to fix it myself. For > instance, the source in one case has this form: > > <example> > <query>...code goes here...</query> > <info>The following expressions use strings as keys. All of them > return `XML`</info> > </example> > > Is the description always supposed to be rendered after the code block, in > which case I could change the word "following" to "preceding"? > > Or is switching the order of <query> and <info> a way to make the verbiage > appear before the code block in the rendered web page? > > Thanks, > Amanda > >

On Wednesday, January 15th, 2025 at 2:29 PM, Christian Grün <christian.gruen at gmail.com> wrote: > Hi Amanda, > > Thanks for your observation. We have indeed changed the way how examples are rendered in the documentation: The (optional) description is now placed after the query – no matter where the <info/> tag is located in the sources. I am pretty sure it will stay that way in future versions of the documentation. > > I have already modified the two cases on the referenced page. If you find some more cases: Thank you in advance for having a closer look at them, that’s very appreciated! > All the best, > Christian > > On Wed, Jan 15, 2025 at 8:23 PM Amanda Galtman via BaseX-Talk <basex-talk at mailman.uni-konstanz.de> wrote: > >> Hi, BaseX team. >> >> I noticed that some examples on the BaseX documentation page >> https://docs.basex.org/main/XQuery_Functions >> say "The following expressions" to refer to code that appears preceding the text, not following. >> >> I don't know enough about the BaseX doc processing to fix it myself. For instance, the source in one case has this form: >> >> <example> >> <query>...code goes here...</query> >> <info>The following expressions use strings as keys. All of them return `XML`</info> >> </example> >> Is the description always supposed to be rendered after the code block, in which case I could change the word "following" to "preceding"? >> >> Or is switching the order of <query> and <info> a way to make the verbiage appear before the code block in the rendered web page? >> >> Thanks, >> Amanda