Getting Started

LaTex

Installation

To edit and compile LaTex documents you need

• A LaTex Distribution: Miktex for Windows or Texlive for Linux. Some Linux distributions provide a "tex" software package.
• A LaTex Editor: TexStudio works very well. Any Latex editor is suitable.
• [A pdf viewer]: Most LaTex editors have a built-in pdfviewer. Otherwise SumatraPDF is a fantastic PDFviewer for writing LaTex documents, due to its support of autoreloading and forward as well as backwards search between Latex code and generated pdf.

Environment

Refer to the document's .cls file(s) to find the required LaTex packages. You can ensure that the packages are installed by

• using a complete LaTex installation,
• installing the packages manually or
• activating on-the-fly package installation from your LaTex editor, if it has that functionality.

Git

You cannot work anonymously on ELISA Tech white papers. All authors must therefore have a GitHub account before starting.

Create a GitHub Repository for the New Document (Principal Author)

You need write permission to push changes from your local machine directly to the elisa-tech repository, which is generally not permitted. Instead you should use the following procedure:

• Create a document repository by forking the elisa-tech repository to your GitHub site. Refer to About Forks - GitHub Help.
• Create your local working environment (see below).
• On your local machine:
  • Create a new directory for the document on your local machine.
  • Copy the appropriate template from the Templates folder and rename it. Add information to the document to indicate that it is is a work in progress (hint: give a contact person).
  • Commit your changes and push them to the document repository.
• Issue a pull request to the elisa-tech repository to prevent collisions with future documents. Refer to the Workflow page for detailed instructions.
• Invite the document team to be collaborators, thus allowing them to push to the document repository. Refer to Permission levels for a user account - GitHub Help.
• Activate the issue tracker in the repository options of your fork, to allow the contributors to create issues, otherwise all issues created get forwarded to the main white papers repository instead.

Create a Local Working Environment (Document Team)

The document team works with the document repository that the Principal Author has forked from the elisa-tech repository.

• If you haven't already done so, install git on your machine. In corporate environments, the central IT department may have to install it for you. Git is a standard package in many Linux distributions. Otherwise you can install git with the package manager. Windows users can install Git for Windows.
• For people prefering a graphical user interface, there are several GIT front ends available, for instance TortoiseGit
• Clone the document repository to your machine. Refer to Cloning a repository from GitHub - GitHub Help.
• Set your GitHub user name and e-mail in your cloned repository. Refer to Set up Git - GitHub Help for directions.
• Work on the clone. Refer to the Workflow page.