← Back to team overview

dhis2-devs team mailing list archive

Re: Docbook conventions, a resource

 

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@xxxxxxxxx> 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 <screen> or <programlisting> 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@xxxxxxxxx
> tel:+46764147049
>
> _______________________________________________
> Mailing list: https://launchpad.net/~dhis2-devs
> Post to     : dhis2-devs@xxxxxxxxxxxxxxxxxxx
> 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

Follow ups

References