چگونه Pinecoders توضیحات اسکریپت را می نویسند و قالب بندی می کنند

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

برای رسیدن به این هدف ، ما:

• با کاهش ارتباط با درک فیلمنامه ما ، محتوا را به صورت عمودی سفارش دهید.
• هدف از دستیابی به حداکثر خوانایی حداکثر ضمن استفاده از حداقل ویژگی های گرافیکی/تایپوگرافی.
• جمله اول یا دو مورد اضافی را با دقت بنویسید ، زیرا آنها در ویجت اسکریپت قابل مشاهده خواهند بود ، که کاربران قبل از باز کردن صفحه اسکریپت ما خواهند دید. ما می خواهیم این جمله اول یا دو به طور مناسب فیلمنامه خود را خلاصه کنیم.

ما روش خود را برای توضیحات ساختمان به اشتراک می گذاریم تا در صورت مفید بودن آن ، بتوانید آن را اتخاذ کنید ، یا از آن به عنوان الهام بخش برای طراحی خود استفاده کنید.

توجه داشته باشید که این توصیه ها برای ارائه صفحات اسکریپت روی دسک تاپ بهینه شده است. سایر دستگاه ها ممکن است صفحات اسکریپت را به روشی که این توصیه ها برای آن بهینه نشده اند ، ارائه دهند.

بلوک های ساختمانی ما

نشان

نشانه زیر در توضیحات اسکریپت موجود است. شما می توانید به همه این برچسب ها به جز برچسب های بلوک کد کاج از لیست نمادها در بالای پنجره "انتشار اسکریپت" یا "ویرایش اسکریپت" دسترسی پیدا کنید:

جسورانه و ایتالیایی

این متن [i] italics [/i] ، [b] bold [/b] و [b] [i] italics پررنگ [/i] [/b] را تولید می کند. 

و به این شکل خواهد بود:

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

نشانی اینترنتی

دو نوع URL را می توان درج کرد. URL های عمومی مانند:

