The following is extra explanation of some of the comments about the code
style.

1. While computer code works on lines, word processors work on paragraphs,
so code lines are entered as paragraphs in the guides. Code lines often
extend past the width of the display device and are wrapped to the next
line. Conventionally, wrapped lines have the same spacing as other code
lines. That is how they are displayed in other documents and that is how
readers expect to see them.

It is not logical to have extra spacing below paragraphs in the code style
when they are paragraphs of the same style. The option should be selected
not to display it. Keeping code together reduces the splits across pages
making it easier to understand, and listings take fewer pages to support
the concepts in the guide.

2. Code is processed in lines but there is no standard line length. I'm
aware of the python code standard PEP 8 using a maximum of 79 characters on
a line. This is likely based on the old 80-character wide terminals, still
a common default for terminal windows.

The Code paragraph style (Liberation Mono, Regular, 11pt) allows 71
characters on a line. Code character styles in LibreOffice guides commonly
use both 10pt and 11pt. At 10pt 78 characters can fit on the line with an
inner and outer margin of 2.5cm and 1.8cm respectively. Increasing code
paragraph width by 0.3cm to allow for 80-character lines would probably be
worthwhile, but at least by 0.05cm to allow 79 characters.

3. Listing captions give them a brief description so readers can more
easily understand their purpose and allow them to be referenced.

>

-- 
To unsubscribe e-mail to: documentation+unsubscr...@global.libreoffice.org
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy

Reply via email to