Обговорення шаблону:Документація

Матеріал з Вікіпедії — вільної енциклопедії.
Найсвіжіший коментар: Klepkoilla у темі «Шаблон:Склад НФЛ» 8 місяців тому
Перейти до навігації Перейти до пошуку

Редирект або повна версія?[ред. код]

Існування двох різновидів шаблонів не суперечить правилам Вікіпедії.

Відкотити і позначити як {{застарілий шаблон}}? Для чого? Два шаблони, які виконують ідентичну функцію, не потрібні, той шаблон більш функціональний — NickK 15:32, 23 серпня 2009 (UTC)Відповісти
Для кого функціональний, для кого — громіздкий. {{Template doc begin|{{SUBJECTPAGENAME}}/Документація|notoc={{{notoc|}}}}}{{{{SUBJECTPAGENAME}}/Документація}}{{Template doc end}}--Prima klasy4na 21:47, 23 серпня 2009 (UTC)Відповісти
Натомість йому потрібні одразу два підшаблони, що занадто. Нащо два шаблони з однаковими функціями, якщо все одно вони використовуються з однаковою метою, і все одно кода не видно (бо використати цей шаблон з підстановкою просто нереально) — NickK 21:53, 23 серпня 2009 (UTC)Відповісти
Виявлена петля у шаблонах: Шаблон:Документація. Усувайте. Поки змінюю редирект на шаблон. --Ink 12:03, 26 серпня 2009 (UTC)Відповісти
Де петля? Шаблон не має петель, проблема не в шаблоні — NickK 12:05, 26 серпня 2009 (UTC)Відповісти
{{Замок}}. Це я помилився з параметрами <noinclude><includeonly></includeonly></noinclude>. --Ink 12:17, 26 серпня 2009 (UTC)Відповісти

Тема №2[ред. код]

Шаблон Документація зроблено без розуміння того - а нащо такі шаблони потрібні. 1. Немає навігації по темам - повязаним з шаблоном - наприклад обговорення, де використовується, тощо. 2. Зовсім некоректно виставляє Категорії документації. 3. Чисто номінально - вжеб назвали "док" З другого боку - нічого не заважає існувати двум різним шаблонам. Хто пише шаблон сам обирає який використовувати.--Aqueelone 17:41, 22 грудня 2010 (UTC)Відповісти

  1. Ця вся навігація є і так: Обговорення - там де завжди, Де використовується - теж, і т.д.
  2. Що значить некоректно?
  3. Без коментарів.
Не бачу потреби мати по кілька шаблонів, що виконують ті ж самі функції. Власне шаблони для того і використовуються, щоб робити однакове оформлення, що полегшує навігацію для користувача в цілому. --DixonD 18:01, 22 грудня 2010 (UTC)Відповісти
Коли йдеться про користувацькі шаблони - можливо Ви і маєте рацію - кількість шаблонів може заважати. Коли ж йдеться про "шаблони для шаблонів" - тут зовсім інша справа. Можливо було б "покращити" шаблон "Документація". Але справа в тім, що одна з його проблем - необхідність писати "велику кількість літер" при тім, що такої необхідності ніяк немає, окрім бажання когось мати свій, окремий від спільноти Вікіпедії, шаблон. При наймні - використовуємо основне Правило Вікіпедії === пошук Консенсусу. А доки його немає - використовуємо обидва шаблона! --Aqueelone 07:52, 23 грудня 2010 (UTC)Відповісти
окрім бажання когось мати свій, окремий від спільноти Вікіпедії, шаблон Про що ви говорите взагалі? необхідність писати "велику кількість літер" А тут про що? Поясніть, що, на ващу думку, бракує у шаблоні Документація, і це, якщо воно справді буде потрібно, можна буде додати. --DixonD 10:05, 23 грудня 2010 (UTC)Відповісти

Помилкове виведення[ред. код]

