واحدها (Units)

واحدها با نام و تعریفشان که با فاصله (whitespace) از هم جدا شده‌اند، تعریف می‌شوند. در صورت نیاز می‌توان یک تعریف را با استفاده از \ در چندین خط شکست.

foot                    12 inch

کامنت‌های مستندسازی خطوطی هستند که با ?? شروع می‌شوند. آن‌ها روی تعریف بعدی که پس از آن‌ها می‌آید اعمال می‌شوند و زمانی که در Rink یک تعریف را استعلام می‌کنید، به کاربران نهایی نمایش داده می‌شوند.

?? International yard and pound, since July 1, 1959.
?? Documentation comments can be broken over
?? multiple lines.
foot                    12 inch

مواد (Substances)

مواد می‌توانند نمایانگر یک جرم یا جسم مشخص (مانند زمین یا خورشید)، ماده‌ای مانند آب یا بتن، یک مولکول شیمیایی، عنصری از جدول تناوبی، یا یک ذره بنیادی باشند.

یک ماده دارای نام، یک نماد اختیاری (مورد استفاده در فرمول‌های شیمیایی)، و حاوی فهرستی از ویژگی‌ها درون یک بلوک {} است.

ویژگی‌ها می‌توانند ثابت (“const”) باشند که عمدتاً برای اشیاء شمارش‌پذیر مانند ذرات استفاده می‌شود، یا می‌توانند یک نسبت باشند، مانند چگالی یک ماده.

neutron {
    mass                const neutron_mass          1.00866491588 u
    wavelength          const neutron_wavelength    planck_constant / mass c
    magnetic_moment     const neutron_moment        -0.96623650e-26 J/T
}

دو حالت ساختاری برای ویژگی‌ها عبارتند از:

[name] const [output name] [expression]
[name] [input name] [input expression] / [output name] [output expression]

نام ورودی و نام خروجی ممکن است گیج‌کننده به نظر برسد. ایده این است که ویژگی‌های وابسته به زمینه بتوانند از نسبت‌هایی مانند چگالی محاسبه شوند؛ برای نمونه، mass of 1ml water (جرم ۱ میلی‌لیتر آب). برای کارکرد این قابلیت، density (جرم تقسیم بر حجم) با ۳ نام تعریف می‌شود: density (خود نسبت)، mass (جرم)، و volume (حجم).

density mass 1g / volume cm^3

این تبدیل‌ها در جهت عکس نیز کار می‌کنند: volume of 1g water (حجم ۱ گرم آب).

دسته‌ها (Categories)

واحدهای درون یک دسته، در رابط کاربری هنگام جستجو و سایر عملیات با یکدیگر گروه‌بندی می‌شوند. یک دسته با استفاده از عملگر !category آغاز می‌شود که یک شناسه (lower_snake_case) و یک نام نمایشی به صورت رشته متنی دریافت می‌کند.

!category us_survey "US survey measures"

واحدهای پایه (Base units)

واحدهای پایه را نمی‌توان بر حسب واحدی دیگر بدون ایجاد یک چرخه تعریف کرد. آن‌ها نمایانگر کمیت‌های فیزیکی بنیادین مانند زمان، طول، دما و غیره هستند.

نام یک فرم کوتاه است که هنگام نمایش ابعاد استفاده می‌شود (برای نمونه، بعد acceleration برابر است با m / s^2)، در حالی که شکل بلند برای اهداف نمایشی به کار می‌رود.

واحدهای پایه جدید فقط زمانی باید اضافه شوند که ارزش روشنی برای این کار وجود داشته باشد؛ مانند رادیان و بیت.

?? Equal to the mass of the international prototype of the
?? kilogram. 3rd CGPM (1901, CR, 70).
kg        !kilogram

کمیت‌ها (Quantities)

کمیت‌ها هر زمان که rink یک واحد را نمایش می‌دهد درون پرانتز نشان داده می‌شوند. آن‌ها برای تحلیل ابعادی بسیار مفید هستند، زیرا به خاطر سپردن اینکه kg m^2 / s^2 به معنای کمیت فیزیکی انرژی است می‌تواند دشوار باشد.

کمیت‌ها مشابه واحدها تعریف می‌شوند، اما تعریف آن‌ها با نویسه ? شروع می‌شود. کمیت‌ها در فضانامی جداگانه از واحدها قرار دارند، بنابراین تنها نام‌های معتبری که می‌توان استفاده کرد واحدهای پایه و سایر کمیت‌ها هستند.

برخلاف واحدها، کمیت‌ها فاقد مقدار عددی هستند (حتی مقداری مانند ۱ مانند واحدهای مشتق SI ندارند).

length                  ? meter
area                    ? length^2

پیشوندها (Prefixes)

پیشوندها امکان ورود واحدهایی مانند gigabytes، megameters، kiloseconds را بدون نیاز به تعریف صریح تک‌تک آن‌ها در پایگاه‌داده واحدها فراهم می‌کنند. پیشوندها همیشه بدون بعد هستند.