حساب Pinecoders [url = https: //www. tradingview. com/u/pinecoders/#published-scripts] صفحه اسکریپت [/url]. 

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

[url = https: //www. tradingview. com/script/n0f50jkv-relative-volume-attime/] حجم نسبی در زمان [/url] 

پیوند پس از "نسبی" شکسته می شود. راه حل برای چنین مواردی جایگزین کردن فضاها به نام با فضاهای دو شکل Unicode است:

[url = https: //www. tradingview. com/script/n0f50jkv-relative-volume-attime/] حجم نسبی در زمان [/url] 

هنگامی که می خواهید به یک انتشار TradingView مانند اسکریپت یا ایده پیوند دهید و پیش نمایش نمودار انتشار را درج کنید ، می توانید از نوع دیگری از پیوند URL استفاده کنید:

پیوند به یک انتشارات اسکریپت: [نمودار] https://www. tradingview. com/script/wvcqygsx-mtf-oscillator-framework-pinecoders/ [/نمودار] 

توجه داشته باشید که این نوع برچسب URL به شدت مورد نیاز نیست. پیوندهای خام به انتشارات تلویزیون یا عکس های فوری به همان روش تفسیر می شود ، به طوری که:

پیوند به یک انتشارات اسکریپت: https://www. tradingview. com/script/wvcqygsx-mtf-oscillator-framework-pinecoders/ 

همان خروجی را به دست می آورد.

نماد

می توانید به نمادی پیوند دهید که خوانندگان ممکن است روی آن کلیک کنند تا یک نمودار عمومی تهیه کنند:

پیوند به یک نماد: `[نماد =" nasdaq: aapl "] nasdaq: aapl [/symbol]` 

به این شکل خواهد بود:

بلوک های کد کاج

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

کد کاج: [کاج] //@نسخه = 4 مطالعه ("") طرح (نزدیک) [/کاج] 

• هیچ معادل خطی برای برچسب monospace وجود ندارد. ما برای بسته بندی کلمات کلیدی کاج یا بخش های کاج کوتاه از backticks استفاده می کنیم. آنها توسط تجزیه کننده تفسیر نمی شوند اما سرنخ بصری را برای تأثیرگذاری متن محصور شده کد ارائه می دهند:

   

 این جمله به متغیر داخلی `bar_index` اشاره دارد. 

لیست های گلوله ای

لیست ها مانند این برچسب خورده اند:

لیست: [لیست] [*] مورد 1 [*] مورد 2 [/لیست] 

و شبیه این است:

ما دوست نداریم اندازه کوچکتر مورد استفاده برای موارد لیست باشد و ترجیح می دهیم لیست های خودمان را بسازیم ، همانطور که در توضیحات مثال خود توضیح می دهیم.

شخصیت های خاص

ما برای ساختن توضیحات خود از چند شخصیت مختلف یونیکد استفاده می کنیم:

• EM Space ، U+2003 ()
• فضای عرض صفر ، U+200B ()
• بلوک کامل ، U+2588 (█)
• گلوله ، U+2022 (•)
• Em Dash ، U+2014 ( -)

توضیحات ، قدم به قدم

اکنون یک مرحله به مرحله توضیحات مثال خواهیم ساخت. ما با بخش "نمای کلی" خود شروع می کنیم:

█ [b] نمای کلی [/b] ما توضیحات خود را با یک بخش "مرور کلی" شروع می کنیم ، با توجه به اینکه این جملات اول در ویجت [i] [/i] اسکریپت منتشر شده ظاهر می شوند. ویجت [i] [/i] تصویر کوچک کوچک است که اسکریپت شما را در جریان اسکریپت ها یا در برگه "اسکریپت" مشخصات کاربر شما نشان می دهد. وقتی کاربران روی ویجت [i] [/i] روی اسکریپت کلیک می کنند ، آنها صفحه [i] [/i] اسکریپت شما را باز می کنند. 

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

و مانند این در ویجت اسکریپت شما:

• ما عناوین بخش را با یک بلوک کامل و یک فضای EM پیشوند: (█).
• ما از تمام کلاه ها برای عنوان و ویژگی جسورانه استفاده می کنیم.
• ما عناوین بخش را با یک خط خالی دنبال می کنیم.
• ما بخش ها را با دو خط خالی پایان می دهیم تا جدایی بصری بین بخش ها فراهم شود. این مستلزم این است که ما هرگز از دو خط خالی در بخش استفاده نمی کنیم.

این بقیه توضیحات مثال ما است:

█ [B] مفاهیم [/b] علاوه بر پاراگراف های ساده متن بدن مانند این ، بخش ها می توانند حاوی باشند: [b] لیست های شماره [/b] ما یک خط خالی را قبل از این زیر بخش قرار دادیم و از نوع جسورانه برای هدر آن استفاده کردیم. لیست های شماره گذاری شده برای دستورالعمل های تقسیم شده به مراحل ، یا برای لیست های معرفی شده با مشخص کردن تعداد محدود عناصر ، به خوبی کار می کنند. این لیست شماره گذاری شده شامل سه مورد است: 1 - ما از یک شماره + فضای + em dash + فضای برای پیشوند موارد استفاده می کنیم. همانطور که برای لیست های گلوله ای انجام می دهیم ، عناصر طولانی را به صورت دستی در خطوط فردی کوتاه تر از عرض صفحه اسکریپت می شکنیم تا بتوانیم مورد را به درستی تورفتگی کنیم. در غیر این صورت به نظر می رسد مانند این ، که بی فایده است و خواندن لیست را دشوارتر می کند. 2 - این یک عنصر به درستی شکسته است. ما سعی می کنیم موارد را بعد از یک جمله یا کاما بشکنیم. اگر این امکان پذیر نباشد ، ما جملاتی را می شکنیم که مکث کمترین بر خوانایی تأثیر می گذارد. برای تعیین اینکه کدام خط نیاز به استراحت دستی دارد ، اغلب نیاز به پیش نمایش متن یک عنصر دارید ، زیرا پنجره ویرایش ممکن است از هر عرض برخوردار باشد. ما خطوط زیر را با دو فضای EM پیشوند پیشوند داریم تا آنها به درستی تراز شوند ، همانطور که با این خط انجام می شود ، موارد قبلی و موارد زیر. این امر خواندن موارد بعدی را آسان تر می کند. سعی کنید آخرین خط از عناصر چند خط را کوتاهترین کنید. 3 - خواندن این عنصر آسان تر است زیرا خطوط قبلی در آن قرار دارند.[b] لیست های گلوله ای [/b] لیست های گلوله ای به همان روش لیست های شماره گذاری شده کار می کنند ، به جز این که: • آنها با فضای EM + گلوله + فضای پیشوند می شوند.• هنگامی که یک مورد به خطوط خود نیاز دارد به صورت دستی شکسته شود ، ما خطوط را بعد از اولین مورد با دو فضای EM تورفتگی می کنیم. خط دوم معرفی یک لیست گلوله ای با ضخامت: • خط اول لیست گلوله دوم که با سه فضای EM پیشوند است. این مورد اول خیلی طولانی است و به شکستن خط دستی نیاز دارد. ما این خط دوم را با چهار فضای EM پیشوند می کنیم.• مورد دوم.• آخرین مورد از لیست گلوله های ما.[b] زیر بخش های حاوی یک یا چند پاراگراف [/b] در vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti corrupti quos quos dolores quas molestias faleuri sint sint cupeacati cupidate non providate ، similique in similique ، similique in similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique ، similique in similique. DeSerunt Mollitia animi ، id est laborum et dolorum fuga. et harum quidem rerum facilis est et expedita مجزا. nam libero tempore ، cum soluta nobis est eligendi optio cumque nihil quo minus id quod maxime placeat facere putimus ، omnis voluptas assumenda est ، omnis dolor repellendus. 

اما بعضی اوقات ، یا خدمات ناشی از آن یا نیازها اغلب رد می شوند و ناراحتی پذیرفته نمی شود. بنابراین این چیزها با انتخاب عاقلانه مانند یا رد لذت های دیگری به عواقب یا درد ماندگار PWNED برگزار می شود.█ [B] بخش های دیگر [/ b] اینها برخی از انواع دیگر بخش هایی هستند که در صورت لزوم از آنها استفاده می کنیم. عناوین بخش را کوتاه نگه دارید • ویژگی ها: برای توصیف ویژگی های دقیق اسکریپت ، که معمولاً به همان ترتیب مرتب شده است ، آنها را در ورودی های اسکریپت پیدا می کند.• نحوه استفاده از • محدودیت ها: در جایی که ما به هرگونه کاستی در اسکریپت خود اشاره می کنیم ، مانند این که با استفاده از جبران خسارات به گذشته ، یا در انواع خاصی از نمودارها کار نمی کند ، یا به عنوان مثال در شرایط خاص بازار قابل اطمینان است.• RAMBS: جایی که ما در مورد نقاط دیدگاه یا فرضیه ها بحث می کنیم.• یادداشت ها • با تشکر: در جایی که ما نویسندگانی را که کد یا الهام بخش برای کار ما را ارائه داده اند ، اعتبار می دهیم. ما اغلب با استفاده از لینک لینک به صفحه اسکریپت های آنها ، نویسندگان را ذکر خواهیم کرد ، همانطور که وقتی از ماسترو تشکر می کنیم ، [url = http: //www. tradingview. com/u/ricardosantos/#published-scripts] Richardosantos [/url].══════════════════════════════════════════════════ ══════════════════════════════════════════════════ ══════════════════════════════════════════════════ ══════════════════════════════════════════════════ ════════════════════ شخصیت ، U + 2550 (═) ، که بدون شکاف در Trebuchet Font Tradeview استفاده می کند.

این همان چیزی است که پس از انتشار آن تولید می شود (همچنین می توانید توضیحات کامل ارائه شده در ایده همراه با منتشر شده در TradingView را مشاهده کنید):

نکات

توضیحاتی بنویسید که به خوبی پیر می شود

از آنجا که توضیحات اسکریپت اصلی را می توان پس از مدت زمان اولیه 15 دقیقه اصلاح کرد ، از جزئیات غیر مهم که ممکن است در آینده تغییر کند ، خودداری کنید. به عنوان مثال ، هنگامی که این امر قابلیت استفاده از اسکریپت شما را به خطر نمی اندازد ، می توانید لیستی از موارد منوی کشویی (مانند لیستی از رنگ ها) را پرش کنید و فقط توضیح دهید که آن قسمت ورودی چه کاری انجام می دهد. دوره های پیش فرض غیر بحرانی یا طول بازپرداخت مورد استفاده در ورودی ها نمونه دیگری از اطلاعات است که ممکن است با تکامل اسکریپت شما تغییر کند و ممکن است خوشحال شوید که هنگام تغییر در توضیحات اصلی خود ذکر نکرده اید.

نمودارها یا شاخص های دیگر

هنگامی که پیوندهایی را که به عنوان یک تصویر ارائه می شود ، ابتدا تصویر را معرفی کنید تا از رنگ آبی ظاهر نشود. خواننده خود را برای تصویری که قرار است مشاهده کنید آماده کنید ، تصویر را نشان دهید ، سپس محتوای آن را شرح دهید.

برای حذف پیوندهای تولید شده به صورت خودکار در برخی از کلمات

نشانه پیش فرض TradingView پیوندهایی را برای کلماتی مانند "یک" ، "حجم" ، نام شرکت و غیره ایجاد می کند. چنین کلماتی با یک خط نقطه ای در زیر آنها و یک فضای اضافی پس از کلمه ظاهر می شوند. برای از بین بردن این پیوندها ، می توانید پس از آخرین شخصیت آنها ، فضای یونیکد با عرض صفر نامرئی (U+200B ()) را اضافه کنید.

اپراتور مرجع تاریخچه کاج از متن نه در بلوک های کد جدا می شود

توجه داشته باشید که اگر در برچسب های بلوک کد کاج قرار نگیرند ، مراجعه به مقادیر گذشته متغیرها توسط تجزیه کننده از بین می رود. این هم برای توضیحات و هم برای نظرات صادق است ، اما نه برای پیام های چت که در آن خوب کار می کنند. این متن در توضیحات یا در نظرات تایپ شده است: 

من از `bar_index [1]` استفاده می کنم.[کاج] من از `bar_index [1]`. [/pine] استفاده می کنم

توضیحات چند زبانه

هنگام نوشتن توضیحات چند زبانه ، قوانین خانه مستلزم این است که شما با انگلیسی شروع کنید. برای نشان دادن به خوانندگان محلی دیگر که زبان دیگری در دسترس است ، این کار خوب است که در اولین خط توضیحات خود به این موضوع اشاره کنید. اگر توضیحات فرانسوی بعد از اولین مورد به زبان انگلیسی در دسترس بود ، می توانید از آن استفاده کنید: 

[توضیحات une en français کت و شلوار l'anglais.] █ [b] نمای کلی [/b]

که می گوید "توضیحات فرانسوی از انگلیسی پیروی می کند."

برچسب ها در نظرات و گپ ها

توجه داشته باشید که تنها برچسب های تفسیر شده در نظرات ارسال شده در نشریات TradingView و پیام های گپ ، پیوندهایی به انتشارات تلویزیون و عکس های نمودار و برچسب های بلوک کد کاج است. همانطور که در توضیحات ، پیوندها به انتشارات تلویزیون و عکس های فوری نیازی به استفاده از [نمودار] ندارند.[/نمودار] برچسب ها ؛شما به سادگی می توانید پیوند را در نظر بچسبانید ، که به عنوان یک تصویر ارائه می شود.

قالب ها را نگه دارید

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

ماکروهای اتوکی

ما از این ماکروهای Autohotkey برای کمک به ما در برچسب ها استفاده می کنیم: