عمومی > عمومی

چگونگی ساختن یک مثال می‌نیمم (minimum example) برای رفع خطاها بوسیله دیگر کاربران

(1/1)

وحید دامن‌افشان:
هنگام پرسیدن سوال‌ در این تالار و یا هر تالار دیگر مرتبط با لاتک، بهترین راه برای سریع رسیدن به جواب، پیوست کردن یک مثال می‌نیمم یا کمینه (minimum example) و در عین حال، قابل پردازش، به سوال پرسیده شده است که تا حد ممکن، خلاصه شده باشد.
اما چطور یک minimum example بسازیم؟
فرض کنید یک فایل ۴۰۰ خطی دارید که بعد از اجرا با ۳ خطا (error) مواجه می‌شوید. برای اینکه این فایل، یک minimum example بشود، شروع به حذف کردن قسمت‌های اضافی می‌کنید و تا جایی ادامه می‌دهید که آن ۳ خطا، همچنان باقی بمانند. منظور از قسمت‌های اضافی، بسته‌ها یا دستورهایی هستند که هیچ نقشی در ایجاد خطا ندارند و باید حذف بشوند. بعد از اینکه، فایل‌ تا حد ممکن، خلاصه شد، آن را موقع پرسیدن سوال‌‌مان، به سوال‌ پیوست می‌کنید. از مزیت‌های این روش این است که دیگر کاربران، موقع دیدن سوال شما، به راحتی و در کمترین زمان ممکن، می‌توانند مشکل شما رو تشخیص بدهند و برای حل مشکل، راهنمایی کنند.
توضیحات بیشتر را می‌توانید در اینجا و اینجا ببینید.

ابوالفضل دیانت:
منظور از مثال کمینه یا نمونه:

نکته اول: منظور از مثال نمونه یعنی فایل با پسوند .tex شما به همراه فایل pdf‌ خروجی و فایلی که هم نام با فایل با پسوند .tex شما است و فقط پسوند آن .log‌است. در صورت استفاده از فایل استایل فایل استایل با پسوند .cls را نیز اتچ نمایید. شما می توانید این فایل ها را همگی در یک شاخه قرار داده و آن را با پسوند zip در سایت قرار دهید.
مثلا فرض کنید که شما یک فایل به نام mypaper با Latex نوشته اید، منظور از مثال نمونه یعنی شما در سایت فایل های زیر را بارگذاری کنید:
mypaper.tex
mypaper.log
mypaper.pdf
منظور از فایل استایل فایلی است هم نام با نامی که شما در خط اول نوشته اید:

--- کد: ---\documentclass{mystyle}
--- End code ---
اگر در این قسمت کلماتی مثل report، book، artilce، memoir و موارد استانداردی مانند ieeetran‌نوشته بود نیازی نیست این ها را بگذارید چون این ها استاندارد خود latex‌و یا بسته های استاندارد هستند، اما در غیر این صورت شما حتما باید در کنار فایل های خود فایلی با پسوند .cls مشاهده کنید که آن را نیز لازم است در سایت بارگذاری کنید. مثلا در این مثال فایل mystyle.cls را باید بارگذاری کنید.

نکته دوم: برای اتچ کردن فایل ها نیز کافی است در هنگام زدن یک پست جدید در سایت از قسمت (انتخابهای اختیاری بیشتر) یک فایل یا چندین فایل را اتچ نمایید.

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

نکته چهارم: دقت کنید مثال شما باید به گونه ای باشد که افراد دیگر با بتوانند با موفقیت آن فایل را کامپایل کنند. در خیلی از موارد دوستان یک فایل را به صورت ناقص می فرستند، مثلا فایل tex‌ را می فرستند ولی فایل cls‌ که استفاده کردند را نمی فرستند.

نکته پنجم: در مورد قرار دادن pdf به جای فایل کمینه، مثلا فرض کنید که می خواهید به دوستان بگویید که یک جدول یا شکل یا ... شبیه آن چیزی که در فایل pdf است، می خواهید ترسیم شود، در این حالت نیازی به فرستادن فایل tex نیست، اما برخی مواقع مثلا فایل tex شما مشکلی دارد و یا یک رفتار غیرعادی دارد، در این مواقع باید فایل tex + log + pdf‌ هر سه را بفرستید.

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

کنترل

[0] صندوق پستی