Importing a project
Start a project from files that already exist: a ZIP, the source of a paper on arXiv, a template, or a GitHub repository. Each route creates a new project. None of them adds files to a project you already have.
From a ZIP
- On the Projects page, click New project and open the Import ZIP tab.
- Drop a
.zipfile on the box, or click the box to browse for one. - Change the Project name if you like. It starts as the name of the ZIP.
- Click Import project.
TeXeR unpacks the ZIP in your browser, creates the project, and saves the files into it. The project opens in the editor when every file is in.
How the main document is chosen
The main document is the first file found in this order:
main.texat the top level, if it contains\documentclass.- Another
.texfile at the top level, if it contains\documentclass. - A
.texfile in a folder, if it contains\documentclass. - The first
.texfile, taking paths in alphabetical order.
The chosen file is saved as main.tex, whatever it was called in the ZIP, and becomes the project's main document.
If the chosen file was inside a folder, that folder becomes the top level of the project, so the document's \input and \includegraphics paths still point at the right files. Files outside that folder are left out.
A ZIP with no .tex file is refused with "No .tex files found in the ZIP.", and no project is created.
What is kept
- Folders. Every file keeps its path. If the whole ZIP sits inside one folder, that wrapping folder is removed.
- Text files become project files that you can edit: LaTeX sources, bibliographies, class and style files, and anything else that reads as plain text.
- Images, PDFs, fonts, and other files are stored exactly as they are. These count toward your upload storage.
What is left out
| Left out | Why | Are you told? |
|---|---|---|
Files and folders whose name starts with a dot, such as .git and .DS_Store, and the __MACOSX folder | They belong to your computer or your tools, not to the document. | No |
| Empty folders | Only files are brought in, and each one brings its folders with it. | No |
| A file with a path longer than 300 characters | The path is too long for a project file. | No |
A file named main.tex in the same folder as the main document, when the main document was chosen under a different name | The chosen file takes that name. | No |
| Files outside the main document's folder | That folder became the top level of the project. | Yes |
| A file larger than 10 MB | 10 MB is the limit for one project file. | Yes |
| Images and other stored files beyond 60 in one minute | Uploads of these are limited to 60 a minute. | Yes |
| A stored file that does not fit in your upload storage | Your plan's allowance is full. | Yes |
When files are left out for one of the reasons in the last four rows, a notice says how many, and names the first three with the reason for each. Add them afterwards by uploading them in the editor.
Before you zip
If your main document is not called main.tex and the ZIP also holds a different file with that name, rename one of them first. Otherwise the second one is dropped without notice.
After the import
The new project uses the default compiler settings. If the document needs XeLaTeX or LuaLaTeX, change Compiler on the Compiler tab of Project settings, as described in Compiling.
From arXiv
- On the Projects page, click New project and open the ArXiv tab.
- Enter the paper's identifier under ArXiv ID, for example
2301.01234. Identifiers in the older style, such asmath.GT/0309136, work too. Enter the identifier alone, not a link to the paper. - Click Import from ArXiv, or press
Enter.
TeXeR downloads the paper's source from arXiv and creates a project named after the paper's title. From there the files are treated exactly as in a ZIP import: the main document is chosen the same way, and the same things are kept and left out.
Papers with more than one version
If the paper has several versions and you did not say which one you want, nothing is imported. The dialog tells you how many versions there are, for example "This paper has 3 versions. Please specify one, e.g. 2301.01234v3 (latest) or 2301.01234v1."
Add v and the version number to the identifier, as in 2301.01234v3, and import again. A paper with a single version is imported straight away.
When a paper cannot be imported
| Message | What it means |
|---|---|
| "Not a valid arXiv identifier. Expected e.g. 2301.12345 or math.GT/0309136." | The text is not an arXiv identifier. Remove any arXiv: prefix or link. |
| "This paper has no LaTeX source on arXiv." | The download has no .tex file in it. |
| "Could not unpack the paper's source." | The download is not an archive TeXeR can read. |
| "An internal error occurred. Please try again later." | TeXeR could not get the source from arXiv. That happens when arXiv has no source for the identifier, when the source is larger than 50 MB, and when arXiv cannot be reached. |
TeXeR accepts ten arXiv requests a minute from one network address.
Only want to read the paper?
To keep a paper's source beside your own project, rather than as a project of its own, attach it as a reference paper.
From a template
There are two kinds of template.
Starter templates are built in:
- Click New project and open the Templates tab.
- Narrow the list with the category buttons: All, Notes, Paper, Beamer, Book, Homework, Resume, Letter, and Other.
- Click a template. The dialog returns to the New tab, and a dot on the Templates tab shows that one is chosen.
- Enter a Project name and click Create project.
The new project's main.tex holds the template. To go back to an empty project, open the Templates tab again and click Scratch.
Saved templates are made from projects, by you or by other people. On the Templates page, click Use template to create a project from a copy of the template's files. Saving, sharing, and managing these templates is covered in Editing.
From a GitHub repository
Create a new project, link the repository to it, and take GitHub's files:
- Create a project on the New tab.
- In the editor, choose File, then GitHub…, and link the repository.
- When TeXeR asks which version to keep, choose Use GitHub's.
The steps for creating a token and linking, and what a pull does with each file, are in GitHub sync. If the repository's main file is not called main.tex, choose it afterwards under Main document. The project also keeps the main.tex it was created with, because that file cannot be deleted.
Related
- Projects and files: manage files once the project exists.
- GitHub sync: link a repository, then push and pull.
- Reference papers: attach an arXiv paper to a project instead of importing it.
- Compiling: engines and the main document.