[Standards] Syntax Highlighting in XEPs

Sam Whited sam at samwhited.com
Sat Jan 28 15:50:17 UTC 2017


Hi all,

Currently there are several XEPs that contain examples of a round trip
between the client and the server that delineate client sent packets
and server sent packets with some text similar to this:

```
Client:
<iq/>

Server:
<iq type='result'/>
```

This leads to strange results in the syntax highlighting of the example.
My initial thought was to replace them with comments (possibly noting
that the comments were for example only and not valid in an XMPP
stream if it wasn't obvious from the context):

```
<!-- Client -->
<iq/>

<!-- Server -->
<iq type='result'/>
```

but someone else told me they weren't a fan of that approach. Does
anyone have opinions on why we should or should not use comments? Any
alternative ideas?

Thanks,
Sam


More information about the Standards mailing list