Sorry, I have yet another feature request for Broxygen ...
Working on event.bif, I was thinking it would be nice if I could group
events somehow. Currently, they are all listed alphabetically. If
there were markup to define a group (a directive? role? other magic?)
we could, e.g., put all HTTP events into their own section "HTTP
Analyzer".
Doable?
Robin
Working on event.bif, I was thinking it would be nice if I could group
events somehow. Currently, they are all listed alphabetically. If
there were markup to define a group (a directive? role? other magic?)
we could, e.g., put all HTTP events into their own section "HTTP
Analyzer".
Isn't that related to the &group="x" attribute? If we use it
universally, Broxygen could just use it for this purpose.
Matthias
That could work if we also had a mapping from that group to some nicer
section title. On the other hand, grouping might also be usefol for
other things than events (like the options in init-bare.bro).
Robin
Working on event.bif, I was thinking it would be nice if I could group
events somehow. Currently, they are all listed alphabetically. If
there were markup to define a group (a directive? role? other magic?)
we could, e.g., put all HTTP events into their own section "HTTP
Analyzer".
Where would you want the grouping to occur in the rendered docs? In a custom index, inline in the events.bif docs, somewhere else?
Doable?
Yes, but I don't currently have a simple solution (or any solution) in mind yet.
+Jon
Where would you want the grouping to occur in the rendered docs? In a
custom index, inline in the events.bif docs, somewhere else?
I was thinking inline in events.bif, ideally with a toc at the
beginning. But perhaps it then wouldn't really be events.bif any more
from the perspective of someone reading the docs; but just a section
in the documentation called "Built-in Events", with corresponding
subsections.
Yes, but I don't currently have a simple solution (or any solution) in mind yet.
It's not so important, I haven't really thought it through how it
would fit into the overall structure. It's something we can always add
later.
Robin