Environment

مقدمه

در نوشتن مستند، دسته‌ای از عبارتها و قرارداده وجود دارد که در تمام مستندها مشترک است. در اینجا تمام این قراردادها به صورت کامل مورد بررسی قرار گرفته است. محیط عبارت است از یک دستور به فرم کلی زیر

\begin{environment name}
	text
\end{environment name}

هر محیط (همانگونه که در نمونه آورده شده است) با استفاده از یک نام مشخص می‌شود که در بدنه آن یک متن قرار می‌گیرد. متن نوشته شده در هر محیط بر اساس قراردادهای آن محیط در مستند تولید شده ظاهر می‌شوند. برای نمونه در محیط رابطه‌های ریاضی متن نوشته شده به عنوان یک رابطه ریاضی در مستند ظاهر می‌شود. در این مستند تمام محیط‌های استاندارد در الگوها به صورت کامل مورد بررسی قرار گرفته است:

محیط‌های استاندارد

محیط‌های استانداردی از پیش تعریف شده‌اند که می‌توان آنها را بدون نگرانی در مستند‌ها به کار برد. این محیط‌ها بر اساس الگوهای مورد استفاده به صورت مناسب باز نویسی شده اند تا نه تنها با الگوی کلی هماهنگ شوند بلکه استفاده از مستند‌های دیگر در مستندهای گروه نیز ممکن شود. این محیط‌ها عبارت اند از:

• array
• center
• description
• enumerate
• eqnarray
• equation
• euqation*
• figure
• flushleft
• flushright
• itemize
• list
• minipage
• picture
• quotation
• quote
• tabbing
• table
• tabular
• thebiblipgraphy
• theorem
• titlepage
• verbatim
• verse

رابطه‌های ریاضی

array

برای ایجاد یک آرایه از رابطه‌های ریاضی به کار می‌رود.

eqnarray

یک آرایه از فرمول‌های ریاضی را ایجاد می‌کند که همگی با هم در یک راستا مرتب شده اند.

equation

یک رابطه ریاضی ایجاد می‌کند که در وسط برگه قرار دارد. این رابطه دارای یک شماره خواهد بود.

euqation*

در وسط برگه یک رابطه ریاضی ایجاد می‌کند که شماره ندارد.

ساختار متن

center

یک پاراگراف را ایجاد می‌کند که تام خطهای آن در وسط برگه قرار می‌گیرد. در این محیط خطها با استفاده از \ از یکدیگر جدا می‌شوند.

flushleft

یک پاراگراف ایجاد می‌کند که خط‌های آن از سمت چپ مرتب شده اند. انتهای هر خط با استفاده از \ نمایش داده می‌شود.

flushright

یک پاراگراف ایجاد می‌کند که خط‌های آن از سمت راست مرتب شده اند. انتهای هر خط با استفاده از \ نمایش داده می‌شود.

فهرست‌ها

enumerate

یک فهرست شماره دار ایجاد می‌کند. این نوع فهرست را می‌توان تا چهار سطح تو در تو ایجاد کرد.

itemize

یک فهرست ایجاد می‌کند که گزینه‌های آن با استفاده از نقطه نشانه گزاری می‌شوند.

list

یک فهرست را در مستند ایجاد می‌کند.

description

یک فهرست ایجاد می‌کند که هر گزینه از آن شامل یک متن توصیفی است. زمانی که نیاز است یک فهرست از تعاریف ایجاد کرد از این محیط استفاده می‌شود.

موجودیت‌ها

figure

یک شئی را در متن جای می‌دهد که می‌توان آن را برچسب گزاری کرد و برای آن یک متن توصیفی نوشت.

picture

یک شکل را در مستند ایجاد می‌کند.

minipage

یک برگه کوچک ایجاد می‌کند که می‌تواند در جدول و یا فهرست به کار برود. از این نوع برگه ها می‌تواند در سرآیند و پانویس مستند نیز ظاهر شود.

جدولها

tabbing

محیط ایجاد یک جدول را به وجود می‌آورد

table

یک جدول همراه زیر نویس ایجاد می‌کند.

tabular

یک جدول را ایجاد می‌کند. این محیط به صورت معمول برای ایجاد جدول‌ها مورد استفاده قرار می‌گیرد.

thebiblipgraphy

محیط ارجاع و منابع را ایجاد می‌کند.

محیط‌های ویژه متن

گاهی در نوشتن یک مستند نیاز به نوشتن بسته‌هایی می‌شود که به عنوان پیام و یا اخطار در نظر گرفته می‌شود. در این قسمت تمام بسته‌های ویژه به صورت کامل تشریح شده است.

بسته‌های ویژه به صورت محیط‌های تازه در نظر گرفته می‌شود که هرکدام به یک شکل خاص در مستند ظاهر می‌شود. البته نباید تصور کرد که یک محیط خاص همواره در تمام مستندها به یک شکل ظاهر می‌شود.

note

نکته یک متن است که برای گوش زد کردن یک مطلب مهم در مستند مورد استفاده قرار می‌گیرد. استفاده از این محیط برای انتقال اطلاعاتی که دانستن آنها در درک بهتر مطلب مفید باشد بسیار کاربردی است و توصیه می‌شود که همواره از این تکنیک برای انتقال اطالاعات مفید استفاده کنید. برای نمونه زمانی که می‌خواهید یکی از پیشنیازهای استفاده از یک سیستم را به کاربران گوش زد کنید می‌توانید از این بسته استفاده کنید. کد زیر یک نکته را ایجاد می‌کند:

\begin{note}
پیش از اجرای سیستم باید پیش نیاز‌های آن را نصب کرد.
\end{note}

نکته می‌تواند در مستند‌های متفاوت به صورت‌های متفاوتی نمایش داده شود که ساده‌ترین نمایش آن در مستند‌ها به صورت زیر خواهد بود:

نکته: پیش از اجرای سیستم باید پیش‌نیازهای آن را نصب کرد.

warning

گاهی نیاز است در مورد یک نکته خاص به کاربران و خوانندگان سیستم اخطار داده شود. در اینگونه موارد از این محیط استفاده می‌شود. قالب کلی این محیط به صورت زیر است:

\begin{warning}
در این سیستم نیاز به استفاده از سیستم عامل لینوکس است.
\end{warning}

info

این محیط برای نوشتن اطلاعاتی به کار می‌رود که برای درک بهتر یک متن به کار می‌رود. در حالت کلی برای نوشتن اطلاعات اضافه باید به صورت زیر عمل کرد:

\begin{info}
برای دسترسی به داده‌ها کافی است که از میانبر آن استفاده کنید
\end{info}

problem

\begin{problem}
چگونه می‌توان یک محیط جدید در مستند ایجاد کرد؟
\end{problem}

reference

\begin{reference}
برای اطلاع بیشتر به مسیر زیر مراجعه کنید.
\end{reference}

verse

از این محیط برای نوشتن شعر استفاده می شود.

##verbatim

محیطی را ایجاد می‌کند که کاربر بتواند هر کاراکتر مورد نظر خود را وارد کند به گونه‌ای که این کاراکترها با استفاده از پردازشگرهای متنی دستکاری نشوند. به عبارتی متن نوشته شده در این قسمت دقیقا در خروجی ظاهر خواهد شد.

theorem

یک قضیه را در مستند ایجاد می‌کند.

quotation

یک پاراگراف ایجاد می‌کند که متن آن از دو طرف (راست و چپ) مرتب است. به صورت خودکار پاراگرافها به این صورت مرتب می‌شوند.

quote

متن را از دو طرف مرتب می‌کند.