Шаблон на деяких сторінках чомусь виводить [ред. код] замість [перегляд]. Наприклад тут: Шаблон:Книга. (Посилання залишається правильним, і веде на сторінку перегляду, а не редагування.)
--MMH (обговорення) 21:27, 1 серпня 2015 (UTC)Відповісти
Причому, на тих сторінках, де це відбувається, відсутні посилання [ред. код] для розділів документації (коли переглядаєш її на сторінці шаблону).
--MMH (обговорення) 21:34, 1 серпня 2015 (UTC)Відповісти

Оновлення[ред. код]

Ні Запит відхилено

Оновити до стану англ. шаблону, перевести у модуль Lua, оновити документацію, вирішити проблему відображення пункту перегляду, зазначену вище.--PsichoPuzo (обговорення) 18:22, 13 грудня 2015 (UTC)Відповісти

Відхилено, пояснення тут. --RLuts (talk) 05:21, 5 січня 2016 (UTC)Відповісти
Вирішив проблему відображення пункту перегляду, зазначену вище --Gzhegozh (обговорення) 14:12, 31 грудня 2018 (UTC)Відповісти

Вигляд шаблону[ред. код]

Gzhegozh, з якою метою ви змінили вигляд шаблону на скопійований з російської Вікі, включно з Шаблон:Doc/styles.css? --VoidWanderer (обговорення) 15:23, 1 січня 2019 (UTC)Відповісти

Так шаблон виглядає естетичніше. Я змінив синій колір російського шаблону на традиційний для всіх інших вікі зелений.--Gzhegozh (обговорення) 15:25, 1 січня 2019 (UTC)Відповісти
Естетика — це поняття суб'єктивне. А ось ідея копіювати рувікі — це стара, і дуже сумнівна традиція української Вікі. Я поверну усталений вигляд, про доцільність подібних змін рекомендую створити окрему гілку у якійсь із Кнайп. --VoidWanderer (обговорення) 15:31, 1 січня 2019 (UTC)Відповісти

@Gzhegozh та Piramidion: чому редизайн був змінений без обговорення на росвікі та вилучено функціонал?--『  』 Обг. 21:21, 8 червня 2019 (UTC)Відповісти

@AlexKozur: Ми детальніше обговорювали це з користувачем Piramidion на іншому обговоренні. Почну з першого: «функціонал», як його називав користувач Avatar6, фактично дублював усі функції (редагувати, перегляд, очистити кеш тощо), які доступні вгорі над кожною сторінкою. Той же користувач використовував цей шаблон для інлайн-документації (який ще й був естетично недовершеним та абсолютно не пасував нашій Вікі за її традиційним зеленим стилем) переважно в створених ним же шаблонах, попри те, що за допомоги {{Документація}} можна створювати й інлайн-документацію, якщо немає змоги створити повноцінну підсторінку документації. По-друге, оскільки ще раніше, десь до 2012 року, документація сторінок була ідентичною російській версії, у нас використовувався цей шаблон. Після запровадження «зеленої документації» функцію цього шаблону став виконувати {{Документація/start box}}, тоді як цей шаблон почали використовувати по іншому. Щодо зміни стилю — я змінив усі супутні шаблони наприкінці 2018 року, щоб подивитися, як працюватиме російський стиль оформлення документації в нашій Вікі, проте, як виявилося, із цим є певні проблеми (див. посилання на обговорення). --  Gzhegozh обг. 21:33, 8 червня 2019 (UTC)Відповісти
Це питання не до мене. На той час шаблон уже був «синім» (колір був прописаний у межах цього шаблону, а не на підсторінці /styles.css, як я спершу подумав), тільки оформлення виглядало негарно. Я його лише підправив, скориставшись російською версією (оскільки зрозумів так, що саме її брали за основу). На поточному оформленні не наполягаю.--Piramidion 09:39, 9 червня 2019 (UTC)Відповісти
«Синьої» документації в Українській Вікіпедії більше нема. Усі три «сині» шаблони документації вилучені, колишні включення замінені на {{Документація|текст=}}. Саме цей параметр шаблону {{Документація}} тепер вживаємо для створення інлайн-документації. --  Gzhegozh обг. 11:58, 1 серпня 2019 (UTC)Відповісти
P.S. Здається, я трохи помилився — наскільки я бачу, Українська Вікіпедія ніколи не використовувала російський стиль документації як основний. Проте, для інлайн-документації паралельно з параметром |content шаблону {{Документація}} застосовувалися саме російські шаблони. --  Gzhegozh обг. 11:58, 1 серпня 2019 (UTC)Відповісти

