Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@physikerwelt
physikerwelt committed Feb 5, 2020
1 parent e07c14d commit 6ef50e8
Showing 1 changed file with 122 additions and 41 deletions.
163 changes: 122 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,52 +1,133 @@
# LaTeX paper template
This repository serves as a template for LaTeX papers. And guides you to the process of writing a scientific paper using LaTeX for a computer science conference or journal. Basic steps are

1) Set up and rename the repository.
1) Manage collaborators, permissions and links to the repository
1) Create a work-plan and distribute tasks
1) Document your research to allow for greater reproducibility
1) Select templates and plan paper outline
1) Write the paper collaboratively on GitHub
1) Get your paper proofread
1) Format shorten and submit
1) Get the preprint
1) submit to arxiv and archive the repo

## 1) Set up and rename the repository

To start a new LaTeX paper project do the following.
1) Consider starting with Word. Writing in LaTeX comes with some overhead.
If you are unsure, if your paper project will mature and be eventually submitted start with a word document.
Also consult the corresponding [wiki page.](https://isgroup.atlassian.net/wiki/spaces/ISG/pages/16613454/Write+the+Paper)
If you just created this repository please consider [deleting it.](https://help.github.com/en/github/administering-a-repository/deleting-a-repository)
1) [Rename the github repository](https://help.github.com/en/github/administering-a-repository/renaming-a-repository) according to the following naming convention `YYConfTopic.`
Here `YY` is the year of the publication, `Conf` is the Camel-case acronym of the confierence, e.g, `Jcdl,` `Sigir,` or `Neurips.`
`Topic` is a descriptive word for your paper projekt to distinguish it from other papers from the group submitted to the same conference.
You can update the name later, especially if you decide to change the conference.
1) Generate a [github token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token) and check the repo permissions (the first group). This enables automated features of this repository, like the creation of PDF, spellchecking or conversion to a word document.
1) Set up the `GITHUB_TOKEN` on [travis.](travis-ci.com) Log in to travis and identify the newly created repository. From the repository go to `More options` -> `Settings`. Eventually you should end up at the following URL `https://travis-ci.com/ag-gipp/YYConfTopic/settings,` where `YYConfTopic` is your repo name as described above. In the section `Environment Variables` create a new variable and past the token you generated in the last step.
1) Change the title of the paper in the file [header.tex](/header.tex). If you set up the environment variables correctly, the PDF, Word and Spellcheck document should appear in about 5 minutes after the change as [release](https://help.github.com/en/github/administering-a-repository/viewing-your-repositorys-tags).
LaTeX paper template
====================

This repository serves as a template for LaTeX papers.
Furthermore, it guides you to the process of writing a scientific paper using LaTeX for a computer science conference or journal.

Basic steps are

1. Set up and rename the repository.

2. Manage collaborators, permissions and links to the repository

3. Create a work-plan and distribute tasks

4. Document your research to allow for greater reproducibility

5. Select templates and plan paper outline

6. Write the paper collaboratively on GitHub

7. Get your paper proofread

8. Format shorten and submit

9. Get the preprint

10. submit to arxiv and archive the repo

1) Set up and rename the repository
-----------------------------------

To start a new LaTeX paper project, do the following:

