-
Notifications
You must be signed in to change notification settings - Fork 17
Latexhowto
This guideline describes how to use the openETCS LaTeX template to create new documents.
If you want to create a new document, please use the openETCS LaTeX template. It is hosted within the ecosystem project: https://github.com/openETCS/ecosystem/tree/master/openETCS_LateX_templates. The template consists of two *.tex files, two PDF files and a folder "template". Please choose if you want to write a report or an article and rename the corresponding *.tex file to the name of you document. The PDF file can be deleted, as it will be generated by LaTeX. By opening the *.tex file in a LaTeX editor, you can now start to create your document. Please add the document as well as the templates folder to the corrsponding repository.
LaTeX files can be versioned well with git, PDF file cannot as they are binary. Therefore you should avoid to include the generated PDF file into the repository. However, there are several cases, where you want to grant access to a certain state of the PDF. If you want to grant access to the latest state, you can include the PDF generated by LaTeX. However, users of this file have to be aware, that this file is not necessary the latest state, as it requires the last committer to generate and commit the PDF. Therefore, if the PDF is included in the repository, every committer should always do this. To create a downloadable PDF in a certain state, people can refer to, create a new folder in the directory of the LaTeX file named "releases". And copy the state you want to publich into this folder. In this case you shouls add a version number to the file name and never change it again.
Before you start a review there should be a committer, who is responsible to accept all contributions. There are three ways to give feedback:
- Create a issue in the issue tracker: For general comments to the document under review or to state things which are missing
- FIXME Annotation: For comments, which relate to certain paragraph, where you do not provide a solution
- Change the document: To make a proposal how to change the document. If your change needs explanation, please add a comment.
In all cases the change can be discussed online, either as a comment on the issue or as a comment on the pull request. The responsible committer is requested to accept pull request, once they are agreed on. Issues should be ssigned to someone who resolves them.