diff options
| author | Ryan Johnson <rjohnson@mozilla.com> | 2021-04-29 16:16:42 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-29 16:16:42 -0700 |
| commit | 95aca4b4d8fa62815d4bd412fff1a364f842814a (patch) | |
| tree | 5e57661720fe9058d5c7db637e764800b50f9060 /files/uk/mdn | |
| parent | ee3b1c87e3c8e72ca130943eed260ad642246581 (diff) | |
| download | translated-content-95aca4b4d8fa62815d4bd412fff1a364f842814a.tar.gz translated-content-95aca4b4d8fa62815d4bd412fff1a364f842814a.tar.bz2 translated-content-95aca4b4d8fa62815d4bd412fff1a364f842814a.zip | |
remove retired locales (#699)
Diffstat (limited to 'files/uk/mdn')
| -rw-r--r-- | files/uk/mdn/about/index.html | 116 | ||||
| -rw-r--r-- | files/uk/mdn/contribute/getting_started/index.html | 107 | ||||
| -rw-r--r-- | files/uk/mdn/contribute/howto/create_and_edit_pages/index.html | 181 | ||||
| -rw-r--r-- | files/uk/mdn/contribute/howto/index.html | 13 | ||||
| -rw-r--r-- | files/uk/mdn/contribute/index.html | 18 | ||||
| -rw-r--r-- | files/uk/mdn/guidelines/index.html | 13 | ||||
| -rw-r--r-- | files/uk/mdn/guidelines/writing_style_guide/index.html | 727 | ||||
| -rw-r--r-- | files/uk/mdn/index.html | 28 | ||||
| -rw-r--r-- | files/uk/mdn/structures/index.html | 14 | ||||
| -rw-r--r-- | files/uk/mdn/structures/macros/commonly-used_macros/index.html | 218 | ||||
| -rw-r--r-- | files/uk/mdn/structures/macros/index.html | 47 | ||||
| -rw-r--r-- | files/uk/mdn/tools/index.html | 17 | ||||
| -rw-r--r-- | files/uk/mdn/tools/kumascript/index.html | 500 | ||||
| -rw-r--r-- | files/uk/mdn/tools/kumascript/troubleshooting/index.html | 62 | ||||
| -rw-r--r-- | files/uk/mdn/yari/index.html | 26 |
15 files changed, 0 insertions, 2087 deletions
diff --git a/files/uk/mdn/about/index.html b/files/uk/mdn/about/index.html deleted file mode 100644 index 687b08f8cb..0000000000 --- a/files/uk/mdn/about/index.html +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Про MDN -slug: MDN/About -tags: - - MDN Meta - - Путівник - - Спільнота -translation_of: MDN/About -original_slug: MDN/Про ---- -<div>{{MDNSidebar}}</div> - -<div><font><font>{{IncludeSubNav ("/uk/docs/MDN")}}</font></font></div> - -<p><font><font>MDN Web Docs — це постійно оновлюваний навчальний майданчик з веб-технологій та програмного забезпечення, яке живить {{Glossary("Тенета", "всесвітнє павутиння")}}, зокрема:</font></font></p> - -<ul> - <li><font><font>Веб-стандарти, як-от </font></font><a href="/uk/docs/Web/CSS" title="/ en-US / docs / CSS"><font><font>CSS</font></font></a><font><font>, </font></font><a href="/uk/docs/Web/HTML" title="/ en-US / docs / HTML"><font><font>HTML</font></font></a><font><font> та </font></font><a href="/uk/docs/Web/JavaScript" title="/ en-us / docs / JavaScript"><font><font>JavaScript</font></font></a></li> - <li><a href="/uk/docs/Web/Застосунки" title="/ en-US / docs / Apps"><font><font>Розробка web-застосунків</font></font></a></li> - <li><font><font><a href="/uk/Add-ons" title="/ en-us / docs / add-ons">Розробка додатків Firefox</a></font></font></li> -</ul> - -<h2 id="Наша_мета"><font><font>Наша мета</font></font></h2> - -<p><font><font>Мета MDN дуже проста: надати розробникам всі необхідні відомості для створення проектів у всесвітній </font></font><font><font>мережі. Якщо є відкрита технологія, доступна для <a href="/uk/docs/Web">тенет</a>, ми маємо її задокументувати</font></font><font><font>.</font></font></p> - -<p><font><font>Ми також надаємо документацію продуктів Mozilla і відомості те, як</font></font><a href="/uk/docs/Mozilla"><font><font> складати проекти Mozilla та брати участь у їх розробці.</font></font></a></p> - -<p><font><font>Якщо ви не впевнені, чи слід висвітлювати на MDN якусь тему, прочитайте: </font></font><a href="/uk/docs/MDN/Contribute/Guidelines/Does_this_belong_on_MDN"><font><font>чи належить це MDN?</font></font></a></p> - -<h2 id="Як_можна_допомогти"><font><font>Як можна допомогти?</font></font></h2> - -<p><font><font>Допомога MDN не конче потребує фахових навичок з написання коду чи письменницького хисту! Існує чимало різних способів допомоги: від загальної пере́вірки статей на змістовність та легкочитність до набору тексту та додавання зразків коду. Насправді, шляхів допомоги так багато, що ми цьому присвятили окрему сторінку «</font></font><a href="/uk/docs/MDN/з_чого_почати"><font><font>Початок роботи</font></font></a><font><font>», яка допоможе вам обрати завдання залежно від того, що вам цікаво та скільки часу ви готові приділити цій справі.</font></font></p> - -<p><font><font>Ви також можете допомогти </font><font><a href="/uk/docs/MDN/About/Promote">розповівши про MDN</a> у власному блозі чи веб-сайті.</font></font></p> - -<h2 id="Спільнота_MDN"><font><font>Спільнота MDN</font></font></h2> - -<p><font><font>Наша спільнота є всесвітньою! До неї належать люди з усього світу, носії низки різних мов. Якщо ви хочете дізнатись про нас більше, чи вам потрібна якась допомога з MDN, не соромтеся звернутись до </font></font><a href="https://discourse.mozilla-community.org/c/mdn"><font><font>нашого форуму</font></font></a><font><font> або </font></font><a href="irc://irc.mozilla.org#mdn"><font><font>каналу IRC</font></font></a><font><font>! Крім того, ми маємо обліковий запис <a href="http://twitter.com/MozDevNet">@MozDevNet</a> у Twitter. Там можна стежити за нашою діяльністю </font></font><font><font>або навіть </font><font>надсилати нам повідомлення, якщо раптом щось не так, або ви хочете лишити відгук (чи то пак щиру подяку) нашим учасникам та укладачам!</font></font></p> - -<h2 id="Використання_вмісту_MDN"><font><font>Використання вмісту MDN</font></font></h2> - -<p><font><font>Вміст MDN є безкоштовним та поширюється на умовах ліцензії відкритого доступу.</font></font></p> - -<h3 id="Авторські_права_та_ліцензії"><font><font>Авторські права та ліцензії</font></font></h3> - -<p><font><font>Вміст MDN повністю доступний під різними ліцензіями відкритого доступу. </font><font>Цей розділ охоплює різновиди вмісту, який ми надаємо, та ліцензії, що на нього поширюються.</font></font></p> - -<h4 id="Документація_та_статті"><font><font>Документація та статті</font></font></h4> - -<p><font><font><strong>Вікі-документи MDN</strong> було укладено за участю багатьох авторів, як у межах Mozilla Foundation, так і поза ними. Якщо не зазначено інше, вміст доступний на умовах </font></font><a class="external text" href="http://creativecommons.org/licenses/by-sa/2.5/" rel="nofollow" title="http://creativecommons.org/licenses/by-sa/2.5/"><font><font>ліцензії Creative Commons Attribution-ShareAlike</font></font></a><font><font> (CC-BY-SA), v2.5 або будь-якої пізнішої версії. </font><font>Будь ласка, наводьте «Mozilla Contributors» та посилання (якщо в мережі) або URL (якщо для друку) на відповідну вікі-сторінку, яку мали за джерело. </font><font>Наприклад, передруковуючи цю статтю, можна написати таке:</font></font></p> - -<blockquote><a href="https://developer.mozilla.org/uk/docs/MDN/Про"><font><font>Про MDN</font></font></a><font><font> від </font></font><a href="https://developer.mozilla.org/uk/docs/MDN/Про$history"><font><font>Mozilla Contributors</font></font></a><font><font> ліцензовано під </font></font><a href="http://creativecommons.org/licenses/by-sa/2.5/"><font><font>CC-BY-SA 2.5</font></font></a><font><font>.</font></font></blockquote> - -<p><font><font>Зверніть увагу, що в наведеному прикладі «Mozilla Contributors» є посиланням на історію цитованої сторінки. Докладніше д</font><font>ив. у статті </font></font><a href="http://wiki.creativecommons.org/Marking/Users"><font><font>Поради щодо ліцензійних позначок</font></font></a><font><font>.</font></font></p> - -<div class="note"> -<p><font><font>Див. </font></font><a href="/en-US/docs/MDN_content_on_WebPlatform.org" title="/en-US/docs/MDN_content_on_WebPlatform.org"><font><font>вміст MDN на WebPlatform.org</font></font></a><font><font> для отримання відомостей про передрук та ліцензійні позначки статей MDN на сторінках <a href="http://webplatform.org">webplatform.org</a>.</font></font></p> -</div> - -<h4 id="Приклади_й_уривки_коду"><font><font>Приклади й уривки коду</font></font></h4> - -<p><font><font>Зразки коду, додані 20 серпня 2010 року чи пізніше, перебувають у </font></font><a class="external" href="http://creativecommons.org/publicdomain/zero/1.0/" title="http://wiki.creativecommons.org/Public_domain"><font><font>відкритому доступі</font></font></a><font><font> (</font></font><a href="https://creativecommons.org/publicdomain/zero/1.0/"><font><font>CC0</font></font></a><font><font>). Загалом згадка про л</font><font>іцензію не потрібна, та якщо ви хочете, можете зазначити таке: "Всі авторські права передаються у суспільне надбання. http://creativecommons.org/publicdomain/zero/1.0/".</font></font></p> - -<p><font><font>На зразки коду, додані раніше 20 серпня 2010 року, поширюються умови </font></font><a class="external" href="http://www.opensource.org/licenses/mit-license.php" title="http://www.opensource.org/licenses/mit-license.php"><font><font>ліцензії MIT</font></font></a><font><font>; ви маєте лише доповнити шаблон ліцензації MIT таким рядком: "© <дата останньої версії вікі-сторінки> <ім'я особи, що додала її до вікі>".</font></font></p> - -<h4 id="Внесок"><font><font>Внесок</font></font></h4> - -<p><font><font>Якщо ви хочете взяти участь в укладанні документації, вам доведеться погодитись на поширення вашого внеску на умовах ліцензії Attribution-ShareAlike (або іншої ліцензії, що може бути зазначена на сторінці, яку ви редагуєте) та зразків коду на умовах </font></font><a href="http://creativecommons.org/publicdomain/zero/1.0/" title="http://creativecommons.org/publicdomain/zero/1.0/"><font><font>Creative Commons CC-0</font></font></a><font><font> (суспільне надбання). Будь-який внесок у документацію MDN означає вашу згоду на поширення власного доробку на умовах цих ліцензій</font><font>.</font></font></p> - -<p><font><font>Деякі старі статті використовують інші ліцензії, про що свідчить відповідна позначка</font><font> </font></font><a href="/uk/docs/Archive/Meta_docs/Examples/Alternate_License_Block" title="Project:En/Examples/Alternate License Block">Alternate License Block</a> наприкінці кожної такої сторінки.</p> - -<div class="warning"> -<p><font><font>Для створення нових сторінок вживати інші ліцензії не дозволено.</font></font></p> -</div> - -<p><strong><font><font>Авторське право на кожен внесок належить авторові, якщо він не передавав його іншій особі</font></font></strong><font><font>.</font></font></p> - -<p><font><font>Якщо маєте сумніви чи запитання щодо викладеного тут, зв'яжіться з </font></font><a class="external" href="mailto:mdn-admins@mozilla.org?subject=MDN%20licensing%20question" rel="nofollow" title="mailto: eshepherd@mozilla.com"><font><font>очільниками MDN</font></font></a><font><font>.</font></font></p> - -<h4 id="Товарні_знаки_й_логотипи"><font><font>Товарні знаки й логотипи</font></font></h4> - -<hr> -<p>Дія ліцензії Creative Commons не поширюється на товарні знаки й логотипи Mozilla Foundation, як і на вигляд та оздоблення цього сайту. Вони, як витвір окремого авторства, не є частиною вмісту MDN, та ліцензовані на інших умовах. Якщо деякі з них ви хочете використати разом із текстом статей, чи маєте якісь питання щодо ліцензійних умов, ви мусите звернутись до Mozilla Foundation за адресою <a href="mailto:licensing@mozilla.org" rel="nofollow" title="mailto:licensing@mozilla.org">licensing@mozilla.org</a>.</p> - -<h3 id="Посилання_на_MDN"><font><font>Посилання на MDN</font></font></h3> - -<p>Різні види посилань та відповідні поради див. у статті <a href="/uk/docs/MDN/About/Linking_to_MDN">посилання на MDN</a>.</p> - -<h2 id="Завантаження_вмісту"><font><font>Завантаження вмісту</font></font></h2> - -<p><font><font>Ви можете завантажити </font></font><a href="https://mdn-downloads.s3-us-west-2.amazonaws.com/developer.mozilla.org.tar.gz"><font><font>повне дзеркало MDN</font></font></a><font><font> (2,1 Гб на лютий 2017 року).</font></font></p> - -<h3 id="Окремі_сторінки"><font><font>Окремі сторінки</font></font></h3> - -<p><font><font>Ви можете завантажити вміст окремої сторінки MDN, додавши до URL-адреси <a href="/uk/docs/MDN/Contribute/Tools/Document_parameters#URL_parameters">відповідні параметри</a>, що вказують бажаний формат.</font></font></p> - -<h3 id="Сторонні_засоби"><font><font>Сторонні засоби</font></font></h3> - -<p><font><font>Ви можете переглядати вміст MDN за допомогою сторонніх засобів, як-от </font></font><a href="http://kapeli.com/dash"><font><font>Dash</font></font></a><font><font> (для macOS) та </font></font><a href="http://zealdocs.org/"><font><font>Zeal</font></font></a><font><font> (для Linux та Windows).</font></font></p> - -<p><font><font>Поза тим, <a href="https://kapeli.com/">Kapeli</a></font></font><font><font> поширює </font></font><font><font><a href="https://kapeli.com/mdn_offline">офлайнові документи MDN</a> що</font></font><font><font> охоплюють HTML, CSS, JavaScript, SVG та XSLT.</font></font></p> - -<h2 id="Негаразди_з_MDN_Web_Docs"><font><font>Негаразди з MDN Web Docs</font></font></h2> - -<p><font><font>Про те, куди і як звертатися з повідомленням про помилки в роботі чи на сторінках документації MDN, див. у статті </font></font><a href="/uk/docs/MDN/Contribute/Howto/Report_a_problem"><font><font>як повідомити про помилку в MDN</font></font></a><font><font>.</font></font></p> - -<h2 id="Історія_MDN_Web_Docs"><font><font>Історія MDN Web Docs</font></font></h2> - -<p><font><font>MDN Web Docs (раніше </font></font><em><font><font>Mozilla Developer Network (MDN)</font></font></em><font><font>, а до того </font></font><em><font><font>Mozilla Developer Center (MDC),</font></font></em><font><font> також відомий як </font></font><em><font><font>Devmo</font></font></em><font><font>) з'явився на початку 2005 року, коли </font></font><a class="external" href="http://www.mozillafoundation.org"><font><font>Mozilla Foundation</font></font></a><font><font> отримала від AOL ліцензію на використання вмісту Netscape </font></font><a href="https://web.archive.org/web/*/devedge.netscape.com" title="Проект: en / DevEdge"><font><font>DevEdge</font></font></a><font><font>. </font><font>Вміст DevEdge опрацювали і все, що становило цінність, добровольці згодом перенесли до MDN.</font></font></p> - -<p>Докладнішу історію MDN, зокрема оповідки декого з причетних осіб, викладено в статті про наше <a href="/uk/docs/MDN_at_ten">святкування десятої річниці</a>.</p> - -<h2 id="Про_Mozilla"><font><font>Про Mozilla</font></font></h2> - -<p><font><font>Якщо вас цікавить хто ми є і як бути частиною Mozilla, чи просто де нас шукати, — ви прийшли куди треба. Дізнайтеся, що нас спонукає і що робить особливими, на сторінці нашої </font></font><a href="https://www.mozilla.org/uk/mission/"><font><font>місії</font></font></a><font><font>.</font></font></p> diff --git a/files/uk/mdn/contribute/getting_started/index.html b/files/uk/mdn/contribute/getting_started/index.html deleted file mode 100644 index 08d86d068b..0000000000 --- a/files/uk/mdn/contribute/getting_started/index.html +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: З чого почати на MDN -slug: MDN/Contribute/Getting_started -tags: - - MDN Meta - - Вступ - - Початківець - - Путівник -translation_of: MDN/Contribute/Getting_started ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<div>Ми — відкрита спільнота розробників та редакторів, що створюють ресурси для кращого вебу, незалежно від компанії, {{glossary("Browser", "переглядача")}} та платформи. Будь-хто може долучитися й кожна нова особа нас посилює. Разом ми можемо й надалі запроваджувати новації в царині веб-технологій, що слугуватимуть спільній меті. Все починається саме тут, завдяки вам.<br> -Кожна частина MDN (від коду, що уможливлює роботу сайту, до прикладів, зразків коду та документації) створена спільнотою розробників та редакторів. Усі можуть запропонувати щось від себе, і ми сподіваємося, що ви приєднаєтесь до нас!</div> - -<h2 id="Три_прості_кроки_до_MDN">Три прості кроки до MDN</h2> - -<p>MDN побудована за принципом Вікіпедії, де будь-хто може додавати й редагувати вміст. Вам не треба бути програмістом чи багато знати про технології. Є безліч завдань, що потребують вирішення: від простих, таких як коректура та виправлення помилок, до складних, як написання документації API. Цей путівник допоможе вам зробити перші кроки та з'ясувати, чим саме ви можете найбільше посприяти поліпшенню MDN.</p> - -<p>Брати учать у розвитку MDN легко і цілком безпечно. Навіть якщо ви десь схибите, це легко виправити; якщо ви не певні того, як щось має виглядати, або маєте прогалини в знаннях граматики, не хвилюйтеся про це! У нас є команда людей, робота яких — пильнувати, щоб вміст MDN був якісним наскільки це можливо. Завжди хтось буде поруч, щоб переконатися, що ваше викладення є охайним та зрозумілим. Поширюйте свої знання, діліться тим, на чому знаєтесь найліпше, а решта спільноти допоможе зробити вашу роботу навіть кращою.</p> - -<div class="note"> -<p><strong>Заувага:</strong> Над перекладом MDN українською мовою працюють лише добровольці (жодної команди постійних учасників немає) але ви завжди можете покладатися на допомогу більш досвідчених членів україномовної частини спільноти.</p> -</div> - -<h3 id="Крок_1_Створіть_обліковий_запис_на_MDN">Крок 1: Створіть обліковий запис на MDN</h3> - -<p>Щоб взяти участь у творенні MDN, вам потрібен обліковий запис. Докладно про це читайте у статті <a href="/uk/docs/MDN/Contribute/Howto/Create_an_MDN_account">«Як створити обліковий запис MDN»</a>. Завважте, що для створення профілю MDN необхідно мати <a href="https://github.com/join">обліковий запис на GitHub</a>, бо зараз ми використовуємо GitHub для аутентифікації.</p> - -<p>Якщо ваша задача потребує створення нових сторінок, читайте <a href="/uk/docs/MDN/Contribute/Howto/Як_створювати_й_редагувати_сторінки#Отримання_дозволу_на_створення_сторінки">відповідний розділ</a> статті <a href="/uk/docs/MDN/Contribute/Howto/Як_створювати_й_редагувати_сторінки">«Як створювати й редагувати сторінки»</a> про те, як отримати відповідний дозвіл. З міркувань безпеки нові користувачі спершу позбавлені цієї можливості.</p> - -<h3 id="Крок_2_Оберіть_завдання">Крок 2: Оберіть завдання</h3> - -<p>Тепер, коли ви увійшли в систему, прочитайте опис {{anch("Можливі типи завдань", "різних типів завдань")}} й оберіть те, що вам найбільш до вподоби. Ви можете обрати будь-яке завдання, що подобається, і почати робити свій внесок.</p> - -<h3 id="Крок_3_Виконайте_завдання">Крок 3: Виконайте завдання</h3> - -<p>Тепер, коли ви знаєте, що саме хочете робити, просто знайдіть якусь сторінку чи то приклад коду, що потребує вашої участі, та виконайте своє завдання!</p> - -<p>Не переймайтеся надмірно довершеністю зробленого. Інші учасники спільноти працюють зокрема й над виправленням помилок, що їх ви можете припуститися. Якщо у Вас виникли запитання під час роботи, на сторінці «<a href="/uk/docs/MDN/Community">Спільнота</a>» Ви знайдете списки розсилки та канали чатів, де можна отримати відповідь.</p> - -<div class="note"> -<p><strong>Заувага:</strong> Якщо ви хочете перевірити якісь зміни на MDN перш ніж робити щось «насправді», у нас саме для того є сторінка «<strong><a href="/uk/docs/Sandbox">Пісочниця</a></strong>». Будьте ласкаві, грайтеся лише там. Не варто робити непотрібних змін на звичайних сторінках, аби побачити, що станеться; це створює безлад, який комусь доведеться прибирати, чи навіть гірше — спантеличує читачів, які щось вивчають або намагаються знайти.</p> -</div> - -<p>Як завершите розпочате завдання, можете братися до наступного. Або ж зверніть увагу на <a href="#Інші_речі_які_ви_можете_зробити_на_MDN">інші речі, які ви можете зробити на MDN</a>.</p> - -<h2 id="Можливі_типи_завдань">Можливі типи завдань</h2> - -<p>Існує кілька напрямків, які ви можете обрати, щоб внести свій внесок у розвиток MDN залежно від вашого хисту й уподобань. Хоча деякі завдання можуть бути складними, у нас є багато простих. Чимало завдань потребує лише п'яти хвилин (або й менше!) вашого часу. Нижче наведено різні типи завдань та приблизний час, що кожне з них зазвичай потребує.</p> - -<h3 id="Варіант_1_Мені_подобаються_слова">Варіант 1: Мені подобаються слова</h3> - -<p>Ви можете допомогти нам перевірити чи зредагувати наявні документи, а також позначити їх належними мітками.</p> - -<ul> - <li><a href="/uk/docs/MDN/Contribute/Howto/Set_the_summary_for_a_page">Зробіть опис для сторінки</a> (5-15 хвилин)</li> - <li><a href="/uk/docs/MDN/Contribute/Howto/Do_an_editorial_review">Зробіть редакційний огляд</a> (5–30 хвилин)</li> - <li><a href="/uk/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary">Додайте новий запис до Словника</a> (15 хвилин-1 година)</li> - <li><a href="/uk/docs/MDN/Contribute/Howto/Write_an_article_to_help_learn_about_the_Web">Напишіть статтю, що допоможе людям дізнатися про web</a> (1-3 години)</li> -</ul> - -<div class="note"><strong>Заувага:</strong> Якщо ви перевіряєте статті або пишете нові, ознайомтеся, будь ласка, спершу зі <a href="/uk/docs/MDN/Contribute/Guidelines/Style_guide">Style Guide</a>. Це допоможе забезпечити однорідність та послідовність викладення.</div> - -<h3 id="Варіант_2_Мені_подобається_код">Варіант 2: Мені подобається код</h3> - -<p>Нам потрібно більше зразків коду! Ви також можете допомогти із розробкою <a href="/uk/docs/MDN/Kuma">Kuma</a> — платформи MDN.</p> - -<ul> - <li><a href="/uk/docs/MDN/Contribute/Howto/Convert_code_samples_to_be_live">Перетворення зразків коду в "Живі"</a> (30 хвилин)</li> - <li><a href="https://wiki.mozilla.org/Webdev/GetInvolved/developer.mozilla.org">Прочитайте ознайомчий путівник</a> (30 хвилин)</li> - <li><a href="http://kuma.readthedocs.org/en/latest/installation.html">Налаштуйте середовище збирання Kuma</a> (1 година)</li> - <li><a href="https://github.com/mozilla/kuma#readme">Запропонуйте свої зміни до коду Kuma</a> (1 година)</li> -</ul> - -<h3 id="Варіант_3_Мені_однаково_подобається_писати_слова_і_код">Варіант 3: Мені однаково подобається писати слова і код</h3> - -<p>У нас є завдання, які вимагають технічних та мовних навичок, як написання нових статей, перевірка на технічну точність або адаптація документів.</p> - -<ul> - <li><a href="/uk/docs/MDN/About/Promote">Рекламуйте MDN на власному веб-сайті</a> (5 хвилин)</li> - <li><a href="/uk/docs/MDN/Contribute/Howto/Do_a_technical_review">Зробіть технічний огляд</a> (30 хвилин)</li> - <li><a href="/uk/docs/Contribute_to_docs_that_are_currently_needed">Напишіть нову статтю з теми, що має попит</a> (година чи більше)</li> - <li><a href="/uk/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web">Створіть взаємодіяльну вправу, що допоможе людям дізнатися про web</a> (година чи більше)</li> - <li><a href="/uk/docs/MDN/Contribute/Howto/Resolve_a_mentored_developer_doc_request">Виправте помилку документації</a> з <a href="http://www.joshmatthews.net/bugsahoy/?mdn=1">MDN-категорії в Bugs Ahoy</a> (година чи більше)</li> -</ul> - -<h3 id="Варіант_4_Я_хочу_перекласти_MDN_своєю_мовою">Варіант 4: Я хочу перекласти MDN своєю мовою</h3> - -<p>Всю роботу з перекладу й <abbr title="локалізації">умісцевлення</abbr> MDN здійснює наша дивовижна спільнота добровольців.</p> - -<ul> - <li><a href="/uk/docs/MDN/Contribute/Localize/Translating_pages">Перекладіть сторінку</a> (2 години) (зважайте на <a href="/uk/docs/MDN/Doc_status/l10nPriority">першочерговість</a>)</li> - <li>Зв'яжіться з іншими перекладачами Вашою мовою, згаданими у статті <a href="/uk/docs/MDN/Contribute/Localize/Проекти_з_локалізації#uk_Українська">«Проекти з локалізації»</a> (30 хвилин)</li> -</ul> - -<h3 id="Варіант_5_Я_знайшов_хибну_інформацію_але_не_знаю_як_це_виправити">Варіант 5: Я знайшов хибну інформацію, але не знаю, як це виправити</h3> - -<p>Ви можете повідомити про негаразди <a class="external" href="https://bugzilla.mozilla.org/form.doc">надіславши звіт</a>. (5 хвилин)</p> - -<h2 id="Інші_речі_які_ви_можете_зробити_на_MDN">Інші речі, які ви можете зробити на MDN</h2> - -<ul> - <li><a href="/uk/docs/MDN/Community">Приєднатися до спільноти MDN</a>.</li> - <li><a href="/uk/profile">Заповніть ваш профіль</a> щоб інші могли дізнатись про вас більше.</li> - <li>Дізнайтеся більше про <a href="/uk/docs/MDN/Contribute">внесок в MDN</a>.</li> -</ul> diff --git a/files/uk/mdn/contribute/howto/create_and_edit_pages/index.html b/files/uk/mdn/contribute/howto/create_and_edit_pages/index.html deleted file mode 100644 index 900b4fa71f..0000000000 --- a/files/uk/mdn/contribute/howto/create_and_edit_pages/index.html +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: Як створювати й редагувати сторінки -slug: MDN/Contribute/Howto/Create_and_edit_pages -tags: - - Вступ - - Початківець - - Путівник -translation_of: MDN/Contribute/Howto/Create_and_edit_pages -original_slug: MDN/Contribute/Howto/Як_створювати_й_редагувати_сторінки ---- -<div>{{MDNSidebar}}</div> - -<p><span class="seoSummary">Ця стаття знайомить новачків із тим, як здійснюється редагування наявних сторінок та створення нових.</span></p> - -<h2 id="Редагування_наявних_сторінок">Редагування наявних сторінок</h2> - -<p>Редагування сторінки:</p> - -<ul> - <li>Клікніть на кнопку<strong> Редагувати</strong> в правому верхньому куті сторінки.</li> - <li>Потім сторінка перезавантажиться з інтерфейсом редактора, в якому можна додавати або видаляти інформацію відразу на сторінці.</li> - <li>Ви можете додавати параграфи, видаляти текст, вставляти заголовки і використовувати інші основні функції, які необхідні для написання та редагування. Дивіться керівництво <a href="/en-US/docs/MDN/Contribute/Editor/Basics">Editor UI elements</a> в <a href="/en-US/docs/MDN/Contribute/Editor">MDN Editor guide</a> щоб отримати більше інформації про використання вбудованого MDN редактора.</li> -</ul> - -<h3 id="Попередній_перегляд_змін">Попередній перегляд змін</h3> - -<p>Щоб продивитись, як ваші зміни будуть відображатись:</p> - -<ul> - <li>Клікніть на кнопку <strong>Попередній перегляд</strong> (в режимі редагування) над заголовком сторінки.</li> - <li><span class="tlid-translation translation" lang="uk"><span title="">Це відкриває сторінку попереднього перегляду, яка показує ваші зміни в новому вікні або вкладці</span></span>.</li> - <li><span class="tlid-translation translation" lang="uk"><span title="">Кожен раз, коли ви натискаєте цю кнопку, вона оновлює сторінку попереднього перегляду з останніми змінами</span></span>.</li> -</ul> - -<p>Будьте уважні! Попередній перегляд сторінки <strong>не зберігає ваші зміни</strong>, тому не закривайте вкладку з редактором, поки не збережете свою роботу.</p> - -<h3 id="Коментар_до_ревізії">Коментар до ревізії</h3> - -<p>Після попереднього перегляду змін ви захочете <em>зберегти вашу ревізію (версію)</em>. Перед тим, як <strong>зберегти</strong>, подивіться на текстовий блок з коментарями до ревізії, що знаходиться внизу сторінки і залиште коментар, щоб пояснити іншим учасникам, чому ви зробили будь-які зміни. Наприклад, ви можливо, додали новий розділ, змінили деякі слова, щоб зробити термінологію більш послідовною, переписали абзац для уточнення мови або видалили інформацію, оскільки вона була зайвою.</p> - -<h3 id="Зміст">Зміст</h3> - -<p>В розділі "У цій статті" знаходиться автоматично створений список посилань до заголовків на сторінці. Формулювання цих посилань можна змінювати, редагуючи заголовки. Також можна видалити вміст секції або зменшити кількість посилань в ній, вибравши "Редагувати назву сторінки та властивості" і змінити значення спадного списку пункту "зміст".</p> - -<h3 id="Мітки">Мітки</h3> - -<p>Ви можете додавати або видаляти теги, які описують вміст сторінки і функцію під розділом редагування сторінки. Дивіться розділ<a href="/en-US/docs/MDN/Contribute/Tagging"> Як правильно поставити теги сторінок</a> для отримання інформації про теги.</p> - -<h3 id="Потрібна_перевірка">Потрібна перевірка?</h3> - -<p><span class="tlid-translation translation" lang="uk"><span title="">Якщо експерт або досвідчений дописувач повинен переглянути ваші зміни, ви можете надіслати запит на технічний огляд (для коду, API чи технологій), редакційний огляд (прозу, граматику та вміст), переконавшись, що відповідний прапорець встановлено перед збереженням</span>.</span></p> - -<h3 id="Вкладення_файлів">Вкладення файлів</h3> - -<p>Якщо ви хочете <strong>долучити файл</strong><em> </em> <span class="tlid-translation translation" lang="uk"><span title="">до існуючої сторінки або додати ілюстрацію для подальшого роз'яснення, його можна ввести внизу сторінки.</span> <span title="">Завантажуючи зображення, будь ласка, використовуйте інструмент для оптимізації зображень, щоб зробити файл якомога меншим для завантаження.</span> <span title="">Це покращує час завантаження сторінки та сприяє загальній продуктивності MDN.</span> <span title="">Ви можете скористатись улюбленим інструментом, якщо він у вас є.</span></span> В іншому випадку ми пропонуємо <a href="https://tinypng.com/">TinyPNG</a>, зручний веб-інструмент.</p> - -<h3 id="Оприлюднити_скасувати_чи_продовжити_редагування">Оприлюднити, скасувати чи продовжити редагування</h3> - -<p>Коли ви закінчите редагування і будете задоволені своїм попереднім переглядом, ви <span class="tlid-translation translation" lang="uk"><span title="">ви можете опублікувати свою роботу та коментарі, натиснувши <em>зелену</em> кнопку</span></span> <strong>Оприлюднити</strong> <span class="tlid-translation translation" lang="uk"><span title="">праворуч від заголовка сторінки або внизу сторінки.</span></span> <span class="tlid-translation translation" lang="uk"><span title="">Якщо ви хочете продовжувати працювати, натисніть кнопку</span></span> <strong>Оприлюднити та продовжити редагування</strong>, <span class="tlid-translation translation" lang="uk"><span title="">що публікує ваші зміни, зберігаючи інтерфейс редагування відкритим</span></span>.</p> - -<p>Якщо ви передумали, ви можете скасувати свої зміни, натиснувши <em>червону</em> кнопку<strong> Відхилити</strong>. <span class="tlid-translation translation" lang="uk"><span title="">Зауважте, що відкидання змін <em>назавжди</em> відкидає їх.</span></span></p> - -<p>Натискання <strong>Enter</strong> в полі редагування коментарів еквівалентне натисканню <strong>Оприлюднити та продовжити редагування</strong>.</p> - -<div class="note"> -<p>Якщо ви намагаєтесь зберегти свою сторінку і ваші зміни відхиляються як недійсні, коли ви намагаєтесь зберегти їх, але вміст насправді підходить для MDN, вам слід звернутися на <a href="mailto:mdn-admins@mozilla.com?subject=MDN%3A%20Content%20Rejection%20Appeal&body=%3CDescribe%20the%20content%20you%20were%20trying%20to%20save%20and%20where%20you%20were%20trying%20to%20place%20it.%3E">email the MDN admin team</a>, щоб допомогли розмістити ваш контент.</p> -</div> - -<h2 id="Отримання_дозволу_на_створення_сторінки">Отримання дозволу на створення сторінки</h2> - -<p>For security reasons, newly-created accounts don't have the ability to create new pages. If you try to do so, you'll see a page instructing you how to go about getting the page created. There are two options:</p> - -<ul> - <li><strong>Ask for the page to be created for you.</strong> To do this, <a href="https://bugzilla.mozilla.org/enter_bug.cgi?bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&cf_fx_iteration=---&cf_fx_points=---&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=Developer%20Documentation&rep_platform=Unspecified&short_desc=Create%20page%3A%20&status_whiteboard=create-page&target_milestone=---&version=unspecified">file a documentation request bug</a> with the subject "Create page: <page title>". Be sure to fill out the URL field with the location on MDN where you'd like the page to go if you know where to put it. You should include in the comment text some information about why you need the page created.</li> - <li><strong>Request page creation privileges.</strong> If you request page creation privileges and they're granted to you, you'll be able to add new pages yourself by following the instructions here. To request these privileges, <a href="mailto:mdn-admins@mozilla.org">email the MDN admin</a> team with your request. Be sure to include your username, why you would like to have the ability to create new pages (for instance, you're documenting a new API which involves many new pages, or you'd like to add new terms to the glossary). You should also have already made some useful contributions to the site content, and should have been a contributor for some length of time (the length of time and the other factors are all considered together, so there isn't a fixed time period here).</li> -</ul> - -<h2 id="Створення_нової_сторінки">Створення нової сторінки</h2> - -<p>Once you have page-creation permission, you can start creating new pages.</p> - -<p>If you do not know where to put a new article, <strong>do not worry about it!</strong> Put it anywhere and we will find it and move it to where it belongs or merge it into existing content if that makes the most sense. You also do not need to worry about making it perfect. We have happy helper gnomes that will help make your content clean and luscious.</p> - -<p>There are a few ways to create a new page:</p> - -<ul> - <li><a href="#Missing_page_link">"Missing page" link</a></li> - <li><a href="#New_page_without_link">New page without link</a></li> - <li><a href="#Subpage_of_an_existing_page">Subpage of an existing page</a></li> - <li><a href="#Clone_of_an_existing_page">Clone of an existing page</a></li> - <li><a href="#Link_from_an_existing_page">Link from an existing page</a></li> -</ul> - -<dl> -</dl> - -<h3 id="Посилання_на_відсутню_сторінку">Посилання на відсутню сторінку</h3> - -<p>As with most wikis, on MDN it is possible to create a link to a page that doesn't yet exist. For example, an author might create a list of all the members of an API, before creating the pages for those members. On MDN, links to non-existent pages are typically displayed in red.</p> - -<p>To create a page from a "missing page" link:</p> - -<ol> - <li>Make sure that you are logged into MDN, and have page-creation permission. (If you aren't logged in, clicking a "missing page" link gives a 404 (page not found) error.)</li> - <li>Click the "missing page" link. If you have page creation permission, the <a href="/en-US/docs/MDN/Contribute/Editor">MDN Editor UI</a> opens, ready for you to create the missing page.</li> - <li>Write the content of the page, and save it.</li> -</ol> - -<h3 id="Нова_сторінка_без_посилань">Нова сторінка без посилань</h3> - -<p><em>To create a new page without linking from another page</em>, enter a unique page name in the URL field of your browser. For example, if you enter:</p> - -<pre class="language-html">https://developer.mozilla.org/uk/docs/FooBar</pre> - -<p>MDN creates a new page with the title "FooBar" and opens the editor so you can add content to the new page. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article for how to use the editor mode.</p> - -<p><em>To create a new page without linking from another page</em>:</p> - -<ol> - <li>Make sure that you are logged in, and have page-creation permission.</li> - <li>Enter the following in the URL field of your browser.</li> -</ol> - -<pre class="language-html">https://developer.mozilla.org/uk/docs/new</pre> - -<p>MDN creates a new page with a place for a title and opens the editor so you can add content to the new page. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article for how to use the editor mode.</p> - -<h3 id="Підстаття_наявної_статті">Підстаття наявної статті</h3> - -<p>To create a page that you want to be below an existing page in the page hierarchy:</p> - -<ol> - <li>On the "parent" page, click the <strong>Advanced</strong> menu (the gear icon in the toolbar), and click <strong>New sub-page</strong>. An editor view opens for creating a new document.</li> - <li>Type a title for the document in the <strong>Title</strong> field.</li> - <li>Change the <strong>Slug</strong> field if needed (for example, if the title is very long and you want a shorter URL). This field is automatically filled by the editor, by substituting underscores for spaces in the title. In this case, you can change only the last part of the URL of the document.</li> - <li>In the <strong>TOC</strong> field, select the heading levels you want to be automatically displayed in the table of contents for the page, or "No table of contents" if the page doesn't need one.</li> - <li>Write content of the page in the editor pane, and save your changes. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article for how to use the editor mode.</li> -</ol> - -<h3 id="Створення_клона_наявної_сторінки">Створення клона наявної сторінки</h3> - -<p>If there is an existing page whose format you want to use for your new page, you can "clone" that page and then change the content.</p> - -<ol> - <li>On the original page, click the <strong>Advanced</strong> menu (the gear icon in the toolbar), and click <strong>Clone this page</strong>. An editor view opens for creating a new document.</li> - <li>Change the <strong>Title</strong> of the page as appropriate for the new content. The <strong>Slug</strong> field is updated automatically as you change the <strong>Title</strong> field.</li> - <li>If needed, change the path portion of the <strong>Slug</strong> field, to put the new document in a different part of the document hierarchy. (In most cases, this is not needed, because the cloned page has similar content to the original, and therefore should be located in a similar place.)</li> - <li>In the <strong>TOC</strong> field, select the heading levels you want to be automatically displayed in the table of contents for the page, or "No table of contents" if the page doesn't need one.</li> - <li>Write content of the page in the editor pane, and save your changes. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article for how to use the editor mode.</li> -</ol> - -<h3 id="Посилання_з_наявної_сторінки">Посилання з наявної сторінки</h3> - -<p>This method is a bit of a hybrid. You can create a link on another page, and then click the link you just inserted, to create the new page.</p> - -<ol> - <li>Enter the name of the new page anywhere (that makes sense) in the text of an existing page.</li> - <li>Highlight the name and <strong>click the Link icon (<img alt="" src="https://developer.mozilla.org/files/3810/link-icon.png" style="height: 28px; width: 29px;">) </strong>in the editor's toolbar. The <strong>"Update Link"</strong> dialog opens, with the highlighted text in the<strong> "Link To"</strong> field.</li> - <li>"/en-US/docs/" is inserted by default at the beginning of the URL field.<em> Enter the name </em>of the page after "/en-US/docs/". (The page name doesn't have to be the same as the link text.)</li> - <li>Click OK to create and insert the link.</li> -</ol> - -<p>If the page does not already exist, the link is displayed in red. If the page <em>does</em> already exist, the link is displayed in blue. If you want to create a new page but the page title you want is already taken, check first if it makes more sense to help edit and improve the page that is already there. Otherwise, think of a different title for your new page and create a link for it. Refer to the <a href="https://developer.mozilla.org/Project:en/Page_Naming_Guide" title="Project:en/Page_Naming_Guide">page naming guide</a> for guidelines.</p> - -<p>To add content to your new page, click on the red link you just created (after saving and closing the editor). The new page opens in editor mode, so you can start writing. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article for how to use the editor mode.</p> - -<h2 id="Оновлення_вмісту_сторінки">Оновлення вмісту сторінки</h2> - -<p>MDN's support for KumaScript macros and transclusion of content from one page into another can sometimes be hampered slightly by the need for caching of generated pages for performance reasons. Pages are built from their source, and that output is cached for future requests. From then on, any macros (templates) or transclusions (using the macro<span class="templateLink"><code><a href="https://developer.mozilla.org/en-US/docs/Template:Page">Page</a></code></span> on that page will not reflect changes made to the macro, the macro's output, or the contents of the transcluded material.</p> - -<ul> - <li>To update a page manually, you can do a force-refresh in your browser. MDN detects this and triggers a page rebuild, pulling in updated macro output and transcluded page content.</li> - <li>You can also configure pages to periodically be rebuilt automatically. This should not be done unless you expect the page to need updating frequently. See <a href="/en-US/docs/MDN/Contribute/Tools/Page_regeneration">Page regeneration</a> for detailed information.</li> -</ul> - -<h2 id="Див._також">Див. також</h2> - -<ul> - <li><a href="/en-US/docs/MDN/Contribute/Editor">MDN editor guide</a></li> - <li><a href="/en-US/docs/MDN/Contribute/Content/Style_guide">MDN style guide</a></li> -</ul> diff --git a/files/uk/mdn/contribute/howto/index.html b/files/uk/mdn/contribute/howto/index.html deleted file mode 100644 index 5bde5d4a0a..0000000000 --- a/files/uk/mdn/contribute/howto/index.html +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Покрокові путівники -slug: MDN/Contribute/Howto -tags: - - Landing - - MDN Meta -translation_of: MDN/Contribute/Howto ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<p>Кожна з наведених статей являє собою покроковий путівник для досягнення певної мети пов'язаної із внеском до MDN.</p> - -<p>{{LandingPageListSubpages}}</p> diff --git a/files/uk/mdn/contribute/index.html b/files/uk/mdn/contribute/index.html deleted file mode 100644 index b265149f28..0000000000 --- a/files/uk/mdn/contribute/index.html +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Внесок до MDN -slug: MDN/Contribute -tags: - - Landing - - MDN Meta - - Путівник -translation_of: MDN/Contribute ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<p><span id="result_box" lang="uk"><span>Ласкаво просимо!</span> <span>Відвідавши цю сторінку, ви зробили перший крок до того, щоб стати учасником MDN!</span></span></p> - -<p><span class="seoSummary">Наведені тут вказівки охоплюють всі питання щодо участі в творенні MDN, зокрема, настанови зі стилю, посібники з використання нашого редактора та інструментів тощо. Будь ласка, зверніть увагу, що перш ніж редагувати або створювати будь-які сторінки, Ви маєте ознайомитись та погодитись з <a href="https://www.mozilla.org/en-US/about/legal/terms/mozilla/">умовами Mozilla</a>. </span></p> - -<p>Якщо ви раніше не допомагали MDN, зверніться спершу до статті <a href="/uk/docs/MDN/з_чого_почати">«З чого почати на MDN»</a> — вона допоможе Вам з вибором першого завдання і його виконанням.</p> - -<p>{{LandingPageListSubPages()}}</p> diff --git a/files/uk/mdn/guidelines/index.html b/files/uk/mdn/guidelines/index.html deleted file mode 100644 index d16a0b0be8..0000000000 --- a/files/uk/mdn/guidelines/index.html +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Путівники -slug: MDN/Guidelines -tags: - - MDN Meta - - Путівник -translation_of: MDN/Guidelines ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<p><span class="seoSummary">Перелічені тут путівники наводять докладні відомості щодо того, як слід писати й оформлювати документацію MDN, як мають виглядати зразки коду та інший вміст.</span> Наслідуючи їх ви можете бути певні, що ваше викладення буде виразним та легкочитним.</p> - -<p>{{LandingPageListSubpages}}</p> diff --git a/files/uk/mdn/guidelines/writing_style_guide/index.html b/files/uk/mdn/guidelines/writing_style_guide/index.html deleted file mode 100644 index f14340877a..0000000000 --- a/files/uk/mdn/guidelines/writing_style_guide/index.html +++ /dev/null @@ -1,727 +0,0 @@ ---- -title: Настанови зі стилю -slug: MDN/Guidelines/Writing_style_guide -tags: - - MDN Meta - - Style guide - - Настанови зі стилю - - Путівник -translation_of: MDN/Guidelines/Writing_style_guide -original_slug: MDN/Guidelines/Настанови_зі_стилю ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<p><span class="seoSummary">Щоб зробити викладення документації на MDN Web Docs однорідним, виразним та легкочитним, в цих настановах зазначено, як слід писати, форматувати й упорядковувати текст. Втім, це радше посібник, аніж перелік суворих вимог.</span> Звісно, нас більше цікавить вміст, аніж форма викладення, тож не переймайтесь надмірно докладним вивченням настанов зі стилю. Але й не дивуйтесь, якщо хтось із сумлінних добровольців згодом виправить ваш доробок задля дотримання наведених тут правил.</p> - -<p>Мовознавчі настанови цього посібника стосуються здебільшого англійської мови. Для інших мов можна й варто створювати окремі стильові посібники. Їх слід оприлюднювати як підстатті основної сторінки перекладацької команди.</p> - -<p>Стандарти стилю, що стосуються вмісту на інших (окрім MDN) сайтах, наведено у <a href="https://www.mozilla.org/en-US/styleguide/">Єдиному посібнику зі стилю Mozilla</a>.</p> - -<h2 id="Основи">Основи</h2> - -<p>Найкраще місце для початку в будь-якому великому керівництві - це певні базові текстові стандарти, які допомагають дотримуватись сумісності документації. Наступні розділи описуються деякі із цих основ, які допоможуть вам.</p> - -<h3 id="Назви_сторінок">Назви сторінок</h3> - -<p>Назви сторінок використовуються в результатах пошуку, а також для структурування ієрархії сторінок у списку "хлібних крихт" зверху сторінки. Назви сторінок (які відображаються зверху сторінки, а також у результатах пошуку) можуть відрізнятись від "slug" (унікальний ідентифікатор) соторінки, яка є частиною URL адреси після "<em><locale>/docs/</em>".</p> - -<h4 id="Регістр_заголовків_сторінок_та_розділів">Регістр заголовків сторінок та розділів</h4> - -<p>Заголовки сторінок та заголовки розділів мають починатись з великої літери (використовується лише для першого слова в реченні та власних імен), але не кожне слово:</p> - -<ul> - <li><span class="correct"><strong>Правильно</strong></span>: "Новий спосіб прокидувань в JavaScript"</li> - <li><span class="incorrect"><strong>Неправильно</strong></span>: "Новий Спосіб Прокидувань В JavaScript"</li> -</ul> - -<p>У нас є багато старих сторінок, які було написано до встановлення цього правила. За бажанням ви можете оновити їх, аби вони стали більш читабильними. Поступово ми доберемось до їх редагування.</p> - -<h4 id="Вибір_заголовків_та_коротких_заголовків.">Вибір заголовків та коротких заголовків.</h4> - -<p>Унікальний ідентифікатор має бути коротким; коли створюєте новий рівень ієрархії, компонент нового рівня у вигляді "slug" ідентифікатора має складатись із одного-двох слів.</p> - -<p>Заголовки сторінок, з іншої сторони, можуть бути такими довгими на скільки це потрібно і мають описувати суть статті.</p> - -<h4 id="Створення_нових_піддерев">Створення нових піддерев</h4> - -<p>Коли вам потрібно додати якісь статті до певної теми чи області обговорення, ви можете зробити це створивши цільову сторінку, після цього додавайте підсторінки для кожної окремої статті. Цільова сторінка має описуватись за допомогою одного або двох абзаців, які розкривають тему чи технологію, потім відобразіть список підсторінок з поясненням до кожної з них. Ви можете автоматизувати вставку сторінок в список, використовуючи макроси, які ми створили.</p> - -<p>For example, consider the <a href="/uk/docs/Web/JavaScript">JavaScript</a> guide, which is structured as follows:</p> - -<ul> - <li><a href="/uk/docs/Web/JavaScript/Guide" title="JavaScript/Guide">JavaScript/Guide</a> - Main table-of-contents page</li> - <li><a href="/uk/docs/Web/JavaScript/Guide/Introduction" title="JavaScript/Guide/JavaScript_Overview">JavaScript/Guide/JavaScript Overview</a></li> - <li><a href="/uk/docs/Web/JavaScript/Guide/Functions" title="JavaScript/Guide/Functions">JavaScript/Guide/Functions</a></li> - <li><a href="/uk/docs/Web/JavaScript/Guide/Dokladno_pro_Objectnu_Model" title="JavaScript/Guide/Details_of_the_Object_Model">JavaScript/Guide/Details of the Object Model</a></li> -</ul> - -<p>Try to avoid putting your article at the top of the hierarchy, which slows the site down and makes search and site navigation less effective.</p> - -<h3 id="General_article_content_guidelines">General article content guidelines</h3> - -<p>When writing any document, it's important to know how much to say. If you ramble on too long, the article becomes tedious to read and nobody will use it. Getting the amount of coverage right is important for several reasons. Among those reasons: to ensure that the reader finds the information they truly need, and to provide enough quality material for search engines to adequately analyze and rank the article. We'll discuss the former (providing the information the reader may need) here. To learn a little about ensuring that pages are properly classified and ranked by search engines, see the article <a href="/uk/docs/MDN/Contribute/Howto/Write_for_SEO">How to write for SEO on MDN</a>.</p> - -<p>The goal is to write pages that include all the information that readers may need without going on too long about it all. We have a few recommendations in this area.</p> - -<h4 id="Consider_your_audience">Consider your audience</h4> - -<p>Keep in mind that these are guidelines. Some of these tips may not apply in every case. Certainly keep your article's audience in mind. An article on advanced network techniques likely doesn't need to go into as much detail about basic networking concepts as the typical article on networking code, for instance.</p> - -<h4 id="Provide_a_useful_summary">Provide a useful summary</h4> - -<p>Make sure the article's summary—that is, the opening paragraph or paragraphs before the first heading—provides enough information for the reader to understand if the article is likely to be covering what they're interested in reading about. In guide or tutorial content, the summary should let the reader know what topics will be covered and what they're already expected to know, if anything. It should mention the technology, technologies, and/or APIs that are being documented or discussed, with links to those, and it should offer hints as to the situations in which the article's contents might be useful.</p> - -<h5 id="Example_Too_short!">Example: Too short!</h5> - -<p>This example of a summary is far too short. It leaves out too much information, such as what it means exactly to "stroke" text, where the text is drawn, and so forth.</p> - -<div class="example-bad"> -<p><strong><code>CanvasRenderingContext2D.strokeText()</code></strong> draws a string.</p> -</div> - -<h5 id="Example_Too_long!">Example: Too long!</h5> - -<p>Here, we've updated the summary, but now it's far too long. Too much detail is included, and the text gets far too much into other methods and properties. Instead, the summary should focus on the <code>strokeText()</code> method, and should refer to the appropriate guide where the other details are offered.</p> - -<div class="example-bad"> -<p>When called, the Canvas 2D API method <strong><code>CanvasRenderingContext2D.strokeText()</code></strong> strokes the characters in the specified string beginning at the coordinates specified, using the current pen color. In the terminology of computer graphics, "stroking" text means to draw the outlines of the glyphs in the string without filling in the contents of each character with color.</p> - -<p>The text is drawn using the context's current font as specified in the context's {{domxref("CanvasRenderingContext2D.font", "font")}} property.</p> - -<p>The placement of the text relative to the specified coordinates are determined by the context's <code>textAlign</code>, <code>textBaseline</code>, and <code>direction</code> properties. <code>textAlign</code> controls the placement of the string relative to the X coordinate specified; if the value is <code>"center"</code>, then the string is drawn starting at <code>x - (stringWidth / 2)</code>, placing the specified X-coordinate in the middle of the string. If the value is <code>"left"</code>, the string is drawn starting at the specified value of <code>x</code>. And if <code>textAlign</code> is <code>"right"</code>, the text is drawn such that it ends at the specified X-coordinate.</p> - -<p>(etc etc etc...)</p> - -<p>You can, optionally, provide a fourth parameter that lets you specify a maximum width for the string, in pixels. If you provide this parameter, the text is compressed horizontally or scaled (or otherwise adjusted) to fit inside a space that wide when being drawn.</p> - -<p>You can call the <strong><code>fillText()</code></strong> method to draw a string's characters as filled with color instead of only drawing the outlines of the characters.</p> -</div> - -<h5 id="Example_Much_better!">Example: Much better!</h5> - -<p>Here we see a much better overview for the <code>strokeText()</code> method.</p> - -<div class="example-good"> -<p>The {{domxref("CanvasRenderingContext2D")}} method <code><strong>strokeText()</strong></code>, part of the <a href="/uk/docs/Web/API/Canvas_API">Canvas 2D API</a>, strokes—that is, draws the outlines of—the characters of a specified string, anchored at the position indicated by the given X and Y coordinates. The text is drawn using the context's current {{domxref("CanvasRenderingContext2D.font", "font")}}, and is justified and aligned according to the {{domxref("CanvasRenderingContext2D.textAlign", "textAlign")}}, {{domxref("CanvasRenderingContext2D.textBaseline", "textBaseline")}}, and {{domxref("CanvasRenderingContext2D.direction", "direction")}} properties.</p> - -<p>For more details and further examples, see {{SectionOnPage("/uk/docs/Learn/JavaScript/Client-side_web_APIs/Drawing_graphics", "Text")}} in the Learning Area as well as our main article on the subject, <a href="/uk/docs/Web/API/Canvas_API/Tutorial/Drawing_text">Drawing text</a>.</p> -</div> - -<h4 id="Include_all_relevant_examples">Include all relevant examples</h4> - -<p>More pages should have examples than should not have them. The majority of pages most likely deserve multiple examples, in fact. It's important to ensure that you use examples to clarify what every parameter is used for, and to clarify any edge cases that may exist. You should also use examples to demonstrate solutions for common tasks, and you should use examples to demonstrate solutions to problems that may arise.</p> - -<p>Each example should be preceded by text explaining what the example does and anything the reader should know before beginning to read or try out the example.</p> - -<p>In addition, each piece of code should include an explanation of how it works. Keep in mind that it may make sense to break up a large piece of code into smaller portions so they can be described individually. The text following each piece of code should explain anything relevant, using an appropriate level of detail. If the code is very simple and doesn't really feature anything directly related to the API being documented, you may only give a quick summary of what it is and why it's there. If the code is intricate, uses the API being documented, or is technically creative, you should provide a more detailed explanation.</p> - -<p>When using the live sample system, it's helpful to be aware that all of the {{HTMLElement("pre")}} blocks in the area that contains the sample are concatenated together before running the example, which lets you break any or all of the HTML, CSS, and JavaScript into multiple segments, each optionally with its own descriptions, headings, and so forth. This makes documenting code incredibly powerful and flexible.</p> - -<h4 id="Overly-short_articles_are_hard_to_find">Overly-short articles are hard to find</h4> - -<p>If an article is "thin"—that is, too short—it may not be indexed properly (or at all) by search engines. As a rule of thumb, the article's body text should be at least 250-300 words. Don't artificially inflate a page that simply can't reasonably be made longer than that, but treat this guideline as a target to shoot for as a minimum when possible.</p> - -<h3 id="Sections_paragraphs_and_newlines">Sections, paragraphs, and newlines</h3> - -<p>Use heading levels in decreasing order: {{HTMLElement("h2")}} then {{HTMLElement("h3")}} then {{HTMLElement("h4")}}, without skipping levels. H2 is the highest level allowed because H1 is reserved for the page title. If you need more than three or four levels of headers you should consider breaking up the article into several smaller articles with a landing page, linking them together using the {{TemplateLink("Next")}}, {{TemplateLink("Previous")}}, and {{TemplateLink("PreviousNext")}} macros.</p> - -<p>The Enter (or Return) key on your keyboard starts a new paragraph. To insert a newline without a space, hold down the Shift key while pressing Enter.</p> - -<p>Don't create single subsections — you don't subdivide a topic into one. It's either two subheadings or more or none at all.</p> - -<p>Don't have bumping heads, which are headings followed immediately by headings. Aside from looking horrible, it's helpful to readers if every heading has at least a brief intro after it to introduce the subsections beneath.</p> - -<h3 id="Lists">Lists</h3> - -<p>Lists should be written in a similar format across all contributions. Correct procedures should include suitable punctuation and sentence structure regardless of the list format. However dependent on the type of list you are writing, you must adjust your format accordingly. Refer to the documentation below to understand the differences of each.</p> - -<h4 id="Bulleted_Lists">Bulleted Lists</h4> - -<p>Bulleted lists should be used for grouping purposes to create concise but effective pieces of information. Each new piece of information must start with a '•' to signify a new piece. Bulleted lists must follow standard punctuation usage, pay attention to the use of full stops; they must be included at the end of each sentence just like standard writing practice.</p> - -<p>An example of a correctly structured bulleted list:</p> - -<div class="example-good"> -<p><em>In this example we should include:</em></p> - -<ul> - <li><em>A condition, with a brief explanation.</em></li> - <li><em>A similar condition, with a brief explanation.</em></li> - <li> - <p><em>Yet another condition, some further explanation.</em></p> - </li> -</ul> -</div> - -<p>Note how the format remains the same from bullet to bullet. Create a bullet point, state a condition that has relevence to your indented topic and add some pausing punctuation in order to follow up the condition with a concise explanation.</p> - -<h4 id="Numbered_Lists">Numbered Lists</h4> - -<p>Instruction lists must follow suitable numbering and format. It is important to include these attributes as with instructions, being clear is a key priority. Create the list in a similar style to a bulleted list, however numbered or instruction lists can be extensive where necessary, meaning correct punctuation is vital as you will be forming complex sentences.</p> - -<p>An example of a correctly structured numbered list:</p> - -<blockquote> -<p><em>In order for you to structure a correct numbered list you must:</em></p> - -<p><em>1. Begin with creating an introductory heading to lead into the instructions. This way we can provide the user with context before beginning the instructions.</em></p> - -<p><em>2. Start creating your instructions, listing your instructions with numbers. This is a standard format of a numbered list that is easily recognizable by the user. Your instructions may be quite extensive, so it is important to write effectively and use correct punctuation where necessary.</em></p> - -<p><em>3. After you have finished your instructions, close off the numbered list with a brief explanation of the outcome upon completion.</em></p> - -<p><em>This is an example of writing your closing explanation. We have created a short numbered list which provides instructive steps to produce a numbered list with the correct formatting. </em></p> -</blockquote> - -<p>Numbered lists are almost exclusive for instructive purposes, so before writing consider your approach based on the context of the information you are trying to relay.</p> - -<h3 id="Text_formatting_and_styles">Text formatting and styles</h3> - -<p>Use the "Formatting Styles" drop-down list to apply predefined styles to selected content.</p> - -<div class="note">The "Note" style is used to call out important notes, like this one.</div> - -<div class="warning">Similarly, the "Warning" style creates warning boxes like this.</div> - -<p>Unless specifically instructed to do so, <strong>do not</strong> use the HTML <code>style</code> attribute to manually style content. If you can't do it using a predefined class, drop into {{IRCLink("mdn")}} and ask for help.</p> - -<h3 id="Code_sample_style_and_formatting">Code sample style and formatting</h3> - -<div class="note"> -<p><strong>Note</strong>: This section deals with the styling/formatting of code as it appears on an MDN article. If you want guidelines on actually writing code examples, see our <a href="/uk/docs/MDN/Contribute/Guidelines/Code_samples">Code sample guidelines</a>.</p> -</div> - -<h4 id="Tabs_and_line_breaks">Tabs and line breaks</h4> - -<p>Use two spaces per tab in all code examples. Indent the code cleanly, with open-brace ("{") characters on the same line as the statement that opens the block. For example:</p> - -<pre class="brush: js notranslate">if (condition) { - /* handle the condition */ -} else { - /* handle the "else" case */ -} -</pre> - -<p>Long lines shouldn't be allowed to stretch off horizontally to the extent that they require horizontal scrolling to read. Instead, break at natural breaking points. Some examples follow:</p> - -<pre class="brush: js notranslate">if (class.CONDITION || class.OTHER_CONDITION || class.SOME_OTHER_CONDITION - || class.YET_ANOTHER_CONDITION ) { - /* something */ -} - -var toolkitProfileService = Components.classes["@mozilla.org/toolkit/profile-service;1"] - .createInstance(Components.interfaces.nsIToolkitProfileService); -</pre> - -<h4 id="Inline_code_formatting">Inline code formatting</h4> - -<p>Use the "Code" button (labeled with two angle brackets "<>") to apply inline code-style formatting to function names, variable names, and method names (this uses the {{HTMLElement("code")}} element). For example, "the <code class="js plain">frenchText()</code> function".</p> - -<p>Method names should be followed by a pair of parentheses: <code>doSomethingUseful()</code>. The parentheses help differentiate methods from other code terms.</p> - -<h4 id="Syntax_highlighting">Syntax highlighting</h4> - -<p><img alt="Screenshot of the 'Syntax Highlighter' menu." src="https://mdn.mozillademos.org/files/12682/Language%20list.png" style="border-style: solid; border-width: 1px; float: right; margin: 2px 4px;">Entire lines (or multiple lines) of code should be formatted using syntax highlighting rather than the {{HTMLElement("code")}} element. Select the appropriate language from the language list button (the one with the two code blocks), as seen in the screenshot to the right. This will insert a preformatted code box with line numbers and syntax highlighting for the chosen language.</p> - -<p>The following example shows text with JavaScript formatting:</p> - -<div class="line number2 index1 alt1"> -<pre class="brush: js notranslate">for (var i = 0, j = 9; i <= 9; i++, j--) - document.writeln("a[" + i + "][" + j + "]= " + a[i][j]);</pre> -</div> - -<p>If no appropriate language is available, use ("No Highlight" in the language menu). This will result in code without syntax highlighting:</p> - -<pre class="brush: plain notranslate">x = 42;</pre> - -<h4 id="Syntax_definitions">Syntax definitions</h4> - -<p>If you want to insert a syntax definition, you can choose the "Syntax Box" option from the "Styles" drop-down menu in the editor toolbar. This will give the syntax definition a special formatting distinguishing it from normal code.</p> - -<h4 id="Blocks_not_referring_to_code">Blocks not referring to code</h4> - -<p>There are a few use cases where a <pre> block does not refer to code and doesn't have syntax highlighting nor line numbers. In such cases you should add a <pre> without class. Those cases include things like tree structures:</p> - -<pre class="notranslate">root/ - - folder1/ - file1 - - folder2/ - file2 - file3 -</pre> - -<p>To create preformatted content without syntax highlighting and line numbers click the "pre" button in the toolbar. Then start to type the text.</p> - -<h4 id="Styling_HTML_element_references">Styling HTML element references</h4> - -<p>There are specific rules to follow when writing about HTML elements. These rules produce consistent descriptions of elements and their components. They also ensure correct linking to detailed documentation.</p> - -<dl> - <dt>Element names</dt> - <dd>Use the {{TemplateLink("HTMLElement")}} macro, which creates a link to the page for that element. For example, writing \{{HTMLElement("title")}} produces "{{HTMLElement("title")}}". If you don't want to create a link, <strong>enclose the name in angle brackets</strong> and use "Code (inline)" style (e.g., <code><title></code>).</dd> - <dt>Attribute names</dt> - <dd>Use <strong>bold face</strong>.</dd> - <dt>Attribute definitions</dt> - <dd>Use the {{TemplateLink("htmlattrdef")}} macro (e.g., <span class="nowiki">\{{htmlattrdef("type")}}</span>) for the definition term, so that it can be linked to from other pages, then use the {{TemplateLink("htmlattrxref")}} macro (e.g., <span class="nowiki">\{{htmlattrxref("attr","element")}}</span>) to reference attribute definitions.</dd> - <dt>Attribute values</dt> - <dd>Use "Code (inline)" style, and do not use quotation marks around strings, unless needed by the syntax of a code sample. For example: When the <strong>type</strong> attribute of an <code><input></code> element is set to <code>email</code> or <code>tel</code> ...</dd> - <dt>Labeling attributes</dt> - <dd>Use labels like {{HTMLVersionInline(5)}} thoughtfully. For example, use them next to the bold attribute name but not for every occurrence in your body text.</dd> -</dl> - -<h3 id="Latin_abbreviations">Latin abbreviations</h3> - -<h4 id="In_notes_and_parentheses">In notes and parentheses</h4> - -<ul> - <li>Common Latin abbreviations (etc., i.e., e.g.) may be used in parenthetical expressions and notes. Use periods in these abbreviations, followed by a comma or other appropriate punctuation. - <ul> - <li><span class="correct"><strong>Correct</strong></span>: Web browsers (e.g., Firefox) can be used ...</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers e.g. Firefox can be used ...</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers, e.g. Firefox, can be used ...</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers, (eg: Firefox) can be used ...</li> - </ul> - </li> -</ul> - -<h4 id="In_running_text">In running text</h4> - -<ul> - <li>In regular text (i.e., text outside of notes or parentheses), use the English equivalent of the abbreviation. - <ul> - <li><span class="correct"><strong>Correct</strong></span>: ... web browsers, and so on.</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: ... web browsers, etc.</li> - <li><span class="correct"><strong>Correct</strong></span>: Web browsers such as Firefox can be used ...</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers e.g. Firefox can be used ...</li> - </ul> - </li> -</ul> - -<h4 id="Meanings_and_English_equivalents_of_Latin_abbreviations">Meanings and English equivalents of Latin abbreviations</h4> - -<table class="fullwidth-table"> - <tbody> - <tr> - <th>Abbrev</th> - <th>Latin</th> - <th>English</th> - </tr> - <tr> - <td>cf.</td> - <td><em>confer</em></td> - <td>compare</td> - </tr> - <tr> - <td>e.g.</td> - <td><em>exempli gratia</em></td> - <td>for example</td> - </tr> - <tr> - <td>et al.</td> - <td><em>et alii</em></td> - <td>and others</td> - </tr> - <tr> - <td>etc.</td> - <td><em>et cetera</em></td> - <td>and so forth, and so on</td> - </tr> - <tr> - <td>i.e.</td> - <td><em>id est</em></td> - <td>that is, in other words</td> - </tr> - <tr> - <td>N.B.</td> - <td><em>nota bene</em></td> - <td>note well</td> - </tr> - <tr> - <td>P.S.</td> - <td><em>post scriptum</em></td> - <td>postscript</td> - </tr> - </tbody> -</table> - -<div class="note"> -<p>Always consider whether it's truly beneficial to use a Latin abbreviation. Some of these are used so rarely that many readers won't understand the meaning, and others are often confused with one another. And be sure that <strong>you</strong> use them correctly, if you choose to do so. For example, be careful not to confuse "e.g." with "i.e.", which is a common error.</p> -</div> - -<h3 id="Acronyms_and_abbreviations">Acronyms and abbreviations</h3> - -<h4 id="Capitalization_and_periods">Capitalization and periods</h4> - -<p>Use full capitals and delete periods in all acronyms and abbreviations, including organizations such as "US" and "UN".</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: XUL</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: X.U.L.; Xul</li> -</ul> - -<h4 id="Expansion">Expansion</h4> - -<p>On the first mention of a term on a page, expand acronyms likely to be unfamiliar to users. When in doubt, expand it, or, better, link it to the article or <a href="/uk/docs/Glossary">glossary</a> entry describing the technology.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: "XUL (XML User Interface Language) is Mozilla's XML-based language..."</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: "XUL is Mozilla's XML-based language..."</li> -</ul> - -<h4 id="Plurals_of_acronyms_and_abbreviations">Plurals of acronyms and abbreviations</h4> - -<p>For plurals of acronyms or abbreviations, add <em>s</em>. Don't use an apostrophe. Ever. Please.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: CD-ROMs</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: CD-ROM's</li> -</ul> - -<h4 id="Versus_vs._and_v.">"Versus", "vs.", and "v."</h4> - -<p>The contraction "vs." is preferred.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: this vs. that</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: this v. that</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: this versus that</li> -</ul> - -<h3 id="Capitalization">Capitalization</h3> - -<p>Use standard English capitalization rules in body text, and capitalize "World Wide Web." It is acceptable to use lower case for "web" (used alone or as a modifier) and "internet;" this guideline is a change from a previous version of this guide, so you may find many instances of "Web" and "Internet" on MDN. Feel free to change these as you are making other changes, but editing an article just to change capitalization is not necessary.</p> - -<p>Keyboard keys should use sentence-style capitalization, not all-caps capitalization. For example, "Enter" not "ENTER."</p> - -<h3 id="Contractions">Contractions</h3> - -<p>Our writing style tends to be casual, so you should feel free to use contractions (e.g., "don't", "can't", "shouldn't") if you prefer.</p> - -<h3 id="Pluralization">Pluralization</h3> - -<p>Use English-style plurals, not the Latin- or Greek-influenced forms.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: syllabuses, octopuses</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: syllabi, octopi</li> -</ul> - -<h3 id="Hyphenation">Hyphenation</h3> - -<p>Hyphenate compounds when the last letter of the prefix is a vowel and is the same as the first letter of the root.</p> - -<ul> - <li><font color="green"><strong>Correct</strong></font>: email, re-elect, co-op</li> - <li><font color="red"><strong>Incorrect</strong></font>: e-mail, reelect, coop</li> -</ul> - -<h3 id="Gender-neutral_language">Gender-neutral language</h3> - -<p>It is a good idea to use gender-neutral language in any writing where gender is irrelevant to the subject matter, to make the text as inclusive as possible. So for example, if you are talking about the actions of a specific man, usage of he/his would be fine, but if the subject is a person of either gender, he/his isn't appropriate.<br> - <br> - Let's take the following example:</p> - -<blockquote> -<p>A confirmation dialog appears, asking the user if he allows the Web page to make use of his Web cam.</p> -</blockquote> - -<blockquote> -<p>A confirmation dialog appears, asking the user if she allows the Web page to make use of her Web cam.</p> -</blockquote> - -<p>Both versions are gender-specific. To fix this, use gender-neutral pronouns:</p> - -<blockquote> -<p>A confirmation dialog appears, asking the user if they allow the Web page to make use of their Web cam.</p> -</blockquote> - -<div class="note"> -<p>MDN allows the use of this very common syntax (which is controversial among usage authorities), to make up for the lack of a neutral gender in English. The use of the third-person plural as a gender neutral pronoun (that is, using "they," "them", "their," and "theirs") is an accepted practice, commonly known as "<a href="https://en.wikipedia.org/wiki/Singular_they">singular 'they.'</a>"</p> -</div> - -<p>You can use both genders:</p> - -<blockquote> -<p>A confirmation dialog appears, asking the user if he or she allows the web page to make use of his/her web cam.</p> -</blockquote> - -<p>making the users plural:</p> - -<blockquote> -<p>A confirmation dialog appears, asking the users if they allow the web page to make use of their web cams.</p> -</blockquote> - -<p>The best solution, of course, is to rewrite and eliminate the pronouns:</p> - -<blockquote> -<p>A confirmation dialog appears, requesting the user's permission for web cam access.</p> -</blockquote> - -<blockquote> -<p>A confirmation dialog box appears, which asks the user for permission to use the web cam.</p> -</blockquote> - -<p>The last way of dealing with the problem is arguably better, as it is not only grammatically more correct but removes some of the complexity associated with dealing with genders across different languages that may have wildly varying gender rules. This solution can make translation easier for both readers and localizers.</p> - -<h3 id="Numbers_and_numerals">Numbers and numerals</h3> - -<h4 id="Dates">Dates</h4> - -<p>For dates (not including dates in code samples) use the format "January 1, 1990".</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: February 24, 2006</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: February 24th, 2006; 24 February, 2006; 24/02/2006</li> -</ul> - -<p>Alternately, you can use the YYYY/MM/DD format.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: 2006/02/24</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: 02/24/2006; 24/02/2006; 02/24/06</li> -</ul> - -<h4 id="Decades">Decades</h4> - -<p>For decades, use the format "1990s". Don't use an apostrophe.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: 1990s</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: 1990's</li> -</ul> - -<h4 id="Plurals_of_numerals">Plurals of numerals</h4> - -<p>For plurals of numerals add "s". Don't use an apostrophe.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: 486s</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: 486's</li> -</ul> - -<h4 id="Commas">Commas</h4> - -<p>In running text, use commas only in five-digit and larger numbers.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: 4000; 54,000</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: 4,000; 54000</li> -</ul> - -<h3 id="Punctuation">Punctuation</h3> - -<h4 id="Serial_comma">Serial comma</h4> - -<p><strong>Use the serial comma</strong>. The serial (also known as "Oxford") comma is the comma that appears before the conjunction in a series of three or more items.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: I will travel on trains, planes, and automobiles.</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: I will travel on trains, planes and automobiles.</li> -</ul> - -<div class="note"> -<p>This is in contrast to the <a href="https://www.mozilla.org/en-US/styleguide/" title="https://mozilla-l10n.github.io/styleguides/uk/">One Mozilla style guide</a>, which specifies that the serial comma is not to be used. MDN is an exception to this rule.</p> -</div> - -<h3 id="Spelling">Spelling</h3> - -<p>For words with variant spellings, always use their American English spelling. In general, use the first entry at <a href="http://www.dictionary.com/">Dictionary.com</a>, unless that entry is listed as a variant spelling or as being primarily used in a non-American form of English; for example, if you <a href="http://dictionary.reference.com/browse/honour">look up "honour"</a>, you find the phrase "Chiefly British" followed by a link to the American standard form, "<a href="http://dictionary.reference.com/browse/honor">honor</a>". Do not use variant spellings.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: localize, honor</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: localise, honour</li> -</ul> - -<h3 id="Terminology">Terminology</h3> - -<dl> -</dl> - -<h4 id="HTML_elements">HTML elements</h4> - -<p>Use "elements" to refer to HTML and XML elements, rather than "tags". In addition, they should almost always be wrapped in "<>", and should be in the {{HTMLElement("code")}} style. When you reference a given element for the first time in a section, you should use the {{TemplateLink("HTMLElement")}} macro to create a link to the documentation for the element (unless you're writing within that element's reference document page).</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: the {{HTMLElement("span")}} element</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: the span tag</li> -</ul> - -<h4 id="Parameters_vs._arguments">Parameters vs. arguments</h4> - -<p>The preferred term on MDN is <strong>parameters</strong>. Please avoid the term "arguments" for consistency if at all possible.</p> - -<h4 id="User_interface_actions">User interface actions</h4> - -<p>In task sequences, describe user interface actions using the imperative mood. Identify the user interface element by its label and type.</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: Click the Edit button.</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: Click Edit.</li> -</ul> - -<h3 id="Voice">Voice</h3> - -<p>While the active voice is preferred, the passive voice is also acceptable, given the informal feel of our content. Try to be consistent, though.</p> - -<h2 id="Wiki_markup_and_usage">Wiki markup and usage</h2> - -<h3 id="Links">Links</h3> - -<p>Links are a large part of what makes a wiki a powerful learning and teaching tool. Below you'll find some basic information, but you can find a complete guide to <a href="/uk/docs/MDN/Contribute/Editor/Links">creating and editing links on MDN</a> in our editor guide.</p> - -<p>We encourage you to create appropriate links among articles; they help improve navigation and discoverability of content. You can easily create links not only among pages on MDN (internal links) but also to pages outside MDN (external links).</p> - -<p>There are two ways to create links: you explicitly create a link using the Link button in the editor's toolbar—or by pressing <kbd>Ctrl</kbd>+<kbd>K</kbd> (<kbd>Cmd</kbd>-<kbd>K</kbd> on the Mac)—or you can use MDN's powerful macro system to generate links automatically or based on an input value.</p> - -<p>When deciding what text to use as a link, there are a few guidelines you can follow:</p> - -<ul> - <li>Whenever a macro exists which will create the link you need, and you are able to do so, please do. <a href="/uk/docs/MDN/Contribute/Editor/Links#Using_link_macros">Using macros to create links</a> will not only help you get it right, but will allow future improvements to MDN to automatically be applied to your link.</li> - <li>For an API name, use the entire string of the API term as written in your content. The easiest way to do this is to <a href="/uk/docs/MDN/Contribute/Editor/Links#Linking_to_documentation_for_APIs">use the appropriate macro</a> to construct a properly-formatted link for you.</li> - <li>For a term for which you're linking to a page defining or discussing that term, use the name of the term and no additional text as the link's text. For example: - <ul> - <li><span class="correct"><strong>Correct</strong></span>: You can use <a href="/uk/docs/Web/JavaScript">JavaScript</a> code to create dynamic applications on the Web.</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: You can use <a href="/uk/docs/Web/JavaScript">JavaScript code</a> to create dynamic applications on the Web.</li> - </ul> - </li> - <li>Otherwise, when adding a useful link to prose, try to choose an action and object phrase, such as: - <ul> - <li><span class="correct"><strong>Correct</strong></span>: If you'd like to <a href="/uk/docs/Mozilla/Developer_guide">contribute to the Firefox project</a>, your first step is to <a href="/uk/docs/Mozilla/Developer_guide/Build_Instructions">download and build Firefox</a>.</li> - <li><span class="incorrect"><strong>Incorrect</strong></span>: <a href="/uk/docs/Mozilla/Developer_guide">If you'd like to contribute to the Firefox project</a>, your first step is to <a href="/uk/docs/Mozilla/Developer_guide/Build_Instructions">download and build</a> Firefox.</li> - </ul> - </li> -</ul> - -<h4 id="URL_schemes">URL schemes</h4> - -<p>For security reasons, you should only create links that use the following schemes:</p> - -<ul> - <li><code>http://</code></li> - <li><code>https://</code></li> - <li><code>ftp://</code></li> - <li><code>mailto:</code></li> -</ul> - -<p>Others may or may not work, but are not supported and will probably be removed by editorial staff.</p> - -<div class="note"> -<p>In particular, be sure not to use the <code>about:</code> or <code>chrome://</code> schemes, as they will not work. Similarly, the <code>javascript:</code> scheme is blocked by most modern browsers, as is <code>jar:</code>.</p> -</div> - -<h3 id="Page_tags">Page tags</h3> - -<p>Tags provide meta information about a page and/or indicate that a page has specific improvements needed to its content. Every page in the wiki should have tags. You can find details on tagging in our <a href="/uk/docs/MDN/Contribute/Howto/Tag">How to properly tag pages</a> guide.</p> - -<p>The tagging interface lives at the bottom of a page while you're in edit mode, and looks something like this:</p> - -<p><img alt="Screenshot of the UX for adding and removing tags on MDN" src="https://mdn.mozillademos.org/files/7859/tag-interface.png" style="border-style: solid; border-width: 1px; height: 167px; width: 863px;"></p> - -<p>To add a tag, click in the edit box at the end of the tag list and type the tag name you wish to add. Tags will autocomplete as you type. Press enter (or return) to submit the new tag. Each article may have as many tags as needed. For example, an article about using JavaScript in AJAX programming might have both "JavaScript" and "AJAX" as tags.</p> - -<p>To remove a tag, just click the little "X" icon in the tag.</p> - -<h4 id="Tagging_pages_that_need_work">Tagging pages that need work</h4> - -<p>In addition to using tags to track information about the documentation's quality and content, we also use them to mark articles as needing specific types of work.</p> - -<h4 id="Tagging_obsolete_pages">Tagging obsolete pages</h4> - -<p>Use the following tags for pages that are not current:</p> - -<ul> - <li><em>Junk</em>: Use for spam, pages created by mistake, or content that is so bad that it should be deleted. Pages with this tag are deleted from time to time.</li> - <li><em>Obsolete</em>: Use for content that is technically superseded, but still valid in context. For example an HTML element that is obsolete in HTML5 is still valid in HTML 4.01. You can also use the <span class="nowiki">{{TemplateLink("obsolete_header")}}</span> macro to put a prominent banner on the topic.</li> - <li><em>Archive</em>: Use for content that is technically superseded and no longer useful. If possible, add a note to the topic referring readers to a more current topic. For example, a page that describes how to use the Mozilla CVS repository should refer readers to a current topic on using Mercurial repos. (If no corresponding current topic exists, use the <em>NeedsUpdate</em> tag, and add an explanation on the Talk page.) Pages with the Archive tag are eventually moved from the main content of MDN to the <a href="/uk/docs/Archive">Archive</a> section.</li> -</ul> - -<h3 id="SEO_summary">SEO summary</h3> - -<p>The SEO summary provides a short description of a page. It will be reported as a summary of the article to robots crawling the site, and will then appear in search results for the page. It is also used by macros that automate the construction of landing pages inside MDN itself.</p> - -<p>By default, the first paragraph of the page is used as the SEO summary. However, you can override this behavior by marking a section with the <a href="/uk/docs/MDN/Contribute/Editor/Basics">"SEO summary" style in the WYSIWYG editor</a>.</p> - -<h3 id="Landing_pages">Landing pages</h3> - -<p><strong>Landing pages</strong> are pages at the root of a topic area of the site, such as the main <a href="/uk/docs/Web/CSS" title="CSS">CSS</a> or <a href="/uk/docs/Web/HTML" title="HTML">HTML</a> pages. They have a standard format that consists of three areas:</p> - -<ol> - <li>A brief (typically one paragraph) overview of what the technology is and how it's used. See {{anch("Writing a landing page overview")}} for tips.</li> - <li>A two-column list of links with appropriate headings. See {{anch("Creating a page link list")}} for guidelines.</li> - <li>An <strong>optional</strong> "Browser compatibility" section at the bottom of the page.</li> -</ol> - -<h4 id="Creating_a_page_link_list">Creating a page link list</h4> - -<p>The link list section of an MDN landing page consists of two columns. These are created using the following HTML:</p> - -<pre class="brush: html notranslate"><div class="row topicpage-table"> - <div class="section"> - ... left column contents ... - </div> - <div class="section"> - ... right column contents ... - </div> -</div></pre> - -<p>The left column should be a list of articles, with an <code><h2></code> header at the top of the left column explaining that it's a list of articles about the topic (e.g., "Documentation and tutorials about foo"); this header should use the CSS class "Documentation". Below that is a <code><dl></code> list of articles with each article's link in a <code><dt></code> block and a brief one-or-two sentence summary of the article in the corresponding <code><dd></code> block.</p> - -<p>The right column should contain one or more of the following sections, in order:</p> - -<dl> - <dt>Getting help from the community</dt> - <dd>This should provide information on Matrix chat rooms and mailing lists available on the topic. The heading should use the class "Community".</dd> - <dt>Tools</dt> - <dd>A list of tools the user can look at to help with the use of the technology described in this section of MDN. The heading should use the class "Tools".</dd> - <dt>Related topics</dt> - <dd>A list of links to landing pages for other, related, technologies of relevance. The heading should use the class "Related_Topics".</dd> -</dl> - -<p><strong><<<finish this once we finalize the landing page standards>>></strong></p> - -<h2 id="Using_inserting_images">Using, inserting images</h2> - -<p>It's sometimes helpful to provide an image in an article you create or modify, especially if the article is very technical. To include an image:</p> - -<ol> - <li>Attach the desired image file to the article (at the bottom of every article in edit mode)</li> - <li>Create an image in the WYSIWYG editor</li> - <li>In the WYSIWYG editor, in the drop-down list of attachments, select the newly created attachment that is your image</li> - <li>Press OK.</li> -</ol> - -<h2 id="Other_references">Other references</h2> - -<h3 id="Preferred_style_guides">Preferred style guides</h3> - -<p>If you have questions about usage and style not covered here, we recommend referring to the <a href="http://www.economist.com/styleguide/introduction">Economist style guide</a> or, failing that, the <a href="https://www.amazon.com/Chicago-Manual-Style-16th/dp/0226104206">Chicago Manual of Style</a>.</p> - -<h3 id="Preferred_dictionary">Preferred dictionary</h3> - -<p>For questions of spelling, please refer to <a href="http://www.dictionary.com/">Dictionary.com</a>. The spelling checker for this site uses American English. Please do not use variant spellings (e.g., use <em>color</em> rather than <em>colour</em>).</p> - -<p>We will be expanding the guide over time, so if you have specific questions that aren't covered in this document, please send them to the <a href="/uk/docs/MDN/Community">MDC mailing list</a> or <a href="/uk/docs/User:Sheppy" title="User:Sheppy">project lead</a> so we know what should be added.</p> - -<h3 id="MDN-specific">MDN-specific</h3> - -<ul> - <li><a href="/uk/docs/MDN/Contribute/Structures/Шаблони/Загальновживані_шаблони">Commonly-used macros</a> on MDN, with explanations.</li> -</ul> - -<h3 id="Лексика_граматика_й_правопис">Лексика, граматика й правопис</h3> - -<p>If you're interested in improving your writing and editing skills, you may find the following resources to be helpful.</p> - -<ul> - <li><a href="http://www.amazon.com/Writing-Well-30th-Anniversary-Nonfiction/dp/0060891548">On Writing Well</a>, by William Zinsser (Amazon link)</li> - <li><a href="http://www.amazon.com/Style-Basics-Clarity-Grace-4th/dp/0205830765/" title="http://www.amazon.com/Style-Lessons-Clarity-Grace-Edition/dp/0321898680">Style: The Basics of Clarity and Grace</a>, by Joseph Williams and Gregory Colomb (Amazon link)</li> - <li><a href="https://brians.wsu.edu/common-errors-in-english-usage/">Common Errors in English</a></li> - <li><a href="http://www-personal.umich.edu/~jlawler/aue.html">English Grammar FAQ</a> (alt.usage.english)</li> - <li><a href="http://www.angryflower.com/bobsqu.gif">Bob's quick guide to the apostrophe, you idiots</a> (funny)</li> - <li><a href="http://www.amazon.com/Merriam-Websters-Concise-Dictionary-English-Usage/dp/B004L2KNI2" title="http://www.amazon.com/Merriam-Websters-Concise-Dictionary-English-Usage/dp/B004L2KNI2">Merriam-Webster's Concise Dictionary of English Usage</a> (Amazon link): Scholarly but user-friendly, evidence-based advice; very good for non-native speakers, especially for preposition usage.</li> - <li><a href="http://english.stackexchange.com/">English Language and Usage StackExchange</a>: Question and answer site for English language usage.</li> -</ul> diff --git a/files/uk/mdn/index.html b/files/uk/mdn/index.html deleted file mode 100644 index 0381c1bf31..0000000000 --- a/files/uk/mdn/index.html +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Проект MDN -slug: MDN -tags: - - Landing - - MDN Meta -translation_of: MDN ---- -<div>{{MDNSidebar}}</div> - -<p><strong>Веб-документація MDN</strong> — це вікі, в якій ми описуємо відкритий Інтернет, технології Mozilla, Firefox OS та інші теми, присвячені веб-розробці. Будь-хто може взяти участь у створенні та редагуванні вмісту вікі. Геть не обов'язково бути програмістом або мати досконалі знання про описувані технології; є безліч різних завдань, від простих (коректура та виправлення помилок) до складних (написання документації з API).</p> - -<p class="summary">Мета проекту веб-документації MDN — надати <em>розробникам інформацію</em> необхідну для <em>полегшення</em> створення проектів на <em>веб-платформі</em>. Ми запрошуємо вас допомогти нам!</p> - -<p>Нам потрібна ваша допомога! Це легко. Вам не потрібно просити дозволу чи боятися зробити помилку. Проте, ознайомтеся зі <a href="/uk/docs/MDN/Community">спільнотою MDN</a>; ми тут, щоб допомогти вам! Наведена нижче інформація допоможе вам розпочати.</p> - -<ul class="card-grid"> - <li><span><a href="/uk/docs/MDN/з_чого_почати">Швидкий старт для новачків</a></span> - - <p>Вперше натрапили на MDN і бажаєте дізнатися, як зробити її ще краще? Почніть звідси!</p> - </li> - <li><span><a href="/uk/docs/MDN/Contribute">Я впевнений користувач</a></span> - <p>Доступ до нашого повного й детального посібника для учасників спільноти.</p> - </li> - <li><span><a class="new" href="/uk/docs/MDN/Promote" rel="nofollow">Розповісти іншим</a></span> - <p>Якщо вам подобається MDN, допоможіть нам популяризувати його! Отримайте матеріали, інструменти та посібники для просування MDN.</p> - </li> -</ul> diff --git a/files/uk/mdn/structures/index.html b/files/uk/mdn/structures/index.html deleted file mode 100644 index 021aba74ea..0000000000 --- a/files/uk/mdn/structures/index.html +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Документові структури -slug: MDN/Structures -tags: - - Landing - - MDN Meta - - Structures -translation_of: MDN/Structures ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<p>На сторінках MDN можна знайти чимало різних повторюваних структур, що призначені для послідовного й упорядкованого викладення інформації у статтях MDN. Тут наведено статті, що описують ці структури, тож ви, як автор MDN, можете їх впізнавати, вживати й змінювати відповідним чином для документів, які ви створюєте, редагуєте чи перекладаєте.</p> - -<p>{{LandingPageListSubPages()}}</p> diff --git a/files/uk/mdn/structures/macros/commonly-used_macros/index.html b/files/uk/mdn/structures/macros/commonly-used_macros/index.html deleted file mode 100644 index 1a9ebb10c0..0000000000 --- a/files/uk/mdn/structures/macros/commonly-used_macros/index.html +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: Загальновживані шаблони -slug: MDN/Structures/Macros/Commonly-used_macros -tags: - - Structures - - Довідка - - Макрос -translation_of: MDN/Structures/Macros/Commonly-used_macros -original_slug: MDN/Structures/Шаблони/Загальновживані_шаблони ---- -<div>{{MDNSidebar}}</div> - -<div></div> - -<p><span class="seoSummary">На цій сторінці подано багато макросів загального призначення, які створені для використання на платформі MDN. Інформацію про використання цих макросів дивіться в розділі<a href="/en-US/docs/MDN/Contribute/Content/Macros"> Використання макросів</a>, а також <a href="/en-US/docs/MDN/Contribute/Editor/Links#Using_link_macros">Використання посилань макросів</a>.</span> Подивіться <a href="/en-US/docs/MDN/Contribute/Structures/Macros/Other">Інші макроси</a> для інформації про макроси, які рідко використовуються, використовуються тільки в особливих контекстах або важаються застарілими. Також є <a href="https://wiki.developer.mozilla.org/en-US/dashboards/macros">повний список всіх макросів для MDN</a>. </p> - -<p>Див. також <a href="/en-US/docs/MDN/Contribute/Guidelines/CSS_style_guide">CSS посібник стилів</a> для стилів, які можуть бути доступні для вашого використання.</p> - -<h2 id="Посилання">Посилання</h2> - -<h3 id="Створення_єдиного_гіперпосилання">Створення єдиного гіперпосилання</h3> - -<p id="To_another_MDN_page_or_its_section_(anch_SectionOnPage_manch_Link_LinkItem_LinkItemDL)">Зазвичай немає необхідності використовувати макроси для створення посилань довільної форми. Для створення посилань використовуйте кнопку <strong>Link </strong>(Вставити / Редагувати посилання)<strong> </strong>в інтерфейсі редактора.</p> - -<ul> - <li>{{TemplateLink("Glossary")}} макрос створює посилання на запис зазначеного об'єкта в MDN <a href="https://wiki.developer.mozilla.org/en-US/docs/Glossary">glossary</a>. Даний макрос приймає один обов'язковий і два додаткових параметри: - - <ol> - <li>Ім'я параметра (наприклад, "HTML").</li> - <li>Текст для відображення в замість назви параметру (використовується рідко). {{optional_inline}}</li> - <li>Коли цей параметр вказаний і є ненульовим, то традиційний стиль, зазвичай вживаний до посилань на глосарій, не застосовується. {{optional_inline}}</li> - </ol> - - <ul> - <li><code>\{{Glossary("HTML")}}</code> вихід {{Glossary("HTML")}}</li> - <li><code>\{{Glossary("CSS", "Cascading Style Sheets")}}</code> вихід {{Glossary("CSS", "Cascading Style Sheets")}}</li> - <li><code>\{{Glossary("HTML", "", 1)}}</code> вихід {{Glossary("HTML", "", 1)}}</li> - </ul> - </li> - <li>{{TemplateLink("anch")}} - створює посилання на внутрішній розділ сторінки: - <ul> - <li><code>\{{anch("Посилання на сторінки в довідках")}}</code>; </li> - </ul> - </li> -</ul> - -<h3 id="Посилання_на_сторінки_в_довіднику">Посилання на сторінки в довіднику</h3> - -<p>Існують різноманітні макроси для з'єднання зі сторінками в певних довідкових областях MDN.</p> - -<ul> - <li>{{TemplateLink("cssxref")}} посилання на сторінку у <a href="/en-US/docs/CSS_Reference" title="en-US/docs/CSS_Reference">CSS Довіднику</a>.<br> - Наприклад: <code>\{{cssxref("cursor")}}</code>, приведе в: {{ cssxref("cursor") }}.</li> - <li>{{TemplateLink("domxref")}} посилання на сторінки в документації DOM; якщо ви додасте круглі дужки в наприкінці, шаблон буде знати, що посилання виглядає як ім'я функції. наприклад, <span class="plain"><span class="nowiki">\{{domxref("document.getElementsByName()")}}</span></span> приведе в: {{ domxref("document.getElementsByName()") }} тим часом як <code>\{\{domxref("Node")\}\}</code> приведе в: {{ domxref("Node") }}.</li> - <li>{{TemplateLink("event")}} посилання на сторінки в довіднику про події DOM, наприклад: \{{event("change")}} приведе в: {{event("change")}}.</li> - <li>{{TemplateLink("HTMLElement")}} посилання на елемент HTML в довіднику HTML.</li> - <li>{{TemplateLink("htmlattrxref")}} посилання на HTML атрибут, або глобальне опис атрибута, якщо Ви вказуєте тільки ім'я атрибута або атрибут пов'язаний з певним елементом, якщо Ви вказуєте ім'я атрибута і ім'я елемента. Наприклад, <code>\{\{htmlattrxref("lang")\}\} </code>створить це посилання: {{htmlattrxref("lang")}}.<code> </code> <code>\{\{htmlattrxref("type","input")\}\}</code> створить це посилання: {{htmlattrxref("type","input")}}.</li> - <li>{{TemplateLink("jsxref")}} посилання на сторінку в <a href="https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript/Reference" title="en-US/docs/Web/JavaScript/Reference">JavaScript довыднику</a>.</li> - <li>{{TemplateLink("SVGAttr")}} посилання на певний атрибут SVG. Наприклад, <code>\{\{SVGAttr("d")\}\}</code> створює цей зв'язок: {{SVGAttr("d")}}.</li> - <li>{{TemplateLink("SVGElement")}} посилання на елемент SVG в довіднику SVG.</li> - <li>{{TemplateLink("HTTPHeader")}} посилання на <a href="/en-US/docs/Web/HTTP/Headers">HTTP заголовок</a>.</li> - <li>{{TemplateLink("HTTPMethod")}} посилання на <a href="/en-US/docs/Web/HTTP/Methods">HTTP метод запиту</a>.</li> - <li>{{TemplateLink("HTTPStatus")}} посилання на <a href="/en-US/docs/Web/HTTP/Status">HTTP код статусу відповіді</a>.</li> -</ul> - -<h3 id="Посилання_на_помилки_і_IRC">Посилання на помилки і IRC</h3> - -<ul> - <li>Помилки - <ul> - <li>{{TemplateLink("bug")}} дозволяє легко посилатися на помилку на bugzilla.mozilla.org, використовуючи цей синтаксис:<code>\{\{Bug(123456)\}\}</code>. Це дає Вам: {{ Bug(123456) }}.</li> - <li>{{TemplateLink("WebkitBug")}} вставляє посилання на помилку в базу даних помилок WebKit. Наприклад: <code>\{\{WebkitBug(31277)\}\}</code> додасть {{ WebkitBug(31277) }}.</li> - </ul> - </li> - <li>{{TemplateLink("IRCLink")}} вставляє посилання на вказаний канал IRC, в комплекті з підказкою, яка говорить що потрібен клієнт IRC.</li> -</ul> - -<h3 id="Навігаційні_інструменти_для_багатосторінкових_довідників">Навігаційні інструменти для багатосторінкових довідників</h3> - -<p>{{TemplateLink("Previous")}}, {{TemplateLink("Next")}}, або {{TemplateLink("PreviousNext")}} забезпечує управління навігацією для елементів, що входять в послідовність. Для односпрямованих шаблонів єдиним необхідним параметром є розташування wiki попередньої і наступної статті в послідовності. Для {{TemplateLink("PreviousNext")}}, два параметра, які потрібні, - це розташування відповідних статей в wiki-каталозі. Перший параметр відноситься до попередньої статті, а другий - до наступної.</p> - -<h2 id="Зразки_коду">Зразки коду</h2> - -<h3 id="Зразки_наживо">Зразки наживо</h3> - -<ul> - <li>{{TemplateLink("EmbedLiveSample")}} дозволяє вбудовувати вивід прикладу коду на сторінку, як це описано в <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">Зразки наживо</a>.</li> - <li>{{TemplateLink("LiveSampleLink")}}створює посилання на сторінку, яка містить висновок зразка коду на сторінку, як описано в розділі <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">Зразки наживо</a>.</li> -</ul> - -<h3 id="Файли_з_прикріпленими_прикладами">Файли з прикріпленими прикладами</h3> - -<ul> - <li>{{TemplateLink("Embed_text")}} шаблон дозволяє вставити приєднаний текстовий файл в тіло статті. Це корисно, якщо ви хочете мати фрагменти коду, які можна завантажити, але які також відображаються у вмісті статті. Ви можете додатково вказати мову підсвічування синтаксису; якщо ви його не вкажете, текст буде вставлений в неформатованому вигляді. Перший параметр - ім'я файлу який прикріплений; другий, якщо він передбачений, - мова для застосування синтаксичного маркера, такий як "javascript", "svg" або "cpp".</li> - <li>{{TemplateLink("EmbedSVG")}} вбудовує прикріплений XML-файл у вигляді зображення SVG на відповідному місці на сторінці. Вкажіть ім'я прикріпленого SVG-файлу. Ви можете використовувати це в комплексі з {{TemplateLink("Embed_text")}} щоб показати джерело, а потім відобразити вивід того ж файлу.</li> -</ul> - -<h2 id="Створення_бічної_панелі">Створення бічної панелі</h2> - -<p>Існують шаблони практично для кожної великої бібліотеки сторінок. Зазвичай вони посилаються на головну сторінку довідника / керівництва / підручника (це часто необхідно, тому що наші хлібні крихти іноді не можуть цього зробити) і поміщають статтю в відповідну категорію.</p> - -<ul> - <li>{{TemplateLink("CSSRef")}} створює бічну панель для довідкових сторінок CSS.</li> - <li>{{TemplateLink("HTMLRef")}} створює бічну панель для довідкових сторінок HTML.</li> - <li>{{TemplateLink("APIRef")}} створює бічну панель для довідкових сторінок Web API.</li> -</ul> - -<h2 id="Загальне_форматування">Загальне форматування</h2> - -<h3 id="Вбудовані_індикатори_для_документації_API">Вбудовані індикатори для документації API</h3> - -<p>{{TemplateLink("optional_inline")}} та {{TemplateLink("ReadOnlyInline")}} використовуються в документації API, зазвичай при описі списку властивостей об'єкта або параметрів функції.</p> - -<p>Використання: <code>\{{optional_inline()}}</code> або <code>\{{ReadOnlyInline()}}</code>. Наприклад: </p> - -<dl> - <dt><code>isCustomObject</code> {{ReadOnlyInline()}}</dt> - <dd>Вказує, якщо <code>true</code>, що об'єкт є призначеним для користувача.</dd> - <dt>parameterX {{ optional_inline() }}</dt> - <dd>Бла-бла-бла...</dd> -</dl> - -<h2 id="Позначки_про_статус_та_сумісність">Позначки про статус та сумісність</h2> - -<h3 id="Вбудовані_індикатори_без_додаткових_параметрів">Вбудовані індикатори без додаткових параметрів</h3> - -<h4 id="Нетипові">Нетипові</h4> - -<p>{{TemplateLink("non-standard_inline")}} вставляє в рядок мітку, яка вказує на те, що API ні стандартизований і не перебуває на стандартній платформі.</p> - -<h5 id="Синтаксис"><strong>Синтаксис</strong></h5> - -<p><code>\{{non-standard_inline}}</code></p> - -<h5 id="Приклади">Приклади</h5> - -<ul> - <li>Іконка: {{non-standard_inline}}</li> -</ul> - -<h4 id="Експериментальний">Експериментальний</h4> - -<p>{{TemplateLink("experimental_inline")}} вставляє позначку в рядку, що вказує на те, що API застосовується недостатньо широко і може змінитися в майбутньому.</p> - -<h5 id="Синтаксис_2"><strong>Синтаксис</strong></h5> - -<p><code>\{{Experimental_Inline}}</code></p> - -<h5 id="Приклади_2">Приклади</h5> - -<ul> - <li>Іконка: {{Experimental_Inline}}</li> -</ul> - -<h3 id="Вбудовані_індикатори_що_підтримують_вказівку_технології">Вбудовані індикатори, що підтримують вказівку технології</h3> - -<p>У таких макросах параметром (при зазначенні) повинен бути будь-який з рядків "html", "js", "css" або "gecko" з подальшим номером версії.</p> - -<h4 id="Вилучені_елементи">Вилучені елементи</h4> - -<p>{{TemplateLink("deprecated_inline")}} поміщає в рядок маркування вилучений, щоб запобігти використанню офіційно застарілого API. <strong>Зауваження</strong><strong>:</strong> "Deprecated" означає, що елемент більше не повинен використовуватися, але все одно повинен функціонувати. Якщо ви маєте на увазі, що він більше не працює, використовуйте термін "obsolete."</p> - -<p>Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</p> - -<h5 id="Синтаксис_3"><strong>Синтаксис</strong></h5> - -<p><code>\{{deprecated_inline}}</code> or<code> \{{deprecated_inline("gecko5")}}</code></p> - -<h5 id="Приклади_3">Приклади</h5> - -<ul> - <li>Іконка: {{deprecated_inline}}</li> - <li>Значок: {{deprecated_inline("gecko5")}}</li> -</ul> - -<h4 id="Застарілі_елементи">Застарілі елементи</h4> - -<p>{{TemplateLink("obsolete_inline")}} поміщає в рядок маркування застарілий, щоб запобігти використанню, наприклад, функції, методу чи властивості, які офіційно застаріли.</p> - -<p>Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</p> - -<h5 id="Синтаксис_4"><strong>Синтаксис</strong></h5> - -<p><code>\{{obsolete_inline}}</code> or<code> \{{obsolete_inline("js1.8.5")}}</code></p> - -<h5 id="Приклади_4">Приклади</h5> - -<ul> - <li>Іконка: {{obsolete_inline}}</li> - <li>Значок: {{obsolete_inline("js1.8.5")}}</li> -</ul> - -<h3 id="Шаблонні_значки">Шаблонні значки</h3> - -<p>Ці макроси в переважно застосовуються на <a href="/en-US/docs/WebAPI">WebAPI</a> сторінках. Перегляньте {{anch("Creating new badges")}} для інформації про створення нового значка.</p> - -<h3 id="Індикатори_заголовків_сторінок_або_розділів">Індикатори заголовків сторінок або розділів</h3> - -<p>Ці шаблони мають ту ж семантику, що і їх вбудовані аналоги, описані вище. Шаблони повинні бути розміщені безпосередньо під заголовком головної сторінки або під навігатором по хлібним крихтам, якщо такий доступен, на сторінці лінків. Вони також можуть бути використані для розмітки розділів на сторінці.</p> - -<ul> - <li>{{TemplateLink("non-standard_header")}}: <code>\{{Non-standard_header()}}</code> {{ Non-standard_header() }}</li> - <li>{{TemplateLink("SeeCompatTable")}} слід використовувати на сторінках, що містять розділ "Сумісність з браузером". Приклад: <code>\{{SeeCompatTable()}}</code> {{ SeeCompatTable() }}</li> - <li>{{TemplateLink("deprecated_header")}}: <code>\{{deprecated_header()}}</code> {{ Deprecated_header() }}</li> - <li>{{TemplateLink("deprecated_header")}} з параметром:<code>\{{deprecated_header("gecko5")}}</code> {{ Deprecated_header("gecko5") }} Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</li> - <li>{{TemplateLink("obsolete_header")}}: <code>\{{obsolete_header()}}</code> {{ Obsolete_header() }}</li> - <li>{{TemplateLink("obsolete_header")}} з параметром: <code>\{{obsolete_header("gecko30")}}</code> {{ Obsolete_header("gecko30") }} Не використовуйте параметр в будь-якій незалежній від браузера області (HTML, API, JS, CSS, ...).</li> -</ul> - -<h3 id="Зазначення_того_що_функція_доступна_у_web_workers">Зазначення того, що функція доступна у web workers</h3> - -<p>The {{TemplateLink("AvailableInWorkers")}} макрос вставляє відповідне поле для приміток, що вказує на те, що функція є доступною у <a href="/en-US/docs/Web/API/Web_Workers_API">Web worker</a> контекст.</p> - -<ol> -</ol> - -<ol> -</ol> diff --git a/files/uk/mdn/structures/macros/index.html b/files/uk/mdn/structures/macros/index.html deleted file mode 100644 index 73ae20c1c9..0000000000 --- a/files/uk/mdn/structures/macros/index.html +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Шаблони -slug: MDN/Structures/Macros -tags: - - Kuma - - KumaScript - - MDN Meta - - Structures - - Путівник -translation_of: MDN/Structures/Macros -original_slug: MDN/Structures/Шаблони ---- -<div>{{MDNSidebar}}</div><p><span class="seoSummary">Платформа <a href="/uk/docs/MDN/Kuma">Kuma</a>, що на ній працює MDN, має потужний механізм шаблонів (макросів), <a href="/uk/docs/MDN/Contribute/Tools/KumaScript">KumaScript</a>, який уможливлює автоматизацію чималої кількості речей. Ця сторінка надає інформацію про вжиток шаблонів MDN всередині статей.</span></p> - -<p><a href="/uk/docs/MDN/Contribute/Tools/KumaScript">Путівник з KumaScript</a> пропонує поглиблені знання з ужитку шаблонів на MDN, тож ця стаття є радше оглядовою.</p> - -<h2 id="Як_працюють_шаблони">Як працюють шаблони</h2> - -<p>Шаблони MDN написані мовою <a href="/uk/docs/Web/JavaScript">JavaScript</a> та виконуються у серверному середовищі <a href="https://nodejs.org/uk/">Node.js</a>. Задля уможливлення взаємодії шаблонів із вікі-платформою та її вмістом ми створили низку бібліотек, що надають відповідні можливості та служби. Як хочете дізнатись більше, зверніться до <a href="/uk/docs/MDN/Contribute/Tools/KumaScript">Путівника з KumaScript</a>.</p> - -<h2 id="Вжиток_шаблонів">Вжиток шаблонів</h2> - -<p>Власне для того, аби використати шаблон, ви просто оточуєте його ім'я разом із параметрами в круглих дужках (якщо є) парою подвійних фігурних дужок:</p> - -<pre class="notranslate">\{{macroname(перелік-параметрів)}}</pre> - -<p>Кілька зауважень щодо викликів шаблонів:</p> - -<ul> - <li>Імена шаблонів є регістронезалежними, тож <strong>Glossary</strong> й <strong>glossary</strong> не розрізняються;</li> - <li>Параметри відокремлюються комами;</li> - <li>За відсутності параметрів круглі дужки можна не вживати, тож <code>\{{macroname()}}</code> й <code>\{{macroname}}</code> є тотожними;</li> - <li>Числові параметри можна подавати в лапках чи ні, як подобається. Утім, якщо вам треба передати, наприклад, номер версії, що містить кілька розділових крапок, лапки обов'язкові;</li> - <li>Якщо ви отримали помилку, спершу перегляньте уважно свій код. Як знайти причину все ж не вдається, дивіться статтю <a href="/uk/docs/MDN/Contribute/Tools/KumaScript/Усунення_помилок_KumaScript">Усунення помилок KumaScript</a>.</li> -</ul> - -<p>Для шаблонів діє окремий кеш: для кожної множини вхідних даних (вказаних параметрів та значень з середовища, як-от адреса сторінки, де ужито шаблон) результат одноразово обчислюється та зберігається для подальшого використання. Отже шаблон насправді викликається лише тоді, коли змінюються вхідні дані.</p> - -<div class="note"> -<p><strong>Заувага</strong>: Ви можете здійснити примусове обчислення всіх шаблонів на сторінці, перезавантаживши сторінку у веб-переглядачі зі скиданням кешів (зазвичай <kbd>Ctrl</kbd> + <kbd>F5</kbd> або <kbd>Shift</kbd> + <kbd>F5</kbd>).</p> -</div> - -<p>Шаблони можуть бути як простими (наприклад, вставка великого шматка тексту чи залучення вмісту з іншої частини MDN), так і вельми складними (як-от пошук по різних частинах сайту й побудова цілого покажчика за знайденим вмістом із належним оформленням та додаванням посилань).</p> - -<p>Про найпоширеніші шаблони ви можете довідатись на сторінці <a href="/uk/docs/MDN/Contribute/Structures/Шаблони/Загальновживані_шаблони">Загальновживані шаблони</a>. Також є і <a href="/uk/docs/templates">повний їх перелік</a>. Багато шаблонів має вбудовану документацію (коментарі у коді на початку файлу).</p> - -<p>{{EditorGuideQuicklinks}}</p> diff --git a/files/uk/mdn/tools/index.html b/files/uk/mdn/tools/index.html deleted file mode 100644 index 9030b49d4d..0000000000 --- a/files/uk/mdn/tools/index.html +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: MDN tools -slug: MDN/Tools -tags: - - Landing - - MDN Meta - - NeedsTranslation - - TopicStub -translation_of: MDN/Tools ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> - -<p>MDN offers a number of features that make it easier to track progress, manage content, and keep up with the latest changes to the site.</p> - -<p>{{LandingPageListSubpages}}</p> diff --git a/files/uk/mdn/tools/kumascript/index.html b/files/uk/mdn/tools/kumascript/index.html deleted file mode 100644 index 5141e040b4..0000000000 --- a/files/uk/mdn/tools/kumascript/index.html +++ /dev/null @@ -1,500 +0,0 @@ ---- -title: KumaScript -slug: MDN/Tools/KumaScript -tags: - - Guide - - Kuma - - KumaScript - - MDN Meta - - NeedsContent - - NeedsTranslation - - Site-wide - - Tools - - TopicStub -translation_of: MDN/Tools/KumaScript ---- -<div>{{MDNSidebar}}</div><h2 id="Overview">Overview</h2> - -<p><span class="seoSummary">On the <a href="/en-US/docs/MDN/Kuma">Kuma</a> platform that powers MDN, the template system for automating aspects of content on the wiki is called <a class="link-https" href="https://github.com/mdn/kumascript" title="https://github.com/mdn/kumascript">KumaScript</a>. KumaScript is powered by server-side JavaScript, implemented using <a class="external" href="https://nodejs.org/en/" title="https://nodejs.org/en/">Node.js</a>.</span> This article provides basic information on how to use KumaScript.</p> - -<p>For a detailed overview and Q&A of KumaScript, watch the MDN dev team's <a href="https://vreplay.mozilla.com/replay/showRecordDetails.html?sortBy=date&viewCount=1&currentPage=1&groupBy=combo&roomFilter=&usernameFilter=&searchFilter=&usernameFullFilter=&myManager=-1&adminManager=0&webCast=0&command=&recId=1082&auxMessage=&auxMessage1=&lang=en&langChanged=&tenantFilter=&securityTab=">KumaScript Fireside Chat</a> (the meeting starts at 10 minutes into the video). KumaScript replaced DekiScript, which was the template language for MindTouch, the previous platform used by MDN.</p> - -<h3 id="What_is_KumaScript">What is KumaScript?</h3> - -<ul> - <li>A way to reuse and localize content that appears repeatedly between documents (e.g., compatibility labels, section navigation, warning banners).</li> - <li>A way to build documents out of content pulled from other documents.</li> - <li>A way to fetch and include content from other web sites and services (e.g., Bugzilla).</li> -</ul> - -<h3 id="What_KumaScript_is_not">What KumaScript is not</h3> - -<ul> - <li>KumaScript does not support interactive scripting of the kind that can accept form submissions.</li> - <li>KumaScript does not have access to a database, files, or any other way to store information persistently.</li> - <li>KumaScript does not support site personalization based on the user currently logged in.</li> - <li>KumaScript does not have access to user information, only to the content and metadata of a wiki page being viewed.</li> -</ul> - -<h2 id="Basics">Basics</h2> - -<p>KumaScript is used on MDN in <a class="link-https" href="https://github.com/visionmedia/ejs" title="https://github.com/visionmedia/ejs">embedded JavaScript templates</a>. These templates can be invoked in document content by any MDN author, through the use of macros.</p> - -<p>A script in KumaScript is a <em>template</em>, and each template is a file in <a href="https://github.com/mdn/kumascript/tree/master/macros">the macros directory of the KumaScript repository</a> on Github. A <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/hello.ejs" title="hello.ejs">template</a> looks like this:</p> - -<pre class="notranslate"><% for (var i = 0; i < $0; i++) { %> -Hello #<%= i %> -<% } %></pre> - -<p>Invoking a template is done with a <em>macro</em>, which can be used anywhere in any wiki content. A macro looks like this:</p> - -<pre class="notranslate">\{{ hello("3") }}</pre> - -<p>The output of the macro looks like this:</p> - -<pre class="notranslate">Hello #0 -Hello #1 -Hello #2</pre> - -<h3 id="Macro_syntax">Macro syntax</h3> - -<p>KumaScript templates are invoked in document content with macros, like this:</p> - -<pre class="notranslate">\{{ templateName("arg0", "arg1", ..., "argN") }} -</pre> - -<p>Macro syntax consists of these rules:</p> - -<ul> - <li>Macros start and end with <code>\{{</code> and <code>\}}</code> characters.</li> - <li>The first part of the macro is the name of a template. The lowercase value of this name should match the lowercase value of one of the filenames under <a href="https://github.com/mdn/kumascript/tree/master/macros">the macros directory of KumaScript</a>.</li> - <li>A template can accept parameters, and this parameter list starts and ends with parentheses.</li> - <li>All non-numeric parameters must be in quotes. Numbers can be left unquoted.</li> -</ul> - -<h4 id="Using_JSON_as_a_macro_parameter">Using JSON as a macro parameter</h4> - -<p>As a semi-experimental feature (not guaranteed to work), you can supply a JSON object for the first and only parameter, like so:</p> - -<pre class="notranslate">\{{ templateName({ "Alpha":"one", "Beta":["a","b","c"], "Foo":"http:\/\/mozilla.org\/" }) }} -</pre> - -<p>The data from this macro is available in template code as an object in the <code>$0</code> argument (e.g., <code>$0.Alpha</code>, <code>$0.Beta</code>, <code>$0.Foo</code>). This also allows you to express complex data structures in macro parameters that are hard or impossible to do with a simple list of parameters.</p> - -<p>Note that this parameter style is very picky — it must adhere to <a href="http://json.org/" title="http://json.org/">JSON syntax</a> exactly, which has some requirements about escaping characters that are easy to miss (e.g., all forward slashes are escaped). When in doubt, <a href="http://jsonlint.com/" title="http://jsonlint.com/">try running your JSON through a validator</a>.</p> - -<h4 id="How_to_write_in_text">How to write "\{{" in text</h4> - -<p>Since the character sequence "<code>\{{</code>" is used to indicate the start of a macro, this can be troublesome if you actually just want to use "<code>\{{</code>" and "<code>}}</code>" in a page. It will probably produce <code>DocumentParsingError</code> messages.</p> - -<p>In this case, you can escape the first brace with a backslash, like so: <code>\\{</code></p> - -<h3 id="Template_syntax">Template syntax</h3> - -<p>Each KumaScript template is a file under <a href="https://github.com/mdn/kumascript/tree/master/macros">the macros directory of KumaScript</a>. You create and edit these files as you would the files of any open-source project on GitHub (see <a href="https://github.com/mdn/kumascript">the KumaScript README</a> for more information).</p> - -<p>KumaScript templates are processed by an <a class="link-https" href="https://github.com/visionmedia/ejs" title="https://github.com/visionmedia/ejs">embedded JavaScript template engine</a> with a few simple rules:</p> - -<ul> - <li>Within a template, the parameters passed in from the macro are available as the variables <code>$0</code>, <code>$1</code>, <code>$2</code>, and so on. The entire list of parameters is also available in a template as the variable <code>arguments</code>.</li> - <li>Most text is treated as output and included in the output stream.</li> - <li>JavaScript variables and expressions can be inserted into the output stream with these blocks: - <ul> - <li><code><%= expr %></code> — the value of a JavaScript expression is escaped for HTML before being included in output (e.g., characters like <code><</code> and <code>></code> are turned into <code>&lt;</code> and <code>&gt;</code>).</li> - <li><code><%- expr %></code> — the value of a JavaScript expression is included in output without any escaping. (Use this if you want to dynamically build markup or use the results of another template that may include markup.)</li> - <li>It is an error to include semicolons inside these blocks.</li> - </ul> - </li> - <li>Anything inside a <code><% %></code> block is interpreted as JavaScript. This can include loops, conditionals, etc.</li> - <li>Nothing inside a <code><% %></code> block can ever contribute to the output stream. But, you can transition from JS mode to output mode using <code><% %></code>—for example: - <pre class="notranslate"><% for (var i = 0; i < $0; i++) { %> -Hello #<%= i %> -<% } %> -</pre> - - <p>Note how the JavaScript code is contained in <code><% ... %></code>, and output happens in the space between <code>%> ... <%</code>. The <code>for</code> loop in JS can begin with one <code><% %></code> block, transition to output mode, and finish up in a second <code><% %></code> JS block.</p> - </li> - <li>For more details on EJS syntax, <a class="link-https" href="https://github.com/visionmedia/ejs" title="https://github.com/visionmedia/ejs">check out the upstream module documentation</a>.</li> -</ul> - -<h3 id="Tips">Tips</h3> - -<p>You can see a list of macros and how they are used on MDN on the <a href="/en-US/dashboards/macros">macros dashboard</a>.</p> - -<h2 id="Advanced_Features">Advanced Features</h2> - -<p>Beyond the basics, the KumaScript system offers some advanced features.</p> - -<h3 id="Environment_variables">Environment variables</h3> - -<p>When the wiki makes a call to the KumaScript service, it passes along some context on the current document that KumaScript makes available to templates as variables:</p> - -<dl> - <dt><code>env.path</code></dt> - <dd>The path to the current wiki document</dd> - <dt><code>env.url</code></dt> - <dd>The full URL to the current wiki document</dd> - <dt><code>env.id</code></dt> - <dd>A short, unique ID for the current wiki document</dd> - <dt><code>env.files</code></dt> - <dd>An array of the files attached to the current wiki document; each object in the array is as described under {{ anch("File objects") }} below</dd> - <dt><code>env.review_tags</code></dt> - <dd>An array of the review tags on the article ("technical", "editorial", etc.)</dd> - <dt><code>env.locale</code></dt> - <dd>The locale of the current wiki document</dd> - <dt><code>env.title</code></dt> - <dd>The title of the current wiki document</dd> - <dt><code>env.slug</code></dt> - <dd>The URL slug of the current wiki document</dd> - <dt><code>env.tags</code></dt> - <dd>An array list of tag names for the current wiki document</dd> - <dt><code>env.modified</code></dt> - <dd>Last modified timestamp for the current wiki document</dd> - <dt><code>env.cache_control</code></dt> - <dd><code>Cache-Control</code> header sent in the request for the current wiki document, useful in deciding whether to invalidate caches</dd> -</dl> - -<h4 id="File_objects">File objects</h4> - -<p>Each file object has the following fields:</p> - -<dl> - <dt><code>title</code></dt> - <dd>The attachment's title</dd> - <dt><code>description</code></dt> - <dd>A textual description of the current revision of the file</dd> - <dt><code>filename</code></dt> - <dd>The file's name</dd> - <dt><code>size</code></dt> - <dd>The size of the file in bytes</dd> - <dt><code>author</code></dt> - <dd>The username of the person who uploaded the file</dd> - <dt><code>mime</code></dt> - <dd>The MIME type of the file</dd> - <dt><code>url</code></dt> - <dd>The URL at which the file can be found</dd> -</dl> - -<h4 id="Working_with_tag_lists">Working with tag lists</h4> - -<p>The <code>env.tags</code> and <code>env.review_tags</code> variables return arrays of tags. You can work with these in many ways, of course, but here are a couple of suggestions.</p> - -<h5 id="Looking_to_see_if_a_specific_tag_is_set">Looking to see if a specific tag is set</h5> - -<p>You can look to see if a specific tag exists on a page like this:</p> - -<pre class="brush: js notranslate">if (env.tags.indexOf("tag") != −1) { - // The page has the tag "tag" -} -</pre> - -<h5 id="Iterating_over_all_the_tags_on_a_page">Iterating over all the tags on a page</h5> - -<p>You can also iterate over all the tags on a page, like this:</p> - -<pre class="brush: js notranslate">env.tag.forEach(function(tag) { - // do whatever you need to do, such as: - if (tag.indexOf("a") == 0) { - // this tag starts with "a" - woohoo! - } -});</pre> - -<h3 id="APIs_and_Modules">APIs and Modules</h3> - -<p>KumaScript offers some built-in methods and APIs for KumaScript macros. Macros can also use <code>module.exports</code> to export new API methods.</p> - -<p>API changes require updating the KumaScript engine or macros via a pull request to the <a href="https://github.com/mdn/kumascript">KumaScript repository</a>.</p> - -<h4 id="Built-in_methods">Built-in methods</h4> - -<p>This manually-maintained documentation is likely to fall out of date with the code. With that in mind, <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/lib/kumascript/api.js#L175" title="https://github.com/mdn/kumascript/blob/master/lib/kumascript/api.js#L208">you can always check out the latest state of built-in APIs in the KumaScript source</a>. But here is a selection of useful methods exposed to templates:</p> - -<dl> - <dt><code>md5(string)</code></dt> - <dd>Returns an MD5 hex digest of the given string.</dd> - <dt><code>template("name", ["arg0", "arg1", ..., "argN"])</code></dt> - <dd>Executes and returns the result of the named template with the given list of parameters.</dd> - <dd>Example: <code><%- template("warning", ["foo", "bar", "baz"]) %></code>.</dd> - <dd>Example using the <code>domxref</code> macro: <code><%- template("domxref", ["Event.bubbles", "bubbles"]) %></code>.</dd> - <dd>This is a JavaScript function. So, if one of the parameters is an arg variable like $2, do not put it in quotes. Like this: <code><%- template("warning", [$1, $2, "baz"]) %></code>. If you need to call another template from within a block of code, do not use <code><%</code> ... <code>%></code>. Example: <code>myvar = "<li>" + template("LXRSearch", ["ident", "i", $1]) + "</li>";</code></dd> - <dt><code>require(name)</code></dt> - <dd>Loads another template as a module; any output is ignored. Anything assigned to <code>module.exports</code> in the template is returned.</dd> - <dd>Used in templates like so: <code><% var my_module = require('MyModule'); %></code>.</dd> - <dt><code>cacheFn(key, timeout, function_to_cache)</code></dt> - <dd>Using the given key and cache entry lifetime, cache the results of the given function. Honors the value of <code>env.cache_control</code> to invalidate cache on <code>no-cache</code>, which can be sent by a logged-in user hitting shift-refresh.</dd> - <dt><code>request</code></dt> - <dd>Access to <a class="link-https" href="https://github.com/mikeal/request" title="https://github.com/mikeal/request"><code>mikeal/request</code></a>, a library for making HTTP requests. Using this module in KumaScript templates is not yet very friendly, so you may want to wrap usage in module APIs that simplify things.</dd> - <dt><code>log.debug(string)</code></dt> - <dd>Outputs a debug message into the script log on the page (i.e. the big red box that usually displays errors).</dd> -</dl> - -<h4 id="Built-in_API_modules">Built-in API modules</h4> - -<p>There's only one API built in at the moment, in the <code>kuma</code> namespace. You can see the most up to date list of methods under <code>kuma</code> from <a href="https://github.com/mdn/kumascript/blob/master/lib/kumascript/api.js#L74">the KumaScript source code</a>, but here are a few:</p> - -<dl> - <dt><code>kuma.inspect(object)</code></dt> - <dd>Renders any JS object as a string, handy for use with <code>log.debug()</code>. See also: <a href="http://nodejs.org/api/util.html#util_util_inspect_object_options">node.js <code>util.inspect()</code></a>.</dd> -</dl> - -<dl> - <dt><code>kuma.htmlEscape(string)</code></dt> - <dd>Escapes the characters <code>&, <, >, "</code> to <code>&amp, &lt;, &gt;, &quot;</code>, respectively.</dd> - <dt><code>kuma.url</code></dt> - <dd>See also: <a href="http://nodejs.org/api/url.html">node.js <code>url</code> module</a>.</dd> - <dt><code>kuma.fetchFeed(url)</code></dt> - <dd>Fetch an RSS feed and parse it into a JS object. See also: <a href="https://github.com/mdn/kumascript/blob/master/macros/InsertFeedLinkList.ejs"><code>InsertFeedLinkList</code></a></dd> -</dl> - -<h4 id="Creating_modules">Creating modules</h4> - -<p>Using the built-in <code>require()</code> method, you can load a template as a module to share common variables and methods between templates. A module can be defined in a template like this:</p> - -<pre class="notranslate"><% -module.exports = { - add: function (a, b) { - return a + b; - } -} -%> -</pre> - -<p>Assuming this template is saved under <a href="https://github.com/mdn/kumascript/tree/master/macros">https://github.com/mdn/kumascript/tree/master/macros</a> as <code>MathLib.ejs</code>, you can use it in another template like so:</p> - -<pre class="notranslate"><% -var math_lib = require("MathLib"); -%> -The result of 2 + 2 = <%= math_lib.add(2, 2) %> -</pre> - -<p>And, the output of this template will be:</p> - -<pre class="notranslate">The result of 2 + 2 = 4 -</pre> - -<h4 id="Auto-loaded_modules">Auto-loaded modules</h4> - -<p>There are a set of modules editable as wiki templates that are automatically loaded and made available to every template. This set is defined in the configuration file for the KumaScript service - any changes to this requires an IT bug to edit configuration and a restart of the service.</p> - -<p>For the most part, these attempt to provide stand-ins for legacy DekiScript features to ease template migration. But, going forward, these can be used to share common variables and methods between templates:</p> - -<ul> - <li><code>mdn.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/MDN-Common.ejs" title="MDN:Common">MDN-Common</a></li> - <li><code>Page.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Page.ejs" title="DekiScript:Page">DekiScript-Page</a></li> - <li><code>String.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-String.ejs" title="DekiScript:String">DekiScript-String</a></li> - <li><code>Uri.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Uri.ejs" title="DekiScript:Uri">DekiScript-Uri</a></li> - <li><code>Web.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Web.ejs" title="DekiScript:Web">DekiScript-Web</a></li> - <li><code>Wiki.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Wiki.ejs" title="DekiScript:Wiki">DekiScript-Wiki</a></li> -</ul> - -<p><strong>Note:</strong> You might notice that the DekiScript modules use a built-in method named <code>buildAPI()</code>, like so:</p> - -<pre class="notranslate"><% module.exports = buildAPI({ - StartsWith: function (str, sub_str) { - return (''+str).indexOf(sub_str) === 0; - } -}); %> -</pre> - -<p>The reason for this is because DekiScript is case-insensitive when it comes to references to API methods, whereas JavaScript is strict about uppercase and lowercase in references. So, <code>buildAPI()</code> is a hack to try to cover common case variations in DekiScript calls found in legacy templates.</p> - -<div class="note"> -<p>With that in mind, please do not use <code>buildAPI()</code> in new modules.</p> -</div> - -<h2 id="Tips_and_caveats">Tips and caveats</h2> - -<h3 id="Debugging">Debugging</h3> - -<p>A useful tip when debugging. You can use the <code>log.debug()</code> method to output text to the scripting messages area at the top of the page that's running your template. Note that you need to be really sure to remove these when you're done debugging, as they're visible to all users! To use it, just do something like this:</p> - -<pre class="notranslate"><%- log.debug("Some text goes here"); %> -</pre> - -<p>You can, of course, create more complex output using script code if it's helpful.</p> - -<h3 id="Caching">Caching</h3> - -<p>KumaScript templates are heavily cached to improve performance. For the most part, this works great to serve up content that doesn't change very often. But, as a logged-in user, you have two options to force a page to be regenerated, in case you notice issues with scripting:</p> - -<ul> - <li>Hit Refresh in your browser. This causes KumaScript to invalidate its cache for the content on the current page by issuing a request with a <code>Cache-Control: max-age=0</code> header.</li> - <li>Hit Shift-Refresh in your browser. This causes KumaScript to invalidate cache for the current page, as well as for any templates or content used by the current page by issuing a request with a <code>Cache-Control: no-cache</code> header.</li> -</ul> - -<h3 id="Використання_пошуку_за_ключовими_словами_задля_відкриття_сторінок_шаблонів">Використання пошуку за ключовими словами задля відкриття сторінок шаблонів</h3> - -<p>When using templates, it's common to open the template's code in a browser window to review the comments at the top, which are used to document the template, its parameters, and how to use it properly. To quickly access templates, you can create a Firefox <a href="http://kb.mozillazine.org/Using_keyword_searches">search keyword</a>, which gives you a shortcut you can type in the URL box to get to a template more easily.</p> - -<p>To create a search keyword, open the bookmarks window by choosing "Show all bookmarks" in the Bookmarks menu, or by pressing <kbd>Control</kbd>-<kbd>Shift</kbd>-<kbd>B</kbd> (<kbd>Command</kbd>-<kbd>Shift</kbd>-<kbd>B</kbd> on Mac). Then from the utility ("Gear") menu in the Library window that appears, choose "New Bookmark...".</p> - -<p>This causes the bookmark editing dialog to appear. Fill that out as follows:</p> - -<dl> - <dt>Name</dt> - <dd>A suitable name for your search keyword; "Open MDN Template" is a good one.</dd> - <dt>Location</dt> - <dd><kbd>https://github.com/mdn/kumascript/blob/master/macros/%s</kbd></dd> - <dt>Tags {{optional_inline}}</dt> - <dd>A list of tags used to organize your bookmarks; these are entirely optional and what (if any) tags you use is up to you.</dd> - <dt>Keyword</dt> - <dd>The shortcut text you wish to use to access the template. Ideally, this should be something short and quick to type, such as simply "t" or "mdnt".</dd> - <dt>Description {{optional_inline}}</dt> - <dd>A suitable description explaining what the search keyword does.</dd> -</dl> - -<p>The resulting dialog looks something like this:</p> - -<p><img alt="" src="https://mdn.mozillademos.org/files/14432/Screen%20Shot%202016-11-28%20at%203.08.39%20PM.png" style="height: 289px; width: 500px;"></p> - -<p>Then click the "Add" button to save your new search keyword. From then on, typing your keyword, then a space, then the name of a macro will open that macro in your current tab. So if you used "t" as the keyword, typing <kbd>t ListSubpages</kbd> will show you the page at {{TemplateLink("ListSubpages")}}.</p> - -<h2 id="Cookbook">Cookbook</h2> - -<p>This section will list examples of common patterns for templates used on MDN, including samples of legacy DekiScript templates and their new KumaScript equivalents.</p> - -<h3 id="Force_templates_used_on_a_page_to_be_reloaded">Force templates used on a page to be reloaded</h3> - -<p>It bears repeating: To force templates used on a page to be reloaded after editing, hit Shift-Reload. Just using Reload by itself will cause the page contents to be regenerated, but using cached templates and included content. A Shift-Reload is necessary to invalidate caches beyond just the content of the page itself.</p> - -<h3 id="Recovering_from_Unknown_Error">Recovering from "Unknown Error"</h3> - -<p>Sometimes, you'll see a scripting message like this when you load a page:</p> - -<pre class="notranslate">Kumascript service failed unexpectedly: <class 'httplib.BadStatusLine'></pre> - -<p>This is probably a temporary failure of the KumaScript service. If you Refresh the page, the error may disappear. If that doesn't work, try a Shift-Refresh. If, after a few tries, the error persists - <a class="link-https" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&format=itrequest">file an IT bug</a> for Mozilla Developer Network to ask for an investigation.</p> - -<h3 id="Broken_wiki.languages_macros">Broken wiki.languages() macros</h3> - -<p>On some pages, you'll see a scripting error like this:</p> - -<pre class="notranslate">Syntax error at line 436, column 461: Expected valid JSON object as the parameter of the preceding macro but... -</pre> - -<p>If you edit the page, you'll probably see a macro like this at the bottom of the page:</p> - -<pre class="notranslate">\{{ wiki.languages({ "zh-tw": "zh_tw/Core_JavaScript_1.5_教學/JavaScript_概要", ... }) }} -</pre> - -<p>To fix the problem, just delete the macro. Or, replace the curly braces on either side with HTML comments <code><!-- --></code> to preserve the information, like so:</p> - -<pre class="notranslate"><!-- wiki.languages({ "zh-tw": "zh_tw/Core_JavaScript_1.5_教學/JavaScript_概要", ... }) --> -</pre> - -<p>Because Kuma supports localization differently, these macros aren't actually needed any more. But, they've been left intact in case we need to revisit the relationships between localized pages. Unfortunately, it seems like migration has failed to convert some of them properly.</p> - -<h3 id="Finding_the_Current_Pages_Language">Finding the Current Page's Language</h3> - -<p>In KumaScript, the locale of the current document is exposed as an environment variable:</p> - -<pre class="notranslate">var lang = env.locale; -</pre> - -<p>The <code>env.locale</code> variable should be reliable and defined for every document.</p> - -<h3 id="Reading_the_contents_of_a_page_attachment">Reading the contents of a page attachment</h3> - -<p>You can read the contents of an attached file by using the <code>mdn.getFileContent()</code> function, like this:</p> - -<pre class="notranslate"><% - var contents = mdn.getFileContent(fileUrl); - ... do stuff with the contents ... -%> -</pre> - -<p>or</p> - -<pre class="notranslate"><%-mdn.getFileContent(fileObject)%> -</pre> - -<p>In other words, you may specify either the URL of the file to read or as a file object. The file objects for a page can be accessed through the array <code>env.files</code>. So, for example, to embed the contents of the first file attached to the article, you can do this:</p> - -<pre class="notranslate"><%-mdn.getFileContent(env.files[0])%> -</pre> - -<div class="note"><strong>Note:</strong> You probably don't want to try to embed the contents of a non-text file this way, as the raw contents would be injected as text. This is meant to let you access the contents of text attachments.</div> - -<p>If the file isn't found, an empty string is returned. There is currently no way to tell the difference between an empty file and a nonexistent one. But if you're putting empty files on the wiki, you're doing it wrong.</p> - -<h3 id="Localizing_template_content">Localizing template content</h3> - -<p>Templates are not translated like wiki pages, rather any single template might be used for any number of locales.</p> - -<p>So the main way to output content tailored to the current document locale is to pivot on the value of <code>env.locale</code>. There are many ways to do this, but a few patterns are common in the conversion of legacy DekiScript templates:</p> - -<h4 id="Ifelse_blocks_in_KumaScript">If/else blocks in KumaScript</h4> - -<p>The KumaScript equivalent of this can be achieved with simple if/else blocks, like so:</p> - -<pre class="notranslate"><% if ("fr" == env.locale) { %> -<%- template("CSSRef") %> « <a title="Référence_CSS/Extensions_Mozilla" href="/fr/docs/Référence_CSS/Extensions_Mozilla">Référence CSS:Extensions Mozilla</a> -<% } else if ("ja" == env.locale) { %> -<%- template("CSSRef") %> « <a title="CSS_Reference/Mozilla_Extensions" href="/ja/docs/CSS_Reference/Mozilla_Extensions">CSS リファレンス:Mozilla 拡張仕様</a> -<% } else if ("pl" == env.locale) { %> -<%- template("CSSRef") %> « <a title="Dokumentacja_CSS/Rozszerzenia_Mozilli" href="/pl/docs/Dokumentacja_CSS/Rozszerzenia_Mozilli">Dokumentacja CSS:Rozszerzenia Mozilli</a> -<% } else if ("de" == env.locale) { %> -<%- template("CSSRef") %> « <a title="CSS_Referenz/Mozilla_CSS_Erweiterungen" href="/de/docs/CSS_Referenz/Mozilla_CSS_Erweiterungen">CSS Referenz: Mozilla Erweiterungen</a> -<% } else { %> -<%- template("CSSRef") %> « <a title="CSS_Reference/Mozilla_Extensions" href="/en-US/docs/CSS_Reference/Mozilla_Extensions">CSS Reference:Mozilla Extensions</a> -<% } %> -</pre> - -<p>Depending on what text editor is your favorite, you may be able to copy & paste from the browser-based editor and attack this pattern with a series of search/replace regexes to get you most of the way there.</p> - -<p>My favorite editor is MacVim, and a series of regexes like this does the bulk of the work with just a little manual clean up following:</p> - -<pre class="notranslate">%s#<span#^M<span#g -%s#<span lang="\(.*\)" .*>#<% } else if ("\1" == env.locale) { %>#g -%s#<span class="script">template.Cssxref(#<%- template("Cssxref", [# -%s#)</span> </span>#]) %> -</pre> - -<p>Your mileage may vary, and patterns change slightly from template to template. That's why the migration script was unable to just handle this automatically, after all.</p> - -<h4 id="String_variables_and_switch">String variables and switch</h4> - -<p>Rather than switch between full chunks of markup, you can define a set of strings, switch them based on locale, and then use them to fill in placeholders in a single chunk of markup:</p> - -<pre class="notranslate"><% -var s_title = 'Firefox for Developers'; -switch (env.locale) { - case 'de': - s_title = "Firefox für Entwickler"; - break; - case 'fr': - s_title = "Firefox pour les développeurs"; - break; - case 'es': - s_title = "Firefox para desarrolladores"; - break; -}; -%> -<span class="title"><%= s_title %></span> -</pre> - -<h4 id="Use_mdn.localString">Use <code>mdn.localString()</code></h4> - -<p>A recent addition to the <code>MDN:Common</code> module is <code>mdn.localString()</code>, used like this:</p> - -<pre class="notranslate"><% -var s_title = mdn.localString({ - "en-US": "Firefox for Developers", - "de": "Firefox für Entwickler", - "es": "Firefox para desarrolladores" -}); -%> -<span class="title"><%= s_title %></span> -</pre> - -<p>This is more concise than the switch statement, and may be a better choice where a single string is concerned. However, if many strings need to be translated (e.g., as in <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/CSSRef.ejs" title="CSSRef">CSSRef</a>), a switch statement might help keep all the strings grouped by locale and more easily translated that way.</p> - -<p>When the object does not have the appropriate locale, the value of "en-US" is used as the initial value.</p> - -<h2 id="See_also">See also</h2> - -<ul> - <li><a href="http://kuma.readthedocs.io/en/latest/" title="Getting started with Kuma">Getting started with Kuma</a></li> - <li><a href="https://github.com/mdn/kumascript" title="Project:en/KumaScript reference">KumaScript reference</a></li> - <li><a class="link-https" href="https://wiki.mozilla.org/MDN/Kuma" title="https://wiki.mozilla.org/MDN/Kuma">Kuma wiki</a></li> -</ul> diff --git a/files/uk/mdn/tools/kumascript/troubleshooting/index.html b/files/uk/mdn/tools/kumascript/troubleshooting/index.html deleted file mode 100644 index 2764ae5e87..0000000000 --- a/files/uk/mdn/tools/kumascript/troubleshooting/index.html +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Усунення помилок KumaScript -slug: MDN/Tools/KumaScript/Troubleshooting -tags: - - KumaScript - - MDN Meta - - Tools - - Помилки - - Путівник -translation_of: MDN/Tools/KumaScript/Troubleshooting -original_slug: MDN/Tools/KumaScript/Усунення_помилок_KumaScript ---- -<div>{{MDNSidebar}}</div><div class="summary"> -<p>Помилки <a href="/uk/docs/MDN/Contribute/Tools/KumaScript">KumaScript</a>, ці моторошні червоні прямокутники, що часом муляють око на сторінках, можуть відлякувати деяких читачів. Але, на щастя, кожен, хто має облікового записа MDN, може відредагувати статтю й виправити такі помилки. Якщо сторінка містить помилки, вона одразу потрапляє у перелік <a href="/uk/docs/with-errors">документів з помилками</a>. Редактори сайту постійно переглядають той перелік й виправляють помилки. Ця сторінка наводить чотири різновиди помилок KumaScript та деякі можливі кроки для їх усунення.</p> -</div> - -<h2 id="Помилка_розбору_документа_DocumentParsingError">Помилка розбору документа (DocumentParsingError)</h2> - -<p>Помилка <code>DocumentParsingError</code> трапляється тоді, коли в KumaScript виникає проблема з розбором самого документа. Зазвичай це синтаксична помилка в <a href="/uk/docs/MDN/Contribute/Content/Macros">шаблоні</a>.</p> - -<p>Слід перевірити:</p> - -<dl> - <dt>Ужиток фігурних дужок там, де не здійснюється виклик шаблону;</dt> - <dd>Якщо вам в документі потрібна фігурна дужка, але це не виклик шаблону, можна її заекранувати за допомогою \ ось так: \\{.</dd> - <dt>Ужиток особливих символів у параметрі шаблону;</dt> - <dd>Якщо вам потрібен символ " або \ всередині параметра шаблону, його необхідно заекранувати за допомогою \ ось так: \".</dd> - <dt>Відсутність ком між параметрами шаблону;</dt> - <dd>Параметри шаблону мають бути відокремлені одне від одного комою ось так: \{\{anch("top", "Нагору")}}.</dd> - <dt>Використання теґів HTML всередині шаблону;</dt> - <dd>Застосування стилів до шаблону може зламати його. Наприклад, кінцевий теґ </code> може виявитися всередині породженого шаблоном вмісту. Перевірте код сторінки, щоб це з'ясувати, та видаліть непотрібне оформлення.</dd> -</dl> - -<ul> -</ul> - -<h2 id="Помилка_завантаження_шаблону_TemplateLoadingError">Помилка завантаження шаблону (TemplateLoadingError)</h2> - -<p>Помилка <code>TemplateLoadingError</code> трапляється тоді, коли в KumaScript виникає проблема з пошуком відповідного шаблону за іменем.</p> - -<p>Слід перевірити:</p> - -<dl> - <dt>Помилково написане ім'я або ужиток перейменованого шаблону.</dt> - <dd>Повний перелік наявних шаблонів ви можете знайти у <a href="https://github.com/mdn/kumascript/tree/master/macros">репозиторії на GitHub</a>.</dd> -</dl> - -<div class="note"> -<p><strong>Порада</strong>: Ви можете зробити пошук шаблонів швидшим й зручнішим, скориставшись механізмом search keyword у Firefox (або відповідним у іншому переглядачі). Дивіться покроковий путівник в розділі {{SectionOnPage("/uk/docs/MDN/Contribute/Tools/KumaScript", "Використання пошуку за ключовими словами задля відкриття сторінок шаблонів")}}.</p> -</div> - -<p>Помилка <code>TemplateExecutionError</code> трапляється тоді, коли KumaScript натрапляє на помилку під час виконання самого шаблону. Такі помилки можуть виправити лише адміністратори, тож вам слід лише надіслати відповідний звіт.</p> - -<p>Перед тим, як надсилати звіт про помилки, переконайтеся, що їх досі не виправлено. Для цього ви можете змусити KumaScript надати вам останню версію сторінки, перезавантаживши її зі скиданням кешів (<kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>R</kbd> у Linux/Windows, <kbd>Shift</kbd> + <kbd>Cmd</kbd> + <kbd>R</kbd> на Mac).</p> - -<p>Якщо проблема лишається, <a href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Mozilla_Developer_Network&component=General#h=detail|bug">повідомте про ваду</a>, додавши URL-посилання на сторінку й текст помилки.</p> - -<h2 id="Невідома_помилка_Error_Unknown">Невідома помилка (Error & Unknown)</h2> - -<p>Так позначаються помилки, які не належать до жодного з наведених різновидів.</p> - -<p>Переконайтеся, що виправлень досі немає, а тоді повідомте про вади так само, як у випадку з <a href="#TemplateExecutionError">TemplateExecutionError</a>.</p> diff --git a/files/uk/mdn/yari/index.html b/files/uk/mdn/yari/index.html deleted file mode 100644 index 11cc621995..0000000000 --- a/files/uk/mdn/yari/index.html +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: 'Kuma: wiki-платформа MDN' -slug: MDN/Yari -tags: - - Kuma - - MDN Meta -translation_of: MDN/Kuma -original_slug: MDN/Kuma ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/uk/docs/MDN")}}</div> - -<p>Платформа Kuma — це код, що ґрунтується на <a href="/uk/docs/Learn/Server-side/Django">Django</a> та вможливлює роботу MDN Web Docs.</p> - -<p>{{SubpagesWithSummaries}}</p> - -<h2 id="Ознайомлення_з_Kuma">Ознайомлення з Kuma</h2> - -<p>Щоб ознайомитися з Kuma:</p> - -<ul> - <li>Відвідайте проект <a href="https://github.com/mozilla/kuma">Kuma на Github</a>.</li> - <li>Перегляньте <a href="https://github.com/mozilla/kuma/blob/master/CONTRIBUTING.md">Contribution Guide.</a></li> - <li>Як буде потреба, зверніться до <a href="http://kuma.readthedocs.org/en/latest/">повної документації з Kuma</a>.</li> -</ul> |