-
Notifications
You must be signed in to change notification settings - Fork 6
Tips and Tricks
The following suggestions ease working on ELISA documents.
Make one commit for each idea. This tracks changes in the document better and eases any merging necessary when two authors make conflicting changes on a section in the document.
In WYSIWYG editors there are many sentences in a paragraph which is terminated by a line-feed. Similarly, some authors put multiple sentences on a line in LaTex source code. This is unnecessary and creates readability problems when looking for changes between versions (as in a merge) or when the document source isn't broken to fit in the display window (word-wrap). The source text should therefore be kept under about 100 characters on a line. In order to best achieve this, each clause in a sentence should be put on a separate line.
svg graphics can be easily be placed in many types of media, like printed documents or websites, and can be resized loss-free. When absolutely necessary, they can be converted to bit-map graphics. Their style should be based on the ELISA .css style sheet (Note: create this sometime) so their appearance can easily be kept in sync with the ELISA style.
Inkscape is an excellent tool for working with svg graphics.
tbd
It's not clear whether each commit should be signed with a --signoff or whether the push should be signed as well. In the latter case, the repo can be configured to reject unsigned pushes but it requires the authors to sign with pgp.