Документація/styles.css[ред. код]

@Piramidion: Вітаю! Бачу, що ви змінили кольори на такі, що присутні в російській версії. Хочу повідомити про те, що наприкінці грудня я також випробував російський стиль документації для нашої Вікі, але замість синіх кольорів, притаманних російській Вікі, я додав зелені відтінки — більш традиційні для української та більшості Вікі. Проте, коли я це випробував, побачив недолік: якщо дослівно скопіювати код документаційних шаблонів із РосВікі (переклавши фрагменти російською мовою), то шаблон відображається лише на підсторінках документації з грифом /Документація, а /doc і /документація (з малою літерою) воно не бачить. Тож зважте на це, будь ласка, якщо запроваджуватиме російський стиль документаційних шаблонів. Дякую за увагу! --  Gzhegozh (обговорення) 17:43, 30 квітня 2019 (UTC)Відповісти

Привіт. Щоб виправити цей недолік, думаю, треба підправити код якогось модуля, але я не знаю, що саме і як саме. І впроваджувати решту змін я не маю наміру, принаймні зараз, і принаймні без попереднього обговорення. Деякі поточні зміни я робив для того, щоб відповідні шаблони документації добре виглядали і взагалі правильно працювали на сторінках модулів (наприклад, див. Модуль:Universal infocard, де документація наразі відсутня, і Модуль:Universal infocard/config, де вона є). Бо раніше модулі мали лише простий текст на місці документації, а заповнена документація практично не відрізнялася за форматом від коду модуля, що дуже збивало з пантелику, тим паче, що документація теж іноді містить приклади коду, так що бувало важко зрозуміти, де закінчується документація, а де починається вже код самого модуля. Якщо десь щось працюватиме не так, або не працюватиме — прошу повідомити. Якщо щось треба вдосконалити — можу спробувати, але не гарантую, що мені вдасться — знання в мене порівняно обмежені, тож я далеко не все можу робити самотужки.--Piramidion 17:59, 30 квітня 2019 (UTC)Відповісти
Узагалі, якщо додати код російського Шаблон:Doc до {{Документація}}, тоді зникне той баг, що з'являється у включеннях Шаблон:Doc/begin (див. напр. {{Ling-stub}}). І тоді все, окрім наведеної вище проблеми, працює добре. В ідеальному разі треба запустити бота, та обрати з поміж /документація, /Документація та /doc один варіант, щоб той перейменував усі сторінки документації на нього. Ось за таких умов усе працюватиме добре. Але, гадаю, це в будь-якому разі має відбуватися через обговорення (див. Обговорення шаблону:Документація#Вигляд шаблону).--  Gzhegozh (обговорення) 19:04, 30 квітня 2019 (UTC)Відповісти
Я той баг вже наче прибрав (хоча не впевнений, чи моє рішення універсальне)--Piramidion 19:18, 30 квітня 2019 (UTC)Відповісти
@Piramidion:А, до речі! У російській Вікі те, що має назву Doc/begin і Doc/end у нашій вікі звуться Документація/start box та Документація/end box. А в нашій Вікі Doc/begin і Doc/end мають бути перенаправлені на Документація/start box та Документація/end box. Проте, один користувач «підм'яв під себе» цю зв'язку шаблонів (/begin і /end), і використовує їх в усіх шаблонах, які він створює, для інлайн-документації (тобто без створення підсторінки документації, а безпосередньо в шаблоні). Річ у тім, що інлайн-документація наразі в укрвікі можлива через сам {{Документація}}, якщо використовувати відповідні параметри. Більше про це можете прочитати тут. Тому краще оновіть Документація/start box та Документація/end box, а з /begin і /end створіть туди перенаправлення. --  Gzhegozh (обговорення) 19:04, 30 квітня 2019 (UTC)Відповісти
Поки що боюся за це братись, щоб не наламати дров. Всі оці зміни я вносив заради модулів, щоб тамтешня документація виглядала якось більш-менш пристойно, ну й деякі сторінки використовували чомусь синю документацію, але з поганим оформленням — саме тому я й змінив кольори в цьому шаблоні (думав, що це він тому причина, але, мабуть, причина була в коді шаблону {{Doc/begin}}). Перечитаю ті обговорення — то ще раз відпишу, але думаю, що все-таки треба десь започаткувати обговорення. Це вже, здається, десь обговорювалося, але якщо там був якийсь підсумок — я це пропустив.--Piramidion 19:18, 30 квітня 2019 (UTC)Відповісти
Аби воно коректно виглядало, включення не ламалися, треба змінити код шаблону Документація на російський. Якщо не помиляюся, то в англійському шаблоні Документація такий ж код. Тоді працюватиме без негараздів. Але справді, перш, ніж змінювати стиль і код, треба мати консенсус. --  Gzhegozh (обговорення) 19:24, 30 квітня 2019 (UTC)Відповісти
А, чудово, бачу, ви вже іншим чином виправили недолік. --  Gzhegozh (обговорення) 19:29, 30 квітня 2019 (UTC)Відповісти
Той код у них використовує Модуль:Documentation, а я не впевнений, чи там все добре прописано. Зокрема, у нас є три варіанти підсторінок — /doc, /документація і /Документація. І ці три варіанти треба або прописати в тому модулі, перш ніж робити відповідну заміну, або якось уніфікувати за допомогою бота.--Piramidion 19:30, 30 квітня 2019 (UTC)Відповісти
Так, так, я ж про це й говорю. Теоритично можна підглянути у РосВікі, може там є в модулі схоже щось, але, вони, гадаю, тільки /doc вживають. --  Gzhegozh (обговорення) 19:33, 30 квітня 2019 (UTC)Відповісти
А модуля такого там нема 😐. Втім, у Російській Вікі в шаблоні Doc/end є рядок: {{#ifexist: {{FULLPAGENAME}}/doc. Якщо його тричі із різними варіантами прописати, то має працювати. Але як правильно прописати, я не знаю. --  Gzhegozh (обговорення) 19:38, 30 квітня 2019 (UTC)Відповісти
Не зовсім правильно висловився. Це тільки шаблон:Doc/end працюватиме тоді правильно, а ще схожий рядок є в російському шаблоні Doc: {{#ifexist:{{SUBJECTPAGENAME}}/doc|{{{{SUBJECTPAGENAME}}/doc}}|{{Документировать|{{SUBJECTPAGENAME}}/doc}}. Над цим тоді треба попрацювати. Бо, наскільки я розумію, у нас {{Документація}} не працює разом із модулем Documentation в парі. --  Gzhegozh (обговорення) 19:43, 30 квітня 2019 (UTC)Відповісти
Здається, я знаю, як можна прописати код із російської версії в нас, з урахуванням всіх трьох варіантів — можна зробити через дві вкладені парсерні функції ifexist: перший раз вона перевіряє наявність підсторінки /doc, якщо немає — наступна функція перевіряє наявність /Документація, і якщо немає — видає підсторінку /документація (якщо її немає — то посилання на її створення). Так воно працює нормально, я перевіряв через попередній перегляд. І модуль тоді не потрібний. Питання в тому, чи не створить це якихось непередбачуваних проблем, чи спільнота не буде проти, і яку кольорову схему вона хоче застосувати: синю, як в рувікі, зелену, як у Вашому варіанті, чи якусь взагалі іншу.--Piramidion 19:56, 30 квітня 2019 (UTC)Відповісти
Якщо ви можете це зробити — то зробіть, ми подивимося. Якщо все добре працює, то тоді треба просто відкотити ці зміни, щоби вони не спричинили обурення деяких користувачів, та ініціювати обговорення щодо зміни стилю документації шаблонів. Якщо виникнуть якісь проблеми — можна ж відкотити. А колір — то діло таке, другорядне. Мені до вподоби зелена гама, вона більш традиційна, оскільки вона зберігає зв'язок із іншими Вікі, а не з російською. Але це все можна буде обговорювати тоді, коли код працюватиме безпомилково. --  Gzhegozh (обговорення) 20:01, 30 квітня 2019 (UTC)Відповісти
Тут ще є потенційна проблема з параметрами — російська версія таких параметрів, як у нас, не має. Треба сісти й розібратися, як воно все працює — як у них, і як у нас, і наскільки шкідливою може виявитись заміна, яку ми хочемо зробити.--Piramidion 20:38, 30 квітня 2019 (UTC)Відповісти
Так, це проблема. Я, на жаль, нічим не можу допомогти в цьому. Можливо, зверніться до користувача Рассилон за допомогою — він, якщо не помиляюся, знається на кодах. --  Gzhegozh (обговорення) 11:57, 1 травня 2019 (UTC)Відповісти
  • не забувайте, що у ВП:ПАТ зазначено якраз begin шаблон а не start box. Потрібно визначитись з цим та відповідно провести заміни. Можливо провести голосування за вибір дизайну документації. Думаю спочатку потрібен ботовласник, бо /doc, /Документація не повинно бути згідно ВП:ПАТ, проте правила щодо іменувань та оформлень документацій наче немає. Користувач відкочуває через функціональність з Вікіданими, їх потрібно проаналізувати й винести на обговорення. Найкраще об'єднати стар бокс на інлайн. Найкраще рішення це консенсус. --『  』 Обг. 22:04, 8 червня 2019 (UTC)Відповісти
Погоджуюся з вами. Я щойно порушив цю проблему в Кнайпі пропозицій. Для усунення цього недоліку треба три кроки:
  1. Консенсус щодо доцільності змін (якщо так, то далі — консенсус щодо єдиної назви)
  2. Перейменування за допомоги бота
  3. Створення попередження під час редагування, коли дописувач створює підсторінку документації під відхиленими назвами --  Gzhegozh обг. 22:13, 8 червня 2019 (UTC)Відповісти
@AlexKozur: Щодо вашої цитати «begin а не start box» — я мав на увазі інлайн-документацію не за допомоги {{Документація/start box}}. Вона відбувається безпосередньо {{Документація}}. Проте, поміж усього іншого, шаблони {{Документація/start box}} і {{Doc/begin}} мають єдине призначення в українській та російській Вікі відповідно, хоча мають певні особливості (як ця, наприклад). --  Gzhegozh обг. 00:01, 9 червня 2019 (UTC)Відповісти

Перехід на модуль[ред. код]

@PsichoPuzo: Переведення шаблону на модуль потребує попереднього обговорення для цілковитої інтеграції функціоналу шаблону в модулі. Імпортований модуль з англійської Вікі не містить деякі компоненти нашого коду. --Gzhegozh обг. 10:58, 23 червня 2023 (UTC)Відповісти

На даний момент помітив тільки підстановку шаблону поліпшити документацію на відсутність сторінки модуля. Також було вилучено шматок стосовно роздрукування, до попередньої стабільної версії. Які ще функції могли постраждати? Опрацювання документації через модуль за цих умов значно переважає ці згадані функції.--PsichoPuzo (обговорення) 11:02, 23 червня 2023 (UTC)Відповісти
Також видається за доцільне допрацювати ці функції на пісочниці модуля й потім імплементувати їх таким же чином.--PsichoPuzo (обговорення) 11:03, 23 червня 2023 (UTC)Відповісти
@Gzhegozh: підстав для відкоту змін немає.--PsichoPuzo (обговорення) 11:05, 23 червня 2023 (UTC)Відповісти
Добре, але я через деякий час опишу вам ще один момент, який треба додати, адже він міститься в коді. --Gzhegozh обг. 11:06, 23 червня 2023 (UTC)Відповісти
@PsichoPuzo:. У модуль прошу додати цю зміну: ред. № 38708016. Це потрібно для альтернативного варіанту інлайн-документації не через параметр |content=, а через встановлення пари шаблонів {{Документація/start box}} та {{Документація/end box}}, коли підсторінка документації не існує (і не треба) — тоді посилання [створити] не виводиметься. Це не впливає на вигляд шаблону {{Документація}} без існуючої підсторінки, де таке посилання буде. --Gzhegozh обг. 11:36, 23 червня 2023 (UTC)Відповісти
Також перевірте, будь ласка, що в модулі працюють кириличні назви усіх параметрів (наприклад, замість параметру «content» можна також застосувати «текст»). --Gzhegozh обг. 11:38, 23 червня 2023 (UTC)Відповісти
Це здебільшого просто зайвий шмат непорібної роботи, що досягається простою заміною використання відповідно до патерну цього шаблону. Немає портеби ліпити гомункулів з різних застарілих шаблонів які до того ж не використовуються. Для направлення під час імпорту перенаправлення можна залишити, але дописувати невикористовуваний функціонал немає потреби.--PsichoPuzo (обговорення) 12:20, 23 червня 2023 (UTC)Відповісти
Слухайте, ну от саме через таке ставлення я скасував ваше редагування. Якщо ви щось змінюєте, то забезпечте підтримку попереднього функціоналу. У цьому разі йдеться про зміну-компроміс, яка уможливлює підтримку альтернативного формату документації, що часто передають із російської вікі, але із застосуванням стилю документації англійської вікі. --Gzhegozh обг. 12:39, 23 червня 2023 (UTC)Відповісти
Я підтримую зауваження @Gzhegozh. Одна справа, коли ми прощаємося із справді огидним кодом, і нема найменшої необхідності ліпити якісь костилі, щоб підтримувати як він працював.
Інша справа — проста міграція на кращу реалізацію, коли і старий код був непоганий, а нова версія ще краща. Всі статті, службові сторінки і шаблони мають продовжуватися відображатися нормально, в тому числі й при перегляді їх історії. --VoidWanderer (обговорення) 12:59, 23 червня 2023 (UTC)Відповісти
Немає поважних причин скасовувати імплементацію. Ви навели жодної. Натомість ця імплементація додає декілька критично корисних функцій, серед яких порівняння дифів з пісочницею, що є критично корисним за подальшої розробки. Не кажучи про вирішення старих багів й швидкодію. Про перенаправлення для імпорту написано вище. Це не той випадок зворотньої сумісності, який має якесь корисне навантаження. Відповідно зазначеного я повертаю імплементацію, переношу версію у розробці до пісочниці й подальше обговорення щодо конкретних функцій можна продовжувати там.--PsichoPuzo (обговорення) 09:18, 24 червня 2023 (UTC)Відповісти
@Gzhegozh: ваші версії перенесені у пісочницю для подальшої обробки. Було б не погано щоб ви на її сторінці обговорення зазначили, які функції варто додати й спільними зусиллями продовжимо працювати над покращенням.--PsichoPuzo (обговорення) 09:31, 24 червня 2023 (UTC)Відповісти
Мені відомо про додану мною функцію, про яку я вам уже повідомив, як і про назви параметрів. Я не маю всеохоплюючого розуміння функціоналу та специфіки застосування, яка може не підтримуватися модулем. Проте, я спробую пошукати функції. Якщо ви готові допомогти перевести ці функції в модуль, я би підтримав такий перехід. --Gzhegozh обг. 09:38, 24 червня 2023 (UTC)Відповісти
PsichoPuzo, зламався |текст=: лагодитимете чи відкочувати? --Ата (обг.) 10:19, 24 червня 2023 (UTC)Відповісти
Можна конкретні випадки, будь ласка? Це вирішується заміною параметра, для внутрішнього шаблону це не критично. Було б добре зробити таку заміну ботом, якщо можна.--PsichoPuzo (обговорення) 11:02, 24 червня 2023 (UTC)Відповісти

Шаблон:Склад НФЛ[ред. код]

Допоможіть ліквідувати петлю у цьому шаблоні, бо я не бачу де там includeonly --Klepkoilla (обговорення) 13:37, 27 серпня 2023 (UTC)Відповісти