این موارد نباید به صورت مکرر اضافه شوند، بلکه فقط زمانی که مربوط به یک سامانه شمارش خاص باشند؛ مانند پیشوندهای بایت در مبنای دو (MiB، GiB و غیره) و پیشوندهای دوازده‌تایی (Dozenal).

پیشوندها به دو دسته پیشوندهای “بلند” و پیشوندهای “کوتاه” تقسیم می‌شوند. پیشوندهای کوتاه معمولاً باید تنها ۱ حرف باشند و به طور معمول نام مستعار پیشوند بلند متناظر خود هستند.

پیشوندها مشابه سایر واحدها تعریف می‌شوند، اما نام آن‌ها با پسوند - (پیشوندهای بلند) یا -- (پیشوندهای کوتاه) خاتمه می‌یابد.

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

kilo-                   1e3
k--                     kilo

متفرقه (Miscellaneous)

یک عملگر خاص به نام !dependency وجود دارد که در currency.units برای اعلام وابستگی به داده‌های زنده نرخ ارز استفاده می‌شود. این عملگر را می‌توان هنگام افزودن ارز جدید یا منبع داده با به‌روزرسانی زنده به کار برد.

نام‌گذاری (Naming)

نام‌های انگلیسی باید با حروف کوچک و بدون جداکننده باشند. در صورتی که به وضوح کمک کند، کلمات را می‌توان با زیرخط (underscore) جدا کرد؛ نمونه‌ها شامل foot، olympiccubit، usgallon.

در صورت موجود بودن فرم کوتاه، باید به عنوان نام مستعار برای نام طولانی‌تر اضافه شود؛ مانند ft برای foot، B برای byte، و Ω برای ohm.

ft                      foot

برخی واحدها معمولاً با خط غیرلاتین نوشته می‌شوند. از نام غیرلاتین به عنوان نام استاندارد (canonical) استفاده کنید و نام مبتنی بر ASCII را به عنوان مستعار اضافه نمایید؛ نمونه‌ها شامل золотник، 分地.

برخی واحدها به طور معمول با یک نماد نوشته می‌شوند. با این موارد مشابه نام‌های با خط غیرلاتین رفتار کنید؛ مانند π (پی)، τ (تاو).

نمادهای قدیمی یونیکد تنها باید به عنوان مستعار برای نام‌های استانداردتر استفاده شوند؛ از جمله نمادهای کم‌کاربرد مانند ㎒ (نماد یونیکد مگاهرتز).

اگر چندین نام برای یک واحد وجود دارد، نامی که متداول‌تر است باید “نام استاندارد” باشد. نسخه استاندارد باید تعریف کامل را داشته باشد و سایر نام‌ها به عنوان مستعارهایی به نسخه استاندارد ارجاع دهند؛ از تکرار تعریف بپرهیزید.

تعاریف (Definitions)

واحدها در صورت امکان باید بر حسب سایر واحدهای مرتبط تعریف شوند. عبارتی که برای تعریف واحد استفاده می‌کنید به کاربر نهایی نمایش داده خواهد شد. برای نمونه، فوت به عنوان 12 inch تعریف می‌شود نه 304.8 mm، زیرا پیشاپیش مدخل جداگانه‌ای برای inch وجود دارد که به عنوان 2.54 mm تعریف شده است. هنگام نمایش تعریف یک واحد، Rink هم تعریف اصلی و هم مقدار مطلق را نشان می‌دهد؛ بنابراین برای foot نشان می‌دهد که به صورت 12 inch تعریف شده که برابر با 304.8 millimeter است.

ابزار Rink می‌تواند اعداد گویای با دقت دلخواه را نشان دهد و تنها محدودیت، حافظه در دسترس است. در نتیجه، اعداد گنگ مانند عدد پی یا ثابت اویلر باید حداقل تا ۲۰ رقم اعشار تعریف شوند.

ثابت‌های جهان‌شمول که به طور تجربی اندازه‌گیری می‌شوند باید تا جای ممکن ارقام بااهمیت شناخته‌شده داشته باشند. برای نمونه، اگر عددی تا ۰٫۰۰۰۰۰۳± شناخته شده باشد، باید تا ۶ رقم بعد از اعشار درج گردد.

منابع (Sources)

بهترین منابع، اسناد استاندارد مانند اسناد منتشرشده توسط CGPM، ISO و NIST هستند.

برگه‌های اطلاعاتی (fact sheets) منتشرشده توسط سازمان‌های معتبر مانند NASA و ESA نیز مناسب هستند.

منابع و پایگاه‌های داده باکیفیت مانند Engineering Toolbox برای مقادیری که به صورت تجربی مشخص شده‌اند خوب هستند.

کتاب‌ها برای واحدهای تاریخی مناسبند، اما بهتر است به مواردی بسنده شود که به صورت آنلاین از طریق سایت‌هایی چون Google Books قابل مشاهده و راستی‌آزمایی باشند.

از ارجاع مستقیم به ویکی‌پدیا در صورت امکان باید خودداری شود؛ در عوض بررسی کنید ویکی‌پدیا به چه منبعی ارجاع داده و از همان منبع استفاده کنید.