ویکی‌کد:شیوه‌نامه

از ویکی‌کد، دانشنامهٔ برنامه‌نویسی
پرش به ناوبری پرش به جستجو

کدگذاری

همهٔ حروف و علائم باید با استفاده از نویسهٔ صحیحشان در نوشته آورده شوند. کد نویسه‌های صحیح فارسی در استاندارد ملی ۶۲۱۹ ایران آمده‌است. درست «بی‌باک». غلط: «بي باك».

دستور خط

  1. برای ترکیب‌های اضافی و وصفی منتهی به «ه‍» ناملفوظ، مثل «خانهٔ بزرگ»، از نویسهٔ «ی روی ه‍» استفاده می‌شود. درست: «خانهٔ بزرگ». غلط: «خانه بزرگ»، «خانه ی بزرگ»، «خانه‌ی بزرگ».
  2. برای همزه روی ه از تک‌نویسهٔ ۀ استفاده نکنید. این نویسه استاندارد نیست و کاربرد آن در زبان‌هایی مثل اردوست. در بعضی از نسخه‌های قدیمی‌تر قلم‌ها این حرف به حرف پیشین نمی‌چسبد. درست: خانهٔ = خانه + ٔ . غلط: خانۀ = خان + ۀ.
  3. علامت جمع ها هم به صورت بی‌فاصله و هم با فاصلهٔ مجازی به کلمهٔ جمع‌شونده می‌چسبد و هر دو صورت صحیح است: (کتابها و کتاب‌ها) در چند مورد خاص حتماً با فاصلهٔ مجازی نوشته می‌شود. از این رو اگر همواره با فاصلهٔ مجازی نوشته شود مشکلی پیش نمی‌آید. در هیچ موردی ها با فاصلهٔ معمولی نوشته نمی‌شود: (کتاب ها) مواردی که حتماً از فاصلهٔ مجازی استفاده می‌شود از قرار زیرند:
    1. بعد از های ناملفوظ: خانه‌ها
    2. بعد از های ملفوظ که به حرف قبل بچسبد: تشبیه‌ها
    3. بعد از ط یا ظ: استنباط‌ها
    4. کلمه پردندانه باشد. (بیش از سه دندانه)
    5. نشان دادن صورت مفرد کلمه
    6. کلمه‌های خارجی نامأنوس
    7. جمع بستن اسم خاص
  4. عموماً پیشوند جدا (با فاصلهٔ مجازی) نوشته می‌شود (مثال: «هم‌شکل») مگر اینکه به صورت سرهم معنایی بسیط از کلمه استنباط شود (مثال: «همسایه»).
  5. پسوند چسبیده نوشته می‌شود (مثل دانشمند) (مگر اینکه حرف آخر جزء اول و حرف اول پسوند هم‌مخرج باشند یا حرف آخر جزء اول ه باشد: نظام‌مند و علاقه‌مند).
  6. کلماتی که ترکیب دو یا چند کلمه‌اند در صورتی که معنای کلمهٔ جدید بسیط گونه باشد، سرهم (مگر اینکه جزء دوم با «آ» آغاز شود) و در غیر این صورت با فاصلهٔ مجازی نوشته می‌شوند: «نیشکر» برای مورد اول (دانش‌آموز به عنوان استثناء) و «آب‌میوه» برای مورد دوم.
  7. کرسی همزه با توجه به حرکت حرف پیشین تعیین می‌شود:
    1. اگر حرکت پیش از همزه ساکن یا زیر باشد همزه به صورت ئ‍ نوشته می‌شود. مثال: هیئت. در صفحه‌کلید استاندارد همزه با کرسی ی با shift + s وارد می‌شود.
    2. اگر حرکت پیش از همزه زبر باشد همزه به صورت أ نوشته می‌شود. مثال: تأثیر. در صفحه‌کلید استاندارد همزه با کرسی ا با shift + G وارد می‌شود.
    3. اگر حرکت پیش از همزه پیش باشد. همزه به صورت ؤ نوشته می‌شود. مثال: مؤسسه. در صفحه‌کلید استاندارد همزه با کرسی و با shift + A وارد می‌شود.
    4. استثنا: اگر حرکت قبل از همزه ضمه باشد و حرف بعد از همزه و باشد همزه به صورت ئ‍ نوشته می‌شود. مثال: شئون.

