Mehrdadghassabi / isfahan-thesis

LaTeX template for BSc thesis of University of isfahan - قالب لاتک پایان‌نامه کارشناسی دانشگاه اصفهان

isfahan-thesis

LaTeX template for final BSc project in University of isfahan.

قالب لاتک پروژه کارشناسی دانشگاه اصفهان

راهنمای فارسی

ویژگی‌ها

1. منطبق با «دستورالعمل نگارش و تدوین پایان‌نامه» دانشگاه تهران، ویرایش اول، شهریور ۱۳۹۲.
2. طراحی مدولار و انعطاف‌پذیر، به همراه دستورات از پیش‌تعریف‌شده برای مشخصات متغیر یک پایان‌نامهٔ دانشگاه تهران (مثل عنوان، نام دانشجو، استاد راهنما، تاریخ و غیره).
3. ‫استفاده از قلم‌های استاندارد سری X نسخهٔ ۲ یا قلم‌های استاندارد سری IRFonts اثر شورای عالی اطلاع‌رسانی (به جای قلم‌های غیراستاندارد BFonts).
4. حاوی توضیحات گویا در مورد چگونگی استفاده از این قالب و نیز نکات لازم در مورد نوشتن هر فصل یک پایان‌نامهٔ دانشگاه تهران.
5. قابلیت انتخاب سبک‌های ارجاع‌دهی فارسی گوناگون برای رشته‌های مختلف، مطابق با سیستم‌های شماره‌دار و نویسنده-سال.
6. ‫مدیریت هوشمند واژه‌نامه‌ها و درج اصطلاحات تخصصی، با استفاده از بستهٔ glossaries و موتور xindy.
7. ‫قابلیت حاشیه‌نویسی مستقیم در فایل‌های TeX در حالت پیش‌نویس، با استفاده از بستهٔ todonotes.
8. امکان درج شکل‌ها، جداول مختلف، نمودارهای tikz، الگوریتم‌های فارسی و لاتین و کدهای رنگی؛ بعلاوهٔ فهرست‌هایی از آنها.
9. سربرگ استاندارد، فاصلهٔ مناسب حاشیه‌ها در حالت یک‌رو و دورو و شماره‌دهی صفحات منطبق بر دستورالعمل نگارش.

چگونه استفاده کنیم؟

با دستور زیر نیز می‌توانید به آخرین نسخهٔ در حال توسعهٔ قالب دسترسی داشته باشید:

https://github.com/Mehrdadghassabi/isfahan-thesis --single-branch

‫قالب پایان‌نامه isfahan-thesis_ در واقع یک بستهٔ قابل‌حمل است که بگونه‌ای طراحی شده تا مشخصات متغیر پایان‌نامه توسط دانشجو عوض شود و مطالب پایان‌نامه نیز توسط وی در فصول مختلف وارد گردد. به هیچ تلاشی برای قالب‌بندی نیاز نیست و تنها کافی است دانشجو طبق توضیحات، مطالب خود را وارد نماید. در نتیجه این قالب به نصب نیاز ندارد. با این حال، این قالب از تکنولوژی‌ها و بسته‌های مختلفی استفاده می‌کند. پیش‌نیازهای زیر قبل از استفاده از قالب باید نصب باشند:

پیش‌نیازها

• ‫نصب کامل texlive بر روی لینوکس، ویندوز یا MacTex بر روی سیستم‌عامل مک. خصوصاً بسته‌های لاتک زیر باید نصب باشند:
  • زی‌پرشین: تمام امکانات حروف‌چینی زبان فارسی در این قالب پایان‌نامه، با بستهٔ XePersian فراهم شده است.
  • ‫persian-bib: سبک‌های ارجاع‌دهی فارسی با این بسته فراهم شده‌اند.
  • ‫glossaries: بسته مدیریت پیشرفتهٔ واژه‌نامه‌ها در لاتک.
  • ‫todonotes: امکان حاشیه‌نویسی و نکته‌گذاری را در فایل‌های TeX شما فراهم می‌آورد.
• ‫latexmk: برنامه‌ایست معادل make برای پروژه‌های لاتک که مراحل مختلف کامپایل را در صورت نیاز تکرار می‌کند (باید در نسخه کامل texlive باشد).
• ‫bibtex: برنامهٔ ساخت فهرست مراجع و کتابشناسی (باید در نسخه کامل texlive باشد) و بستهٔ persian-bib.
• ‫xindy: برنامهٔ پشتی مورد نیاز برای ساخت واژه‌نامه‌ها و نمایه‌ها.
  • زبان persian یا persian-variant3 باید برای xindy نصب باشد (که در اوبونتو 16.04 دستی باید دانلود و کپی شود).
• ‫یک ویرایشگر یا IDE برای پروژه‌های TeX، ترجیحاً با پشتیبانی از زبان‌های دوجهته یا راست به چپ، مثل BiDiTexmaker.
• ‫[اختیاری] نصب قلم‌های سری X نسخهٔ ۲ و Junicode در سیستم‌عامل‌تان.

English Readme

Features

1. Compliant with "Manual of writing and editing thesis of University of Tehran", Sep. 2013.
2. Modular and flexible design, with predefined commands for variables of a standard UT thesis (title, name, supervisor, date, ...).
3. Use of standard X Series 2 fonts or standard IRFonts by SCICT (instead of non-standard BFonts).
4. Based on professional templates "IUST-Thesis" and "HSU-Thesis-V1" by Mahmood AminToosi.
5. Contains self-describing texts explaining how to use this template and notes about writing each chapter of a thesis.
6. Ability to choose different Persian bibliography styles for various specialities, compliant with author-number or author-date systems.
7. Smart glossaries management using glossaries package and xindy backend.
8. Commenting & review directly inside draft version of tex files, by using todonotes package.
9. Ability to include figures, different tabulars, tikz diagrams, Persian & English algorithms and colorized code listings; And their catalogue.
10. Standard headers, odd/even margins and page numberings.

How to Use

by the following command you can access to the latest developing version of template:

git clone https://github.com/Mehrdadghassabi/isfahan-thesis  --single-branch

isfahan-thesis latex template is a portable package, that is designed for customization by the student to fill his/her thesis materials. Therefor, it doesn't need any installation. However, it uses many technologies to fulfill its duties. Dependencies below must be installed:

Prerequisites

• Full texlive installation for Linux or Window, Or MacTex for MacOS. Specially, latex packages below should be installed:
  • XePersian: All persian properties are based on XePersian package.
  • persian-bib: Bibliography styles are provided by persian-bib package.
  • glossaries: Advanced glossary management package.
  • todonotes: Provides commenting and todo notes available in your tex files.
• latexmk: equivalent of make for latex projects (should be included in a full texlive installation).
• bibtex: bibliography creation backend engine (should be included in a full texlive installation) and persian-bib package.
• xindy: glossary/indexing backend engine.
  • persian or persian-variant3 language should be installed for xindy (not available by default in Ubuntu 16.04).
• A TeX editor/IDE with RTL support, e.g. BiDiTexmaker.
• [Optional] X Series 2 & Junicode Fonts installed in your system.