Enhance Example Section in Doc (fragid/set-xml-id)

openSUSE / dbxincluder

Transclusions for DocBook with XInclude 1.1

https://opensuse.github.io/dbxincluder

GNU General Public License v3.0

2 stars 3 forks source link

Enhance Example Section in Doc (fragid/set-xml-id) #21

Open tomschr opened 8 years ago

tomschr commented 8 years ago

We have an Example section in usage.rst. I think, this section deserves some more example.

Especially a short example showing the new fragid and set-xml-id attributes. One solution would be to name the subsections as a kind of "use case scenario". For example, "Including parts of an XML document" or "Changing ID of Root Element". Something like that.

Another idea would be to place the examples in the manpage.

Vogtinator commented 8 years ago

IMO that's already handled in the DocBook transclusion document: http://docbook.org/docs/transclusion/#tutorial

tomschr commented 8 years ago

Ok. Maybe not the full example. But a short list about the possible XInclude attributes and their meaning would be very useful (maybe in the manpage?)