دستور زبان و سبک نگارش

سبک متون در تمامی پروژه‌های ویکی‌کد باید رسمی باشد، همچنان که در دانشنامه‌های معتبر است. رسمی‌نوشتن لزوماً به معنی متکلف نوشتن یا به کارگیری کلمه‌های ثقیل نیست.

از مصداق‌های سبک رسمی این است که معمولاً از صیغه‌های اول شخص استفاده نمی‌شود و به جای آن صیغهٔ مجهول به کار می‌رود. مثلاً به جای این که گفته شود: «در بند سوم به این موضوع اشاره می‌کنیم» گفته می‌شود: «در بند سوم به این موضوع اشاره می‌شود.»

در سبک رسمی از شکسته‌نویسی خاص زبان گفتاری پرهیز می‌شود: درست: «می‌رود» نادرست: «می‌ره». از جمله خطاهای فصاحتی که در زبان گفتاری شیوع می‌دارد و بعضاً در نثر رسمی هم نفوذ کرده‌است، خطای حذف افعال بی قرینهٔ لفظی و گاه حتی معنوی‌است. مثلاً به جای اینکه گفته شود «فلانی این کار را کرده‌است»، گفته می‌شود: «فلانی این کار را کرده.»

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

در پروژه‌های ویکی‌کد حتی‌المقدور از مضارع اخباری باشیدن استفاده نمی‌شود. پیشنهاد می‌شود: «است»، «هستند» یا «اند»، «نیست» پیشنهاد نمی‌شود: «می‌باشد»، «می‌باشند»، «نمی‌باشد». بسیاری از کسان هنگامی که دست به نوشتن متنی رسمی می‌زنند با تلقی‌ای که از متن رسمی دارند لحن کلامشان تغییر می‌کند و از بیان مفاهیم در قالب جمله‌های ساده در می‌مانند. لحن اداره‌جاتی از تبعات همین طرز تفکر است. استفادهٔ بی‌رویه از «می‌باشد» یکی از مصادیق این لحن است. دعوت به اجتناب از استفادهٔ بی‌رویه از «می‌باشد» و امثال آن به این معنی نیست که نویسندگان حق استفاده از این قبیل کلمات را ندارند. گاه ممکن است کاربرد «می‌باشد» زیبنده‌تر دانسته شود. مثلاً «احمد برادر مردی که آنجا ایستاده‌است می‌باشد». هرچند اینجا هم با کمی خلاقیت پرهیز از آن ممکن است: «احمد برادر مردی است که آنجا ایستاده».

  • نشانهٔ مفعولی «را» را باید هر چه نزدیکتر به خود مفعول نوشت. استعمال «را» پس از فعل به خلاف سنت هزار و دویست سالهٔ زبان فارسی است و در همه حال باید از آن پرهیز کرد. درست: «کتابی را که آورده بود، برد.» غلط: «کتابی که آورده بود را برد».
  • باید تا جای ممکن کوشید که قوانین نحو عربی در نوشتار فارسی به کار نرود: غلط «مقالات مربوطه» درست «مقالات مربوط» یا «مقاله‌های مربوط».

نقطه‌گذاری

علامت‌های نقطه‌گذاری به دو گروه کلی تقسیم می‌شوند: منفرد و مزدوج

علامت‌های نقطه‌گذاری منفرد[ویرایش متنی]

علامت‌های نقطه‌گذاری منفرد علامت‌هایی هستند که به‌تنهایی ظاهر می‌شوند و لزوماً با علامت دیگری به کار نمی‌روند. نمونه: نقطه (.) و ویرگول (،).

