{"id":23061842,"url":"https://github.com/rrwen/cookiecutter-latex-ryerson","last_synced_at":"2025-04-03T07:20:04.569Z","repository":{"id":91307811,"uuid":"129322722","full_name":"rrwen/cookiecutter-latex-ryerson","owner":"rrwen","description":"Personal template for LaTeX documents following thesis, major research papers, and dissertation submission guidelines by the Yeates School of Graduate Studies at Ryerson University","archived":false,"fork":false,"pushed_at":"2018-07-01T23:48:20.000Z","size":707,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-08T21:11:19.733Z","etag":null,"topics":["appendix","chapter","degree","dissertation","document","format","graduate","guideline","latex","major","paper","research","ryerson","school","studies","submission","template","thesis","university","yeates"],"latest_commit_sha":null,"homepage":null,"language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rrwen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-12T23:36:47.000Z","updated_at":"2020-06-18T19:02:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"78bc5e37-37af-4ec5-a332-6dbdbb3c3f05","html_url":"https://github.com/rrwen/cookiecutter-latex-ryerson","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rrwen%2Fcookiecutter-latex-ryerson","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rrwen%2Fcookiecutter-latex-ryerson/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rrwen%2Fcookiecutter-latex-ryerson/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rrwen%2Fcookiecutter-latex-ryerson/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rrwen","download_url":"https://codeload.github.com/rrwen/cookiecutter-latex-ryerson/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246952278,"owners_count":20859813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appendix","chapter","degree","dissertation","document","format","graduate","guideline","latex","major","paper","research","ryerson","school","studies","submission","template","thesis","university","yeates"],"created_at":"2024-12-16T03:18:37.030Z","updated_at":"2025-04-03T07:20:04.564Z","avatar_url":"https://github.com/rrwen.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cookiecutter-latex-ryerson\n\nRichard Wen  \nrrwen.dev@gmail.com  \n\n* [Guidelines](https://www.ryerson.ca/graduate/current-students/dissertation-thesis-exams/)\n* [Sample](https://github.com/rrwen/cookiecutter-latex-ryerson/blob/master/wen2018_sample.pdf)\n\nPersonal template for LaTeX documents following thesis, major research papers, and dissertation submission guidelines by the Yeates School of Graduate Studies at Ryerson University.\n\n[![Build Status](https://travis-ci.org/rrwen/cookiecutter-latex-ryerson.svg?branch=master)](https://travis-ci.org/rrwen/cookiecutter-latex-ryerson)\n[![GitHub license](https://img.shields.io/github/license/rrwen/cookiecutter-latex-ryerson.svg)](https://github.com/rrwen/cookiecutter-latex-ryerson/blob/master/LICENSE)\n\n## Install\n\n1. Install [Python](https://www.python.org/downloads/)\n2. Install [cookiecutter](https://pypi.python.org/pypi/cookiecutter) with [pip](https://docs.python.org/3/installing/)\n3. Install [TeX Live](https://www.tug.org/texlive/acquire-netinstall.html) or [Miktex](https://miktex.org/download)\n4. Install [git](https://git-scm.com/)\n5. Install [perl](https://www.perl.org/)\n6. Add [TeX Live path](https://www.tug.org/texlive/quickinstall.html) or [Miktex path](https://miktex.org/howto/modify-path) to system or environmental paths\n\n```\npip install cookiecutter\n```\n\n## Usage\n\n1. Create a template using [cookiecutter](https://pypi.python.org/pypi/cookiecutter) with a user input prompt\n2. Change directory to the `project_name` folder (based on user input) with [cd](https://en.wikipedia.org/wiki/Cd_(command))\n3. Modify LaTeX files inside `front_matter`, `back_matter`, and `main_body` folders\n4. Create a PDF file from the LaTex files with `make.bat` or `make.sh`\n5. Re-create PDF file as needed with **Step 4**\n\nIn windows:\n\n```\ncookiecutter gh:rrwen/cookiecutter-latex-ryerson\ncd project_name\nmake\n```\n\nIn Linux/Mac:\n\n```\ncookiecutter gh:rrwen/cookiecutter-latex-ryerson\ncd project_name\nchmod +x make.sh\n./make.sh\n```\n\nSee [Implementation](#implementation) for more details.\n\n## Github Repository\n\nYou may wish to also create a Github repository for your paper:\n\n1. Ensure [git](https://git-scm.com/) is installed\n2. Change directory to the `project_name` folder\n3. Initialize the repository with [git init](https://git-scm.com/docs/git-init)\n4. Add the template files to commit with [git add](https://git-scm.com/docs/git-add)\n5. Sign up for a [Github Account](https://github.com/) if you have not already\n6. Create an empty [Github repository](https://help.github.com/articles/create-a-repo/) with the same name as `project_name`\n7. Add the empty remote repository from **Step 6** with [git remote](https://git-scm.com/docs/git-remote)\n8. *(Optional)* Pull any changes if the Github repository is not empty with [git pull](https://git-scm.com/docs/git-pull)\n9. Push the commit from **Step 4** to your created Github repository with [git push](https://git-scm.com/docs/git-push)\n10. View your Github repository at `https://github.com/\u003cgithub_user\u003e/\u003cproject_name\u003e`\n\n```\ncd project_name\ngit init\ngit add .\ngit commit -a -m \"Initial commit\"\ngit remote add origin https://github.com/\u003cgithub_user\u003e/\u003cproject_name\u003e.git\ngit pull origin master --allow-unrelated-histories\ngit push -u origin master\n```\n\n## Developer Notes\n\n### Implementation\n\nThis code creates folders and files for [cookiecutter](https://pypi.python.org/pypi/cookiecutter) templates.\n\n* The main file is [cookiecutter.json](https://github.com/rrwen/cookiecutter-latex-ryerson/blob/master/cookiecutter.json) which defines the inputs for the command line interface\n* The inputs then replace any values surrounded with `{{}}` inside the folder [{{cookiecutter.project_name}}](https://github.com/rrwen/cookiecutter-latex-ryerson/tree/master/%7D%7Dcookiecutter.project_name%7D%7D)\n\n```\n        cookiecutter              \u003c-- template tool\n             |\n      cookiecutter.json           \u003c-- template inputs\n             |\n{{cookiecutter.project_name}}    \u003c-- generated template\n```\n\nThe following files will be created inside a folder with the same name as the `project_name` input:\n\nFile | Description\n--- | ---\n**back_matter/appendices.tex** | a LaTeX file containing the appendices content\n**back_matter/bibliography.bib** | a [BibTeX](http://www.bibtex.org/Format/) file for storing references\n**back_matter/bibliography.tex** | a LaTeX file containing the [automatic bibliography](http://www.bibtex.org/Using/)\n**back_matter/glossary.tex** | a LaTeX file containing the glossary content\n**back_matter/index.tex** | a LaTeX file containing the index content\n**code/helloworld.py** | a sample Python file to demonstrate code listings\n**front_matter/abstract.tex** | a LaTeX file containing the abstract content\n**front_matter/acknowledgements.tex** | a LaTeX file containing the acknowledgements content\n**front_matter/authors_declaration.tex** | a LaTeX file containing the declaration content\n**front_matter/dedication.tex** | a LaTeX file containing the dedication content\n**front_matter/list_of_appendices.tex** | a LaTeX file containing the automatic list of appendices using commands in `custom.tex`\n**front_matter/list_of_figures.tex** | a LaTeX file containing the [automatic list of figures](https://www.sharelatex.com/learn/Lists_of_tables_and_figures)\n**front_matter/list_of_tables.tex** | a LaTeX file containing the [automatic list of tables](https://www.sharelatex.com/learn/Lists_of_tables_and_figures)\n**front_matter/table_of_contents.tex** | a LaTeX file containing the [automatic table of contents](https://www.sharelatex.com/learn/Table_of_contents#Introduction)\n**front_matter/title_page.tex** | a LaTeX file containing the [title page](https://en.wikibooks.org/wiki/LaTeX/Title_Creation)\n**figures/** | folder for figure image files (.pdf, .png, .jpg)\n**figures/graphic.pdf** | sample figure image in .pdf format\n**main_body/chapter01_background.tex** | a LaTeX file containing the background content\n**main_body/chapter02_methods.tex** | a LaTeX file containing the method content\n**main_body/chapter03_results.tex** | a LaTeX file containing the results content\n**main_body/chapter04_discussion.tex** | a LaTeX file containing the discussion content\n**main_body/chapter05_conclusion.tex** | a LaTeX file containing the conclusion content\n**main_body/introduction.tex** | a LaTeX file containing the introduction content\n**.gitignore** | a [gitignore file](https://git-scm.com/docs/gitignore) for manually untracking files\n**.travis.yml** | a [Travis CI file](https://docs.travis-ci.com/user/customizing-the-build) for automatic testing\n**{{cookiecutter.vars.tex_file}}.tex** | the main LaTeX file for producing the PDF (named `lastnameYear_project_name.tex`)\n**LICENSE** | MIT [license file](https://help.github.com/articles/licensing-a-repository/) automatically created from github\n**make.bat** | a [Batch file](https://en.wikipedia.org/wiki/Batch_file) for creating the PDF in Windows\n**make.sh** | a [Shell Script](https://en.wikipedia.org/wiki/Shell_script) for creating the PDF in Linux/Mac\n**packages.tex** | a file containing the required [LaTeX packages](https://ctan.org/pkg) used in the template\n**README.md** | a readme [Markdown](https://daringfireball.net/projects/markdown/) file with header section\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frrwen%2Fcookiecutter-latex-ryerson","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frrwen%2Fcookiecutter-latex-ryerson","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frrwen%2Fcookiecutter-latex-ryerson/lists"}