توضیحاتی در مورد نحوهی نوشتار این مستندات و همچنین مطالبی که ممکن است در طول مستندات و کار با ماژول ها با آنها برخورد کنید در این بخش به شما داده میشوند.
این مستندات با استفاده از سیستم نوشتاری Markdown نوشته شده است.
سعی شده در طول نوشتن مستندات از یک قالب نوشتاری واحد استفاده شود که در زیر به بعضی از مشخصات این قالب میپردازیم.
برای توضیحات هر متد یا مشخصه از تیتر های خاکستری رنگ استفاده میشود.
همچنین در مورد متدها، مقدار بازگشتی آنها با استفاده از علامت فلش → استفاده شدهاست. در صورتی که متد مورد نظر آرگومان هایی را دریافت کند، به صورت همرنگ و همشکل با نام متد در زیر آن قرار میگیرد.
در ماژولهای طراحی شده از رویدادهای jQuery استفاده شده است.
سیستم رویدادهای jQuery به این شکل است که برای هر رویداد یک آرگومان ساخته شده توسط خود جیکوری که از نوع jQuery Event میباشد، همراه با آرگومان های داده شده هنگام جرقه زدن رویداد (trigger) به شنونده داده میشوند. شما معمولا نیازی به استفاده از آرگومان اول که شی جیکوری میباشد ندارید.
اکثر کلاسهایی که دارای رویداد هستند دارای متد on میباشد که به شما اجازه شنود بر روی رویدادها را میدهد. برخی ماژولها نیز مانند Navigate رویداد های خود را روی شی window جرقه میزنند که به دلیل سیستم همگانی بودن آنهاست.