هنگام استفاده از آن‌ها باید نکته‌های زیر را رعایت کرد:

  • بدون فاصله با نویسهٔ پیشین وارد می‌شوند.
  • میان آن‌ها و حرف (الفبای) بعدی یک فاصله وجود دارد.
درست
  • «دارا انار دارد. سارا انار ندارد.»

نادرست

  • «دارا انار دارد.سارا انار ندارد.»
  • «دارا انار دارد .سارا انار ندارد.»
  • «دارا انار دارد . سارا انار ندارد.»

علامت‌های نقطه‌گذاری مزدوج

علامت‌های نقطه‌گذاری مزدوج علامت‌هایی هستند که با علامتی دیگر به صورت مزدوج به کار می‌روند. نمونه: کمان به صورت زوجِ کمان باز ( و کمان بسته ) به کار می‌رود.

هنگام استفاده از آن‌ها باید نکته‌های زیر را رعایت کرد:

  • نویسهٔ باز با حرف پیشین فاصله دارد و حرف بعدی بدون فاصله با آن نوشته می‌شود.
  • نویسهٔ بسته بدون فاصله با حرف پیشین نوشته می‌شود. حرف بعدی با آن فاصله دارد.
درست

«دارا (شخصیت محبوب ما) انار دارد.»

نادرست
  • «دارا(شخصیت محبوب ما) انار دارد.»
  • «دارا ( شخصیت محبوب ما) انار دارد.»
  • «دارا (شخصیت محبوب ما)انار دارد.»
  • «دارا (شخصیت محبوب ما )انار دارد.»
  • «دارا ( شخصیت محبوب ما ) انار دارد.»
  • سایر موارد مشابه


نقل قول (گفتاورد)

  • برای نقل قول و موارد مشابه، از «گیومهٔ فارسی» استفاده می‌شود، نه از علامت نقل قول تکی یا دوتایی انگلیسی. درست: «نقل قول». غلط: "نقل قول" و 'نقل قول'.

نوشتن تاریخ‌ها

  • برای نوشتن تاریخ روز را با عدد، ماه را با حروف و سال را با عدد وارد کنید. برای مثال:
  • «۲۲ خرداد ۱۳۸۸» درست
  • «بیست‌ودوم خرداد ۱۳۸۸» غلط
  • «۱۳۸۸/۳/۲۲» غلط
  • «۲۳-۰۱-۲۰۱۱» غلط

نکته: برای ذکر نام ماه‌های میلادی، از لفظ فرانسوی آن‌ها استفاده می‌شود:

ژانویه، فوریه، مارس (مارچ)، آوریل (آپریل)، مه (می)، ژوئن (جون)، ژوئیه (جولای)، اوت (آگوست)، سپتامبر، اکتبر، نوامبر و دسامبر.

عددها

برای نوشتن عددها از رقم‌های فارسی استفاده می‌شود: ۱۲۳۴۵۶۷۸۹۰. توجه شود که ارقام عربی با ارقام فارسی متفاوت هستند. برای نوشتن ممیز از نویسهٔ «٫» با کد (دهدهی) استفاده می‌شود. در صفحه‌کلید استاندارد این نویسه با shift+3 وارد می‌شود. برای جداکردن هزارگان از نویسهٔ «٬» با کد (دهدهی) استفاده می‌شود. توجه شود که در بعضی مرورگرها خصوصاً در سیستم‌عامل ویندوز و هنگامی که نسخهٔ صحیح قلم استفاده نشده باشد این نویسه هم‌شکل با ویرگول (،) با کد (دهدهی) نشان داده می‌شود. دو نویسهٔ ویرگول و جداکنندهٔ هزارگان نباید به جای یک‌دیگر به کار روند. در صفحه‌کلید استاندارد جداکنندهٔ هزارگان با shift+2 و ویرگول با shift+7 وارد می‌شود.

