{"id":13817801,"url":"https://github.com/sinamomken/tehran-thesis","last_synced_at":"2025-05-07T04:07:27.164Z","repository":{"id":40444238,"uuid":"90714526","full_name":"sinamomken/tehran-thesis","owner":"sinamomken","description":"LaTeX template for BSc/MSc/PhD theses of University of Tehran - قالب لاتک پایان‌نامه دانشگاه تهران","archived":false,"fork":false,"pushed_at":"2022-12-30T08:50:00.000Z","size":18375,"stargazers_count":166,"open_issues_count":2,"forks_count":41,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-07T04:07:15.383Z","etag":null,"topics":["bibtex","glossaries","iust-thesis","latex-template","tehran-thesis","thesis","todonotes","university-of-tehran","xepersian"],"latest_commit_sha":null,"homepage":"","language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sinamomken.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}},"created_at":"2017-05-09T07:15:34.000Z","updated_at":"2025-04-28T15:35:55.000Z","dependencies_parsed_at":"2023-01-31T11:01:36.401Z","dependency_job_id":null,"html_url":"https://github.com/sinamomken/tehran-thesis","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinamomken%2Ftehran-thesis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinamomken%2Ftehran-thesis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinamomken%2Ftehran-thesis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinamomken%2Ftehran-thesis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sinamomken","download_url":"https://codeload.github.com/sinamomken/tehran-thesis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252810273,"owners_count":21807759,"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":["bibtex","glossaries","iust-thesis","latex-template","tehran-thesis","thesis","todonotes","university-of-tehran","xepersian"],"created_at":"2024-08-04T06:00:56.108Z","updated_at":"2025-05-07T04:07:27.144Z","avatar_url":"https://github.com/sinamomken.png","language":"TeX","funding_links":[],"categories":["لاتک latex","Popular \u0026 New LaTeX Templates"],"sub_categories":["Thesis/Dissertation"],"readme":"# tehran-thesis\n\n[![GitHub release](https://img.shields.io/github/release/sinamomken/tehran-thesis.svg?style=flat-square)](https://github.com/sinamomken/tehran-thesis/releases/latest)\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sinamomken/tehran-thesis/Build?style=flat-square)](https://github.com/sinamomken/tehran-thesis/actions/workflows/build.yml)\n\nLaTeX template for MSc/BSc/PhD theses of University of Tehran.\n\u003cdiv dir=\"rtl\"\u003eقالب لاتک پایان‌نامه دانشگاه تهران\u003c/div\u003e\n\n\u003cdiv dir=\"rtl\"\u003e\n\n## راهنمای فارسی\n### ویژگی‌ها\n1. منطبق با [«دستورالعمل نگارش و تدوین پایان‌نامه» دانشگاه تهران، ویرایش اول، شهریور ۱۳۹۲][egufa site].\n1. طراحی مدولار و انعطاف‌پذیر، به همراه دستورات از پیش‌تعریف‌شده برای مشخصات متغیر یک پایان‌نامهٔ دانشگاه تهران (مثل عنوان، نام دانشچو، استاد راهنما، تاریخ و غیره).\n1. ‫استفاده از قلم‌های استاندارد [سری X نسخهٔ ۲][irmug-persian] یا قلم‌های استاندارد سری [IRFonts][irfonts] اثر شورای عالی اطلاع‌رسانی (به جای قلم‌های غیراستاندارد BFonts).\n1. ‫ساخته شده بر اساس قالب‌های پیشرفته‌های [IUST-Thesis][iust-template] و HSU-Thesis-V1 اثر دکتر محمود امین‌طوسی.\n1. حاوی توضیحات گویا در مورد چگونگی استفاده از این قالب و نیز نکات لازم در مورد نوشتن هر فصل یک پایان‌نامهٔ دانشگاه تهران.\n1. قابلیت انتخاب سبک‌های ارجاع‌دهی فارسی گوناگون برای رشته‌های مختلف، مطابق با سیستم‌های شماره‌دار و نویسنده-سال.\n1. ‫مدیریت هوشمند واژه‌نامه‌ها و درج اصطلاحات تخصصی، با استفاده از بستهٔ `glossaries` و موتور `xindy`.\n1. ‫قابلیت حاشیه‌نویسی مستقیم در فایل‌های TeX در حالت پیش‌نویس، با استفاده از بستهٔ `todonotes`.\n1. امکان درج شکل‌ها، جداول مختلف، نمودارهای `tikz`، الگوریتم‌های فارسی و لاتین و کدهای رنگی؛ بعلاوهٔ فهرست‌هایی از آنها.\n1. سربرگ استاندارد، فاصلهٔ مناسب حاشیه‌ها در حالت یک‌رو و دورو و شماره‌دهی صفحات منطبق بر دستورالعمل نگارش.\n\n### چگونه استفاده کنیم؟\n\nآخرین نسخهٔ منتشرشدهٔ قالب را می‌توانید از\n[![GitHub release](https://img.shields.io/github/release/sinamomken/tehran-thesis.svg?style=flat-square)](https://github.com/sinamomken/tehran-thesis/releases/latest)\nدریافت کنید.\nبا دستور زیر نیز می‌توانید به آخرین نسخهٔ در حال توسعهٔ قالب دسترسی داشته باشید:\n\u003cdiv dir=\"ltr\"\u003e\n\n```bash\ngit clone https://github.com/sinamomken/tehran-thesis --single-branch\n```\n\n\u003c/div\u003e\n\n‫قالب پایان‌نامهٔ _tehran-thesis_ در واقع یک بستهٔ قابل‌حمل است که بگونه‌ای طراحی شده تا مشخصات متغیر پایان‌نامه توسط دانشجو عوض شود و مطالب پایان‌نامه نیز توسط وی در فصول مختلف وارد گردد. به هیچ تلاشی برای قالب‌بندی نیاز نیست و تنها کافی است دانشجو طبق توضیحات، مطالب خود را وارد نماید.\nدر نتیجه این قالب به نصب نیاز ندارد. با این حال، این قالب از تکنولوژی‌ها و بسته‌های مختلفی استفاده می‌کند. پیش‌نیازهای زیر قبل از استفاده از قالب باید نصب باشند:\n\n#### پیش‌نیازها\n* ‫نصب کامل [`texlive`][texlive] بر روی لینوکس، ویندوز یا [`MacTex`][mactex] بر روی سیستم‌عامل مک. خصوصاً بسته‌های لاتک زیر باید نصب باشند:\n  * `زی‌پرشین`: تمام امکانات حروف‌چینی زبان فارسی در این قالب پایان‌نامه، با بستهٔ [`XePersian`][xepersian] فراهم شده است.\n  * ‫[`persian-bib`][persian-bib]: سبک‌های ارجاع‌دهی فارسی با این بسته فراهم شده‌اند.\n  * ‫[`glossaries`][glossaries]: بسته مدیریت پیشرفتهٔ واژه‌نامه‌ها در لاتک.\n  * ‫[`todonotes`][todonotes]: امکان حاشیه‌نویسی و نکته‌گذاری را در فایل‌های TeX شما فراهم می‌آورد.\n* ‫`latexmk`: برنامه‌ایست معادل `make` برای پروژه‌های لاتک که مراحل مختلف کامپایل را در صورت نیاز تکرار می‌کند (باید در نسخه کامل `texlive` باشد).\n* [`‫bibtex`][bibtex]: برنامهٔ ساخت فهرست مراجع و کتابشناسی (باید در نسخه کامل `texlive` باشد) و بستهٔ [`persian-bib`][persian-bib].\n* ‫`xindy`: برنامهٔ پشتی مورد نیاز برای ساخت واژه‌نامه‌ها و نمایه‌ها.\n  * زبان `persian` یا `persian-variant3` باید برای [`xindy`][xindy] نصب باشد (که در اوبونتو 16.04 دستی باید دانلود و کپی شود).\n* ‫یک ویرایشگر یا IDE برای پروژه‌های TeX، ترجیحاً با پشتیبانی از زبان‌های دوجهته یا راست به چپ، مثل [`BiDiTexmaker`][biditexmaker].\n* ‫\\[اختیاری\\] نصب قلم‌های سری X نسخهٔ ۲ و Junicode در سیستم‌عامل‌تان.\n\n\u003c/div\u003e\n\n## English Readme\n### Features\n1. Compliant with [\"Manual of writing and editing thesis of University of Tehran\", Sep. 2013][egufa site].\n1. Modular and flexible design, with predefined commands for variables of a standard UT thesis (title, name, supervisor, date, ...).\n1. Use of standard [X Series 2][irmug-english] fonts or standard [IRFonts][irfonts] by SCICT (instead of non-standard BFonts).\n1. Based on professional templates [\"IUST-Thesis\"][iust-template] and \"HSU-Thesis-V1\" by Mahmood AminToosi.\n1. Contains self-describing texts explaining how to use this template and notes about writing each chapter of a thesis.\n1. Ability to choose different Persian bibliography styles for various specialities, compliant with author-number or author-date systems.\n1. Smart glossaries management using `glossaries` package and `xindy` backend.\n1. Commenting \u0026 review directly inside draft version of tex files, by using ` todonotes` package.\n1. Ability to include figures, different tabulars, `tikz` diagrams, Persian \u0026 English algorithms and colorized code listings; And their catalogue.\n1. Standard headers, odd/even margins and page numberings.\n\n### How to Use\nIt's possible to download the latest released version of template from\n[![GitHub release](https://img.shields.io/github/release/sinamomken/tehran-thesis.svg?style=flat-square)](https://github.com/sinamomken/tehran-thesis/releases/latest).\nAlso, by the following command you can access to the latest developing version of template:\n\n```bash\ngit clone https://github.com/sinamomken/tehran-thesis --single-branch\n```\n\n_tehran-thesis_ latex template is a portable package, that is designed for customization by the student to fill his/her thesis materials.\nTherefor, it doesn't need any installation. However, it uses many technologies to fulfill its duties. Dependencies below must be installed:\n\n#### Prerequisites\n* Full [`texlive`][texlive] installation for Linux or Window, Or [`MacTex`][mactex] for MacOS. Specially, latex packages below should be installed:\n  * [`XePersian`][xepersian]: All persian properties are based on `XePersian` package.\n  * [`persian-bib`][persian-bib]: Bibliography styles are provided by `persian-bib` package.\n  * [`glossaries`][glossaries]: Advanced glossary management package.\n  * [`todonotes`][todonotes]: Provides commenting and todo notes available in your tex files.\n*  `latexmk`: equivalent of `make` for latex projects (should be included in a full `texlive` installation).\n* [`bibtex`][bibtex]: bibliography creation backend engine (should be included in a full `texlive` installation) and [`persian-bib`][persian-bib] package.\n* [`xindy`][xindy]: glossary/indexing backend engine.\n  * `persian` or `persian-variant3` language should be installed for xindy (not available by default in Ubuntu 16.04).\n* A TeX editor/IDE with RTL support, e.g. [`BiDiTexmaker`][biditexmaker].\n* \\[Optional\\] X Series 2 \u0026 Junicode Fonts installed in your system.\n\n## Screenshots\n#### tehran-thesis in BiDiTexmaker  \n![biditexmaker](./img/biditexmaker.png \"biditexmaker\")\n\n#### tehran-thesis in BiDiTexmaker (draft mode)  \n![biditexmaker-draft](./img/biditexmaker-draft.png \"biditexmaker-draft\")\n\n#### Example of citation to various sources  \n\u003cimg src=\"./img/cite-example.jpg\" alt=\"cite-example\" width=\"49%\"/\u003e \u003cimg src=\"./img/bibliography.jpg\" alt=\"bibliography\" width=\"49%\"/\u003e\n\n#### Glossary and index  \n\u003cimg src=\"./img/fa2en-glossary.jpg\" alt=\"fa2en-glossary\" width=\"49%\"/\u003e \u003cimg src=\"./img/index.jpg\" alt=\"index\" width=\"49%\"/\u003e\n\n#### Colorized codes and todo notes (in draft version)  \n\u003cimg src=\"./img/algs-codes.jpg\" alt=\"colorized codes\" width=\"49%\"/\u003e \u003cimg src=\"./img/todos.jpg\" alt=\"todo notes\" width=\"49%\"/\u003e\n\nMore screenshots are available in [`img`][imgs] folder.\n\n[egufa site]: https://github.com/sinamomken/tehran-thesis/wiki/%D9%85%D8%B3%D8%AA%D9%86%D8%AF%D8%A7%D8%AA-%D9%86%DA%AF%D8%A7%D8%B1%D8%B4-%D9%BE%D8%A7%DB%8C%D8%A7%D9%86%E2%80%8C%D9%86%D8%A7%D9%85%D9%87-%D8%AF%D8%B1-%D9%BE%D8%B1%D8%AF%DB%8C%D8%B3-%D8%AF%D8%A7%D9%86%D8%B4%DA%A9%D8%AF%D9%87%E2%80%8C%D9%87%D8%A7%DB%8C-%D9%81%D9%86%DB%8C-%D8%AF%D8%A7%D9%86%D8%B4%DA%AF%D8%A7%D9%87-%D8%AA%D9%87%D8%B1%D8%A7%D9%86\n\n[irfonts]: https://earmin.com/scict-standard-persian-fonts/\n\n[iust-template]: http://www.parsilatex.com/joomla/index.php/remository/Thesis_Templates/%D8%A7%D8%B3%D8%AA%DB%8C%D9%84-%D9%84%D8%A7%D8%AA%DA%A9-%D8%A8%D8%B1%D8%A7%DB%8C-%D9%BE%D8%A7%DB%8C%D8%A7%D9%86%E2%80%8C%D9%86%D8%A7%D9%85%D9%87%E2%80%8C%D9%87%D8%A7%DB%8C-%DA%A9%D8%A7%D8%B1%D8%B4%D9%86%D8%A7%D8%B3%DB%8C-%D8%AA%D8%A7-%D8%AF%DA%A9%D8%AA%D8%B1%D8%A7%DB%8C-%D8%AF%D8%A7%D9%86%D8%B4%DA%AF%D8%A7%D9%87-%D8%B9%D9%84%D9%85-%D9%88-%D8%B5%D9%86%D8%B9%D8%AA-%D8%A7%DB%8C%D8%B1%D8%A7%D9%86/\n\n[biditexmaker]: http://www.parsilatex.com/joomla/index.php?option=com_remository\u0026Itemid=82\u0026func=select\u0026id=2\n\n[imgs]: https://github.com/sinamomken/tehran-thesis/tree/master/img\n\n[irmug-persian]: http://wiki.irmug.com/index.php/%D9%82%D9%84%D9%85%D9%87%D8%A7%DB%8C_%D8%B3%D8%B1%DB%8C_%D8%A7%DB%8C%DA%A9%D8%B3_%D9%86%D8%B3%D8%AE%D9%87%D9%94_%DB%B2\n[irmug-english]: http://wiki.irmug.com/index.php/X_Series_2\n\n[texlive]: https://tug.org/texlive/\n[mactex]: https://tug.org/mactex/\n[xepersian]: https://ctan.org/pkg/xepersian\n[persian-bib]: https://ctan.org/pkg/persian-bib\n[glossaries]: https://ctan.org/pkg/glossaries\n[todonotes]: https://ctan.org/pkg/todonotes\n[bibtex]: https://ctan.org/pkg/bibtex\n[xindy]: https://ctan.org/pkg/xindy\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinamomken%2Ftehran-thesis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsinamomken%2Ftehran-thesis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinamomken%2Ftehran-thesis/lists"}