Docbook conventions, a resource

Came across this and thought I would share it. It has quite a few good pointers and words of wisdom for working with DocBook. The first one being, if you are using verbatim text, do not exceed 70 characters. So a lot of the stuff in the developers manual with or needs to be broken up manually. While space (i.e. carriage returns) will be respected.

https://wiki.openstack.org/wiki/Documentation/DocBook_conventions

Regards,

Jason

···


Jason P. Pickering
email: jason.p.pickering@gmail.com
tel:+46764147049

The problem is to break up lines that people will (and should be able to) copy and paste directly from the manual into their terminal (for convenience, but also in order to not make mistakes). Typically cURL commands etc

···

On Tue, Sep 30, 2014 at 11:45 AM, Jason Pickering jason.p.pickering@gmail.com wrote:

Came across this and thought I would share it. It has quite a few good pointers and words of wisdom for working with DocBook. The first one being, if you are using verbatim text, do not exceed 70 characters. So a lot of the stuff in the developers manual with or needs to be broken up manually. While space (i.e. carriage returns) will be respected.

https://wiki.openstack.org/wiki/Documentation/DocBook_conventions

Regards,

Jason


Jason P. Pickering
email: jason.p.pickering@gmail.com
tel:+46764147049


Mailing list: https://launchpad.net/~dhis2-devs

Post to : dhis2-devs@lists.launchpad.net

Unsubscribe : https://launchpad.net/~dhis2-devs

More help : https://help.launchpad.net/ListHelp


Knut Staring

Dept. of Informatics, University of Oslo

+4791880522

Skype: knutstar

http://dhis2.org

Yeah, I see the problem. I will think about this, but I think in this case, we need another element somehow without the line breaks using the attribute. But if this is not a URL, it may not work. Will read a bit and see what i can come up with.

···

On Tue, Sep 30, 2014 at 11:49 AM, Knut Staring knutst@gmail.com wrote:

The problem is to break up lines that people will (and should be able to) copy and paste directly from the manual into their terminal (for convenience, but also in order to not make mistakes). Typically cURL commands etc


Jason P. Pickering
email: jason.p.pickering@gmail.com
tel:+46764147049

On Tue, Sep 30, 2014 at 11:45 AM, Jason Pickering jason.p.pickering@gmail.com wrote:

Came across this and thought I would share it. It has quite a few good pointers and words of wisdom for working with DocBook. The first one being, if you are using verbatim text, do not exceed 70 characters. So a lot of the stuff in the developers manual with or needs to be broken up manually. While space (i.e. carriage returns) will be respected.

https://wiki.openstack.org/wiki/Documentation/DocBook_conventions

Regards,

Jason


Jason P. Pickering
email: jason.p.pickering@gmail.com
tel:+46764147049


Mailing list: https://launchpad.net/~dhis2-devs

Post to : dhis2-devs@lists.launchpad.net

Unsubscribe : https://launchpad.net/~dhis2-devs

More help : https://help.launchpad.net/ListHelp

Knut Staring

Dept. of Informatics, University of Oslo

+4791880522

Skype: knutstar

http://dhis2.org