نوشتن عددها به حروف

  • معمولاً اعدادی که در املاء آن‌ها واوِ عطف به‌کار نرفته باشد با حروف نوشته می‌شوند، مانند: «یک، دو، سه، ... ده، یازده، ... نوزده؛ بیست، سی، ... نود، صد، دویست، ... نهصد؛ هزار، دو هزار»
  • اعدادی که در املاء آن‌ها واوِ عطف به‌کار رفته‌باشد ترجیحاً با رقم نوشته می‌شوند: «۲۵؛ ۲۴۵؛ ۲۰۲۴»
  • برای به حروف نوشتن اعدادی که در املاء آنها واوِ عطف به کار رفته، ترجیحاً از فاصله کامل استفاده می‌شود و از فاصله مجازی پرهیز می‌گردد:
    • «بیست و پنج» درست
    • «بیست‌وپنج» نادرست
    • «هشت و نیم» درست
    • «هشت‌ونیم» نادرست
  • برای نوشتن اعداد ترتیبی از حروف استفاده می‌شود؛ استفاده از ترکیب عدد و «مین» یا «ام» اشتباه فاحش است:
    • «هشتم» درست
    • «۸ام» نادرست
    • «۸-ام» نادرست
    • «هشتمین» درست
    • «۸مین» نادرست
    • «۸-امین» نادرست

«/» میان ارقام[ویرایش متنی]

صفحه اصلی: ویکی‌پدیا:مشکل اسلش

از «/» برای نوشتن عددهای کسری و تاریخ (نظیر ۱۳۱۰/۱۱/۱۲) استفاده می‌شود. استفاده از «/» به جای ممیز (٫) غلط فاحش است. از آنجا که ترتیب نمایش اجزای کسر در مرورگرها تفاوت می‌کند و نیز از آنجا که مطابق استاندارد یونیکد نویسه‌های نوشته باید به ترتیب منطقی وارد شوند پیشنهاد می‌شود که همواره برای محکم‌کاری کسرها به ترتیب زیر وارد شوند:

  1. {{چر}}
  2. صورت
  3. /
  4. مخرج

نمونه: کسر «دو پنجم» به صورت {{چر}}۲/۵ وارد می‌شود تا به صورت ‎۲/۵ نمایش داده شود.

توجه
وارد نکردن {{چر}} و جابجایی صورت و مخرج برای نمایش درست کسر در اینترنت اکسپلورر نادرست است و منجر به گیج‌کنندگی و نادرستی متن می‌شود و باید از آن اجتناب شود.

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

خلاصه کردن بازه‌های عددی[ویرایش متنی]

میانبر:

  • وپ:بازه

برای خلاصه کردن بازه‌های عددی از قاعدهٔ زیر استفاده کنید:

عدد اول عدد دوم مثال
کمتر از ۱۰۰ همهٔ رقم‌ها نوشته شود ۱۰–۶

۶۴–۶۳ ۱۲۳–۹۸

۱۰۰ یا مضاربش همهٔ رقم‌ها نوشته شود ۱۰۶–۱۰۰

۱۳۲۳–۱۳۰۰

۱۰۱ تا ۱۰۹

۲۰۱ تا ۲۰۹ و به همین قیاس

فقط قسمت متغیر نوشته شود ۷–۱۰۲

۲۲–۷۰۹ ۵–۱۲۰۲

۱۱۰ تا ۱۹۹

۲۱۰ تا ۲۹۹ و به همین قیاس

دو رقم نوشته شود

مگر آنکه برای شامل‌شدن قسمت‌های متغیر به ارقام بیشتری نیاز باشد

۳۶–۲۳۲

۸۱۱–۷۹۳ ۶۷–۱۴۶۲ ۸۰۰–۱۷۹۲ ۷۱۸–۱۳۶۸۸ ۷۰۰۴–۱۶۹۹۵