مستندات Obsidian از دستورالعمل‌های سبکی که در این صفحه فهرست شده‌اند پیروی می‌کنند. این دستورالعمل‌ها بر اساس بهترین شیوه‌های صنعتی، به‌ویژه [راهنمای سبک مستندات توسعه‌دهندگان گوگل](<https://developers.google.com/style>) و [راهنمای سبک مایکروسافت](https://learn.microsoft.com/en-us/style-guide/) تهیه شده‌اند. برای موارد خاصی که در زیر پوشش داده نشده‌اند، به آن راهنماهای خارجی به عنوان مراجع ثانویه مراجعه کنید. > [!tip]- مشارکت > بیشتر مستندات قبل از این راهنمای سبک وجود داشتند. > > اگر موردی از نقض این راهنمای سبک یافتید، لطفاً [یک گزارش ایجاد کنید](https://github.com/obsidianmd/obsidian-docs/issues/new) و یک Pull Request به [obsidianmd/obsidian-docs](https://github.com/obsidianmd/obsidian-docs) ارسال کنید. ## اصطلاحات و دستور زبان ### سبک زبانی برای مستندات انگلیسی ما، استفاده از [انگلیسی جهانی](https://docs.openedx.org/en/latest/documentors/references/doc_english_writing.html) برای خدمت بهتر به مخاطبان جهانی و کمک به [[#ترجمه‌ها]] توصیه می‌شود. این به معنای: - اجتناب از اصطلاحات عامیانه و عبارات خاص فرهنگی - استفاده از صدای فعال و ساختار جمله مستقیم - ترجیح کلمات ساده و رایج بر اصطلاحات پیچیده - صریح بودن به جای ضمنی بودن - برای قواعد املایی، از انگلیسی آمریکایی استفاده کنید (مثلاً 'organize' نه 'organise'). ### اصطلاحات - «میانبر صفحه‌کلید» را بر «هات‌کی» ترجیح دهید. از هات‌کی زمانی استفاده کنید که به ویژگی خاصی اشاره می‌کنید. - در موبایل «اپلیکیشن Obsidian» و در دسکتاپ «برنامه Obsidian» را ترجیح دهید. - «همگام‌سازی» یا «همگام‌سازی کردن» را بر معادل‌های طولانی‌تر ترجیح دهید. - «عبارت جستجو» را بر «کوئری جستجو» ترجیح دهید. - هنگام اشاره به متنی که بخشی را معرفی می‌کند، «سرفصل» را بر «هدر» ترجیح دهید. - «حداکثر» را بر «ماکس» و «حداقل» را بر «مین» ترجیح دهید. ### نام‌های محصول نام‌های محصولات Obsidian با "Obsidian" شروع می‌شوند، برای مثال "Obsidian Publish" و "Obsidian Sync". اگر یک پاراگراف بیش از حد تکراری شود، می‌توانید در اشاره‌های بعدی از فرم کوتاه استفاده کنید. برای مثال: _برای اجازه دادن به پیکربندی خاص دستگاه، Obsidian Sync تنظیمات خودش را همگام‌سازی نمی‌کند. باید Sync را برای هر یک از دستگاه‌هایتان پیکربندی کنید._ ### رابط کاربری و تعاملات - از **پررنگ** برای نشان دادن متن دکمه‌ها استفاده کنید. - «انتخاب کنید» را بر «ضربه بزنید» یا «کلیک کنید» ترجیح دهید. - برای دستورالعمل‌های خاص موبایل، «ضربه بزنید» هنگام توصیف تعاملات لمسی قابل قبول است زیرا «کلیک» در دسترس نیست. - «نوار کناری» را بر «نوار جانبی» ترجیح دهید. - هنگام اشاره به دستورات یا اقدامات، «اجرا کنید» را بر «فراخوانی کنید» و «اعمال کنید» ترجیح دهید. هنگام اشاره به چندین تعامل رابط کاربری به صورت متوالی، از نماد → (U+2192) استفاده کنید. برای مثال، «**[[تنظیمات]] → افزونه‌های انجمن**». ### یادداشت‌ها، فایل‌ها و پوشه‌ها - هنگام اشاره به یک فایل Markdown در گاوصندوق از «یادداشت» استفاده کنید. - هنگام اشاره به پسوندهای فایل غیر از Markdown از «فایل» استفاده کنید. - «نام یادداشت» را بر «عنوان یادداشت» ترجیح دهید. - «یادداشت فعال» را بر «یادداشت فعلی» ترجیح دهید. - «پوشه» را بر «دایرکتوری» ترجیح دهید. - «نوع فایل» را بر «قالب فایل» ترجیح دهید، مگر اینکه به طور خاص به قالب داده محتوای فایل اشاره شود. هنگام جابجایی بین یادداشت‌ها، اگر مقصد پنهان است از «باز کنید» و اگر هر دو یادداشت مبدأ و مقصد در تقسیم‌بندی‌های جداگانه باز هستند از «سوییچ کنید» استفاده کنید. ### مستندات مرجع برای تنظیمات در صورت امکان، هر تنظیماتی باید در داخل Obsidian با استفاده از متن توصیفی مستند شود. از مستندسازی یک تنظیم خاص در راهنمای Obsidian خودداری کنید مگر اینکه: - نیاز به دانش عمیق‌تری درباره نحوه و زمان استفاده از آن داشته باشد. - معمولاً اشتباه استفاده شود یا درباره آن سؤال شود. - تجربه کاربری را به طور _چشمگیری_ تغییر دهد. اگر می‌خواهید توجه را به تنظیم خاصی جلب کنید، از کال‌اوت نکته استفاده کنید. ### اصطلاحات جهت‌دار هنگام استفاده از اصطلاحات جهت‌دار به عنوان صفت، آن‌ها را با خط تیره بنویسید. هنگامی که جهت به عنوان اسم استفاده می‌شود، از خط تیره اجتناب کنید. **توصیه‌شده:** - **[[تنظیمات]]** را در گوشه پایین-چپ انتخاب کنید. - **[[تنظیمات]]** را در پایین سمت چپ انتخاب کنید. **توصیه‌نشده:** - **[[تنظیمات]]** را در گوشه پایین چپ انتخاب کنید. - **[[تنظیمات]]** را در پایین-چپ انتخاب کنید. «بالا-چپ» و «بالا-راست» را بر «گوشه بالا چپ» و «گوشه بالا راست» ترجیح دهید. هنگام اشاره به تنظیمات، جهت را مشخص نکنید. مکان کنترل تنظیمات بستگی به دستگاه دارد. **توصیه‌شده:** - در کنار **انتخاب گاو صندوق راه دور**، **انتخاب** را بزنید. **توصیه‌نشده:** - در سمت راست **انتخاب گاو صندوق راه دور**، **انتخاب** را بزنید. هنگام توصیف جهت عمودی در عناصر رابط کاربری، برای روابط مکانی از «بالا» و «پایین» استفاده کنید. از «بالاتر» و «پایین‌تر» اجتناب کنید زیرا در زمینه‌های مختلف مبهم هستند. **توصیه‌شده:** - کادر جستجو بالای فهرست فایل‌ها ظاهر می‌شود. - گزینه‌های بیشتر در پایین در دسترس هستند. **توصیه‌نشده:** - کادر جستجو بالاتر از فهرست فایل‌ها قرار دارد. - گزینه‌های بیشتر پایین‌تر هستند. ### دستورالعمل‌ها از حالت امری برای نام راهنماها، سرفصل‌های بخش‌ها و دستورالعمل‌های گام‌به‌گام استفاده کنید. حالت امری مختصر و عمل‌گرا است، که برای کاربرانی که دستورالعمل‌ها را دنبال می‌کنند مستقیم‌تر است. - «راه‌اندازی کنید» را بر «راه‌اندازی» ترجیح دهید - «فایل را جابجا کنید» را بر «جابجایی فایل» ترجیح دهید - «یادداشت‌هایتان را وارد کنید» را بر «واردکردن یادداشت‌ها» ترجیح دهید ### حروف بزرگ جمله‌ای *حروف بزرگ جمله‌ای* را بر *حروف بزرگ عنوانی* برای سرفصل‌ها، دکمه‌ها و عناوین ترجیح دهید. هنگام ارجاع به عناصر رابط کاربری همیشه حروف بزرگ متن موجود در رابط کاربری را مطابقت دهید. **توصیه‌شده:** - نحوه ذخیره‌سازی داده‌ها در Obsidian **توصیه‌نشده:** - نحوه ذخیره‌سازی داده‌ها در اوبسیدین ### نمونه‌ها نمونه‌های واقع‌گرایانه را بر اصطلاحات بی‌معنی ترجیح دهید. **توصیه‌شده:** - `task:(call OR schedule)` **توصیه‌نشده:** - `task:(foo OR bar)` ### نام کلیدها و میانبرهای صفحه‌کلید هنگام اشاره به کلیدها و میانبرهای صفحه‌کلید، از نشانه‌گذاری یکنواخت استفاده کنید. **نام کلیدهای فردی:** هنگام اشاره به یک کاراکتر روی صفحه‌کلید با نام، کاراکتر را بلافاصله بعد از نام بین پرانتز قرار دهید. **توصیه‌شده:** - کلید خط تیره (-) را فشار دهید تا یک خط فاصله اضافه شود. - از علامت سؤال (?) برای جستجو استفاده کنید. **توصیه‌نشده:** - کلید خط تیره را فشار دهید تا یک خط فاصله اضافه شود. - از ? برای جستجو استفاده کنید. - یک `-` قبل از کلمه اضافه کنید. **میانبرهای صفحه‌کلید:** میانبرهای صفحه‌کلید را بدون فاصله در اطراف علامت مثبت قالب‌بندی کنید. وقتی میانبری بین سیستم‌عامل‌ها متفاوت است، هر دو را مشخص کنید. **توصیه‌شده:** - `Ctrl+Z` (ویندوز) یا `Command+Z` (مک) را برای واگرد فشار دهید. - `Escape` را برای بستن این پنجره فشار دهید. - از `Tab` برای جابجایی بین فیلدها استفاده کنید. **توصیه‌نشده:** - `Cmd+Z` را برای واگرد فشار دهید. - `Ctrl + Z` (با فاصله) را برای واگرد فشار دهید. - `Ctrl/Cmd+Z` را برای واگرد فشار دهید. برای میانبرهایی که در همه پلتفرم‌ها یکسان هستند، نیازی به مشخص کردن سیستم‌عامل نیست. اگر مطمئن نیستید که آیا میانبری بین پلتفرم‌ها متفاوت است، برای اطمینان سیستم‌عامل را مشخص کنید. ویندوز و لینوکس معمولاً از میانبرهای یکسانی استفاده می‌کنند. ### Markdown بین بلوک‌های Markdown از خطوط جدید استفاده کنید: **توصیه‌شده:** ```md # سرفصل ۱ این یک بخش است. 1. مورد اول 2. مورد دوم 3. مورد سوم ``` **توصیه‌نشده:** ```md # سرفصل ۱ این یک بخش است. 1. مورد اول 2. مورد دوم 3. مورد سوم ``` **خط فاصله بلند در فهرست‌ها:** از خط فاصله بلند (—) برای جدا کردن اصطلاحات پررنگ از توضیحاتشان در فهرست‌های نشانه‌دار استفاده کنید. از خط فاصله بلند در فهرست‌های تودرتوی ساده با پیوندها استفاده نکنید. **توصیه‌شده:** - **منوی نما** — ایجاد، ویرایش و تغییر نماها. - **محاسبه مقادیر** — افزودن قیمت‌ها، محاسبه مجموع‌ها یا انجام عملیات ریاضی. **توصیه‌نشده:** - [[ساختن یک پایگاه]] — یاد بگیرید چگونه یک پایگاه ایجاد و جاسازی کنید. ### تصاویر از «**عرض** x **ارتفاع** پیکسل» برای توصیف ابعاد تصویر یا صفحه استفاده کنید. **مثال:** ابعاد تصویر پیشنهادی: ۱۹۲۰ x ۱۰۸۰ پیکسل. ## ساختار اطلاعات ### انواع کال‌اوت از کال‌اوت‌ها به صورت هدفمند برای برجسته‌سازی انواع خاصی از اطلاعات استفاده کنید: **نکته** (`[!tip]-`) - توصیه‌های عملی یا بهترین شیوه‌ها که جریان کاری کاربر را بهبود می‌بخشند. برای میانبرها، راه‌حل‌های جایگزین یا اطلاعات مفید اما غیرضروری استفاده کنید. این کال‌اوت‌ها به صورت بسته شروع می‌شوند. **اطلاعات** (`[!info]+`) - زمینه اضافی، اطلاعات پس‌زمینه یا توضیحات. زمانی استفاده کنید که اطلاعات درک را افزایش می‌دهند اما برای تکمیل یک کار ضروری نیستند. این کال‌اوت‌ها به صورت باز شروع می‌شوند. **هشدار** (`[!warning]+`) - احتیاط‌های مهمی که از از دست رفتن داده، خطاها یا عواقب ناخواسته جلوگیری می‌کنند. به صورت محدود برای موقعیت‌های واقعاً خطرناک استفاده کنید. این کال‌اوت‌ها هرگز نباید بسته باشند. **نمونه** (`[!example]-`) - حاشیه‌نویسی‌های عمومی یا جزئیات تکمیلی. برای اطلاعات حاشیه‌ای که ممکن است برخی کاربران مرتبط بدانند استفاده کنید. این کال‌اوت‌ها به صورت بسته شروع می‌شوند. **نمونه‌ها:** ```md > [!tip]- از میانبرهای صفحه‌کلید استفاده کنید > می‌توانید با به خاطر سپردن پرکاربردترین میانبرها، جریان کاری خود را سرعت بخشید. > [!info]+ این یک افزونه پولی است > استفاده از این ویژگی نیاز به اشتراک پولی دارد. > [!warning]+ این عمل قابل بازگشت نیست > حذف گاوصندوق دائمی است. ابتدا صادر کردن یادداشت‌هایتان را در نظر بگیرید. > [!example]- استفاده پیشرفته > همچنین می‌توانید این تنظیم را از طریق منوی نمودار پیکربندی کنید. ``` ### فهرست در مقابل نثر از فهرست‌ها زمانی استفاده کنید که موارد مجزایی را ارائه می‌دهید که روابط ترتیبی یا علّی قوی ندارند. از نثر و پاراگراف‌ها زمانی استفاده کنید که موارد بر یکدیگر بنا می‌شوند، نیاز به توضیح دارند یا از جریان روایی بهره می‌برند. **از فهرست استفاده کنید برای:** - مجموعه‌ای از ویژگی‌های نامرتبط - الزامات نصب - گزینه‌های پیکربندی - مراحل عیب‌یابی **از نثر استفاده کنید برای:** - توضیحات نحوه کارکرد چیزی - جریان‌های کاری با وابستگی - مرورهای مفهومی - راهنمایی‌هایی که نیاز به زمینه دارند ### جداول از جداول برای مقایسه ویژگی‌ها، نسخه‌ها یا نقاط داده مرتبط استفاده کنید، جایی که همترازی به درک کمک می‌کند. از جداول برای فهرست‌های ساده یا داده‌های تک‌ستونی اجتناب کنید. **مورد استفاده مناسب:** | ویژگی | موبایل | دسکتاپ | |---------|--------|---------| | همگام‌سازی | بله | بله | | افزونه‌ها | خیر | بله | | پوسته‌ها | محدود | کامل | ### ارجاعات متقابل از پیوندهای ویکی داخلی (`[[نام یادداشت]]`) به طور گسترده برای کمک به کاربران در پیمایش موضوعات مرتبط استفاده کنید. با این حال، از پیوند بیش از حد اجتناب کنید: - یک اصطلاح یکسان را چندین بار در یک صفحه پیوند ندهید - فقط زمانی پیوند دهید که صفحه ارجاع‌شده زمینه اضافی قابل توجهی فراهم کند - در صورت نیاز از متن پیوند توصیفی استفاده کنید: `[[نام یادداشت#بخش|متن توصیفی]]` **مثال:** اشاره اول: «درباره [[معرفی Obsidian Sync|Obsidian Sync]] بیاموزید تا گاوصندوق خود را در دستگاه‌ها به‌روز نگه دارید.» اشاره بعدی: «می‌توانید Sync را برای هر دستگاه به طور جداگانه پیکربندی کنید.» ### محتوای خاص پلتفرم هنگام مستندسازی ویژگی‌هایی که بین پلتفرم‌ها متفاوت هستند، از سرفصل‌های بخش برای سازماندهی محتوا استفاده کنید. از `دسکتاپ` و `موبایل` به عنوان سرفصل‌های فرعی برای جداسازی دستورالعمل‌ها یا ویژگی‌های خاص پلتفرم استفاده کنید. **توصیه‌شده:** ```md ## سفارشی‌سازی نوار ابزار ### دسکتاپ در نسخه دسکتاپ، می‌توانید نوار ابزار را به صورت زیر سفارشی کنید: - ترتیب اقدامات نوار ابزار را با کشیدن و رها کردن آیکون‌ها تغییر دهید. - برای پنهان کردن اقدامات خاص، روی فضای خالی کلیک راست کنید و اقداماتی را که می‌خواهید پنهان کنید غیرفعال کنید. ### موبایل در نسخه موبایل، می‌توانید نوار ابزار را از طریق تنظیمات سفارشی کنید: 1. **[[تنظیمات]]** را باز کنید. 2. به **ظاهر** بروید. 3. در بخش **پیکربندی روبان**، **مدیریت** را انتخاب کنید. ``` > [!info]+ چه زمانی بخش‌های جداگانه ایجاد کنیم؟ > فقط در صورتی بخش‌های جداگانه ایجاد کنید که محتوا به طور قابل توجهی متفاوت باشد. اگر دستورالعمل‌ها تا حد زیادی یکسان هستند با تفاوت‌های جزئی، به جای آن از یادداشت‌های درون‌خطی استفاده کنید. ## آیکون‌ها و تصاویر آیکون‌ها و تصاویر را زمانی استفاده کنید که توضیح مواردی را که با کلمات سخت توصیف می‌شوند آسان‌تر می‌کنند، یا زمانی که نیاز دارید بخش‌های مهم اپلیکیشن Obsidian را نشان دهید. می‌توانید تصاویر را در پوشه `Attachments` ذخیره کنید. - تصویر باید درک متنی را که همراهی می‌کند آسان‌تر کند. **مثال**: پس از فعال‌سازی، افزونه [[واژه‌شمار]] یک ورودی جدید در نوار وضعیت پایین شما ایجاد خواهد کرد. ![[Style-guide-zoomed-example.png#interface|300]] - تصاویر باید در قالب `.png` یا `.svg` باشند. - اگر تصویری در یادداشت خیلی بزرگ به نظر می‌رسد، آن را خارج از Obsidian کوچک‌تر کنید، یا ابعاد آن را همان‌طور که در [[جاسازی فایل‌ها#جاسازی تصویر در یادداشت|جاسازی تصویر در یادداشت]] توضیح داده شده تنظیم کنید. - در موارد نادر، ممکن است بخواهید تصاویر خصوصاً بزرگ یا پیچیده را در یک [[فراخوان‌ها#کال‌اوت‌های تاشو|کال‌اوت تاشو]] قرار دهید. - برای پنجره‌های بازشو یا مودال‌ها، تصویر باید کل پنجره اپلیکیشن Obsidian را نشان دهد. ![[Style-guide-modal-example.png#interface]] ### آیکون‌ها آیکون‌های [Lucide](https://lucide.dev/icons/) و آیکون‌های سفارشی Obsidian می‌توانند در کنار عناصر جزئی برای ارائه نمایش بصری یک ویژگی استفاده شوند. **مثال:** در نوار ابزار سمت چپ، **ساختن بوم نو** ![[lucide-layout-dashboard.svg#icon]] را انتخاب کنید تا یک canvas در همان پوشه فایل فعال ایجاد شود. **دستورالعمل‌ها برای آیکون‌ها** - آیکون‌ها را در پوشه `Attachments/icons` ذخیره کنید. - پیشوند `lucide-` را قبل از نام آیکون Lucide اضافه کنید. - پیشوند `obsidian-icon-` را قبل از نام آیکون Obsidian اضافه کنید. **مثال:** آیکون ایجاد یک canvas جدید باید `lucide-layout-dashboard` نام‌گذاری شود. - از نسخه SVG آیکون‌های موجود استفاده کنید. - آیکون‌ها باید `18` پیکسل عرض، `18` پیکسل ارتفاع و ضخامت خط `1.5` داشته باشند. می‌توانید این تنظیمات را در داده SVG تنظیم کنید. > [!info]- تنظیم اندازه و ضخامت خط در SVG > ```html > <svg xmlns="http://www.w3.org/2000/svg" width="WIDTH" height="HEIGHT" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="STROKE-WIDTH" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-layout-dashboard"><rect width="7" height="9" x="3" y="3" rx="1"/><rect width="7" height="5" x="14" y="3" rx="1"/><rect width="7" height="9" x="14" y="12" rx="1"/><rect width="7" height="5" x="3" y="16" rx="1"/></svg> >``` - از لنگر `icon` در تصاویر جاسازی‌شده استفاده کنید تا فاصله‌بندی اطراف آیکون تنظیم شود و با متن مجاور به خوبی هم‌تراز شود. - آیکون‌ها باید بین پرانتز قرار گیرند. ![[lucide-cog.svg#icon]] **مثال**: `![[lucide-cog.svg#icon]]` ### تگ‌های لنگر تصویر تگ‌های لنگر تصویر برای افزودن تغییرات تزئینی به تصاویر جاسازی‌شده در دسترس هستند. > [!warning] هشدار پیش‌نمایش زنده > تگ‌های لنگر آیکون در **پیش‌نمایش زنده** به درستی نمایش داده نخواهند شد. از **نمای خواندن** استفاده کنید تا تأیید کنید تگ لنگر اعمال شده است. **آیکون** `![[lucide-menu.svg#icon]]` تگ لنگر آیکون هم‌ترازی عمودی صحیح را برای آیکون‌هایی که برای نشان دادن عناصر رابط کاربری استفاده می‌شوند تضمین می‌کند. آیکون منوی اول از تگ لنگر استفاده می‌کند ![[lucide-menu.svg#icon]]، در حالی که آیکون منوی دوم ( ![[lucide-menu.svg]] ) استفاده نمی‌کند. **رابط کاربری** `![[Vault picker.png#interface]]` تگ لنگر رابط کاربری یک سایه جعبه تزئینی در اطراف تصویر اضافه می‌کند. در تصویر اول، تگ لنگر رابط کاربری اعمال شده است. ![[Vault picker.png#interface]] در مقابل، تصویر دوم تگ لنگر رابط کاربری اعمال نشده است. ![[Vault picker.png]] **حاشیه** `![[Backlinks.png#outline]]` تگ لنگر حاشیه یک حاشیه ظریف در اطراف تصویر اضافه می‌کند. در تصویر اول، تگ لنگر حاشیه اعمال شده است. > [!tip] گوشه پایین چپ تصویر را مشاهده کنید تا تفاوت را ببینید. ![[Backlinks.png#outline]] تصویر دوم تگ لنگر حاشیه ندارد. ![[Backlinks.png]] ### بهینه‌سازی تصاویر زمان بارگذاری صفحه را کند می‌کنند و فضای ذخیره‌سازی ارزشمند [[مقدمه‌ای بر Obsidian Publish|Publish]] را اشغال می‌کنند. بهینه‌سازی تصاویر امکان کاهش حجم فایل را فراهم می‌کند، اما یکپارچگی بصری تصویر حفظ می‌شود. هم تصاویر و هم آیکون‌ها باید بهینه‌سازی شوند. > [!info] ابزارهای بهینه‌سازی تصاویر > در اینجا برخی برنامه‌های پیشنهادی برای کاهش حجم تصاویر آورده شده است. > - **ویندوز:** [FileOptimizer](https://sourceforge.net/projects/nikkhokkho/) > - **مک:** [ImageOptim](https://imageoptim.com/) > - **لینوکس/یونیکس** [Trimage](https://trimage.org) > > نرخ بهینه‌سازی ۶۵-۷۵٪ را پیشنهاد می‌کنیم. ## چیدمان ### پیوندهای شکسته قبل از ارسال Pull Request خود، لطفاً پیوندهای شکسته در مستندات ترجمه‌ای که روی آن کار می‌کنید را بررسی و اصلاح کنید. پیوندهای شکسته ممکن است به طور طبیعی در طول زمان ایجاد شوند، بنابراین تأیید صحت آن‌ها به حفظ کیفیت مستندات کمک می‌کند. می‌توانید پیوندهای شکسته را با استفاده از [[افزونه‌های انجمن]] یا ابزارهای موجود در IDE خود بررسی کنید. ### توضیحات این مستندات در گیت‌هاب ویرایش و از طریق [[مقدمه‌ای بر Obsidian Publish|Obsidian Publish]] به صورت آنلاین منتشر می‌شوند، که شامل [[پیش‌نمایش پیوند در شبکه‌های اجتماعی#Description|توضیحات]] برای کارت‌های شبکه‌های اجتماعی و سایر عناصر [[سئو]] می‌شود. اگر صفحه‌ای که روی آن کار می‌کنید [[ویژگی‌ها|ویژگی]] `description` ندارد، لطفاً یکی اضافه کنید. توضیحات باید ۱۵۰ کاراکتر یا کمتر باشد و خلاصه‌ای عینی از محتوای صفحه ارائه دهد. **خوب**: یاد بگیرید قالب‌هایی بسازید که فراداده صفحات وب را به طور خودکار با Web Clipper ثبت و سازماندهی کنند. **قابل بهبود**: یاد بگیرید چگونه قالب‌هایی ایجاد کنید که به طور خودکار فراداده صفحات وب را با Web Clipper ثبت و سازماندهی کنند. ### جهت‌ها هنگام نوشتن یا بازنویسی [[#دستورالعمل‌ها]] درباره نحوه انجام یک عمل در اپلیکیشن، حتماً مراحل را برای هر دو نسخه موبایل و دسکتاپ شامل کنید. اگر به دستگاه موبایل یا دسکتاپ دسترسی ندارید، لطفاً هنگام ارسال Pull Request خود این موضوع را ذکر کنید. ## ترجمه‌ها هنگام تکمیل یک ترجمه، تمام محتوا را ترجمه کنید. این شامل موارد زیر و نه محدود به آن‌ها می‌شود: - نام یادداشت‌ها - نام پوشه‌ها - نام‌های مستعار - نام پیوست‌ها - متن جایگزین پیوند