1) Consider starting with Word:
Writing in LaTeX comes with some overhead.
If you are unsure if your paper project will mature and be eventually submitted start with a word document.
Also, consult the corresponding
[wikipage.](https://isgroup.atlassian.net/wiki/spaces/ISG/pages/16613454/Write+the+Paper)
If you just created this repository, please consider
[deleting it.](https://help.github.com/en/github/administering-a-repository/deleting-a-repository)
1) [Rename the GitHub repository](https://help.github.com/en/github/administering-a-repository/renaming-a-repository)
according to the following naming convention `YYConfTopic.`
Here `YY` is the year of the publication,
`Conf` is the Camel-case acronym of the conference,
e.g, `Jcdl, Sigir,` or `Neurips.
Topic` is a descriptive word for your paper projekt to distinguish it from other papers from the group submitted to the same conference.
You can update the name later, especially if you decide to change the conference.
1) Generate a
[GitHub token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line#creating-a-token)
and check the repo permissions (the first group).
This enables automated features of this repository, like the creation of PDF, spellchecking or
conversion to a word document.
1) Set up the `GITHUB_TOKEN` on
[travis.](travis-ci.com)
Log in to travis and identify the newly created repository.
From the repository go to `More options` -\> `Settings`.
Eventually, you should end up at the following URL
`https://travis-ci.com/ag-gipp/YYConfTopic/settings,`
where `YYConfTopic` is your repo name as described above.
In the section `Environment Variables,`
create a new variable and pass the token you generated in the last step. 1)
Change the title of the paper in the file
[header.tex](/header.tex).
If you set up the environment variables correctly, the PDF, Word and Spellcheck document should appear in about 5 minutes after the change as
[release](https://help.github.com/en/github/administering-a-repository/viewing-your-repositorys-tags).

## 2) Manage collaborators, permissions and links to the repository
Take a moment to review the permissions and settings of your new repo. Invite collaborators that are on github. Contact other collaborators and ask for their GitHub account names. Also link the newly created repository from the corresponding issue in [JIRA](https://isgroup.atlassian.net/secure/RapidBoard.jspa?rapidView=53&projectKey=MPE&view=planning.nodetail&issueLimit=100) and to the [Confluence page.](https://isgroup.atlassian.net/wiki/spaces/ISG/pages/54912991)

## 3) Create a work-plan and distribute tasks
After having invited all collaborators to the repository make a work plan, e.g. using github issues. Make sure to schedule the work ahead. Discuss with your collaborators the distribution of the workload. Only a significiant contribution warrents the co-authorship on the paper. It is the job of the first author to manage all coauthors and to ensure that everyone contributes their fair share to the project.
Take a moment to review the permissions and settings of your new repo.
Invite collaborators that are on GitHub.
Contact other collaborators and ask for their GitHub account names.
Also, link the newly created repository from the corresponding issue in
[JIRA](https://isgroup.atlassian.net/secure/RapidBoard.jspa?rapidView=53&projectKey=MPE&view=planning.nodetail&issueLimit=100)
and to the [Confluence page.](https://isgroup.atlassian.net/wiki/spaces/ISG/pages/54912991)

3) Create a work-plan and distribute tasks
------------------------------------------

After having invited all collaborators to the repository make a work plan, e.g.
using Github issues. Make sure to schedule the work ahead. Discuss with your
collaborators the distribution of the workload. Only a significant contribution
warrants the co-authorship on the paper. It is the job of the first author to
manage all coauthors and to ensure that everyone contributes their fair share to
the project.

4) Document your research to allow for greater reproducibility
--------------------------------------------------------------

You can use this GitHub Repository to document your daily progress on the
research project. Just create a folder called log and create a plaintext or
markdown file. Before you stop working on the project, document the most
critical steps you did. Copy and paste locations and commands you used during
your research including links to help pages and screenshots. Spending 5 minutes
before leaving might save 1 hour the next day.

5) Select templates and plan paper outline
------------------------------------------

Consult the conference website on the requirements regarding formatting. Decide
if you are heading for a long or a short paper. Plan the length of the sections
individually

## 4) Document your research to allow for greater reproducibility
6) Write the paper collaboratively on GitHub
--------------------------------------------

You can use this GitHub Repository to document your daily progress on the research project. Just create a folder called log and create a plaintext or markdown file. Before you stop working on the project document the most important steps you did. Copy and paste locations and commands you used during your research including links to help pages and screenshots. Spending 5 minutes prior to leaving might save 1 hour the next day.
If multiple co-authors are contributing to the document text it might be most
convenient to split the paper into different files so that each coauthor works
on its own file. Otherwise, only the first author should do changes to the
repository. Other co-authors should use pull-request to submit changes.

1) Select templates and plan paper outline
7) Get your paper proofread
---------------------------

1) Write the paper collaboratively on GitHub
Be sure to get your paper proofread at least one week prior to the submission
deadline. See the hints in the wiki.

1) Get your paper proofread
8) Format shorten and submit
-------------------------

1) Format shorten and submit
Plan one day to format and shorten the paper. Be sure to commit regularly so
that you can revert changes if something goes wrong. After you are done with
reformatting, ensure alk your coauthors to review the paper again before
submission.

1) Get the preprint
9) Get the preprint
----------------

1) submit to arxiv and archive the repo
## Get the preprint
After your paper was accepted, the first author should carefully review the
step-by-step instructions in the
[wiki](https://isgroup.atlassian.net/wiki/spaces/ISG/pages/2818051/After+your+Paper+was+Accepted+Publishing+a+Paper+on+our+Website)

After your paper was accepted, the first author should carefully review the step-by-step instrunctions in the [wiki](https://isgroup.atlassian.net/wiki/spaces/ISG/pages/2818051/After+your+Paper+was+Accepted+Publishing+a+Paper+on+our+Website)
10) submit to arxiv and archive the repo
------------------------------------

0 comments on commit 6ef50e8

Please sign in to comment.