ArtUploader – СтаЗавантажувач

Хочу
СтаЗавантажувач
(версія 1.1)

Версія 1.0
Оновлення

СтаЗавантажувач (скор. від СтаттєЗавантажувач) – інструмент, призначений для простої заливки сторінок (зокрема статей) до вікіпроектів. Створений під час першого українського ВікіХакатону в Києві 10-11 грудня 2016 року.

Початково задумувався як інструмент для заливки статей для тих, хто міг би це робити і має таблиці з даними, але має лише комп з Віндою і не розуміється на всяких Pyton'ах, командних рядках і не може знайти відповідальної людини, яка б підготувала йому скрипти, чи що там треба.

Наразі реалізовано заливку сторінок з файлів Excel (.xlsx, .csv) (див. розділ «Джерела даних»).

Відмова від відповідальності: Відповідальність за здійснені через «СтаЗавантажувач» редагування, створені сторінки, їх кількість і зміст несе виключно користувач згідно з правилами Вікіпроектів.

Зміст

  1. Інтерфейс
  2. Шаблони
  3. Прив'язка до Вікіданих (з версії 1.1)
  4. Джерела даних
  5. Перегляд заготовок
  6. Завантаження сторінок
  7. Приклад

Інтерфейс

Інтерфейс СтаЗавантажувача
Ліва частина інтерфейсу вгорі містить поля для вводу даних, необхідних для правильного завантаження сторінок. Це: Під цими полями знаходиться кнопка «Увійти у Вікі», призначена для входу на Вікі. Перед початком завантаження сторінок (див. розділ «Завантаження сторінок») треба увійти у вікі, аби завантажувані сторінки зберігалися у Вікі у внескові вказаного облікового запису.

Нижче розташовано список зареєстрованих у СтаЗавантажувачі шаблонів заливки (див. розділ «Збереження шаблонів»).

У верхньому рядку праворуч розташовані кнопки для роботи з шаблонами (див. розділ «Збереження шаблонів»). Нижче – поля для підготовки шаблонів завантаження (див. розділ «Новий шаблон»).

Внизу праворуч розташовані поля та кнопки для перегляду заготовок та їх завантаження у Вікі (див. розділи «Перегляд заготовок» та «Завантаження сторінок»).

Значення полів «Вікі», «Логін», «Пароль» та список шаблонів зберігаються при перезапускові програми.

Шаблони

Шаблони – заготовки текстів статей і їх назв, що містять змінні, які підставляються у заготовку з джерела даних при опрацюванні.

Новий шаблон

Щоб створити новий шаблон, слід натиснути кнопку «Новий» у верхньому рядку праворуч. Також створювати новий шаблон можна безпосередньо після запуску програми, якщо раніше не було перейдено до одного зі збережних шаблонів (див. розділ «Збереження шаблонів»).

При створенні нового шаблона, поле «Поточний шаблон» є порожнім.

Збереження шаблонів

Уведений шаблон (поля «Шаблон назви сторінки» та «Шаблон тексту сторінки») можна зберегти, натиснувши кнопку «Зберегти». Якщо шаблон був раніше збережений, то зміни будуть збережені в існуючому файлі. Якщо шаблон раніше не зберігався – з'явиться діалогове вікно, у якому треба буде вказати шлях та назву для збереження файлу.

Можна зберегти шаблон як ще одну версію уже існуючого, натиснувши кнопку «Зберегти як». При цьому з'явиться діалогове вікно, у якому треба буде вказати шлях та назву для збереження файлу.

При збереженні нового шаблону, чи версії вже існуючого, його буде додано до списку збережених шаблонів (ліворуч).

Збережений шаблон можна повторно відкрити, зробивши подвійний клік по його назві у списку. Якщо при цьому редагувався інший шаблон зі списку, він буде перед цим збережений. Якщо при цьому створювався новий шаблон і поля «Шаблон назви сторінки» чи «Шаблон тексту сторінки» непорожні, програма попросить зберегти його (кнопка «Зберегти»), або очистити (кнопка «Новий»).

Вибраний у списку шаблон можна звідти видалити, натиснувши кнопку «Видалити». При цьому шаблон прибирається зі списку, але сам файл із шаблоном залишається там, куди його було збережено.

Уже існуючий файл із шаблоном можна додати до списку, натиснувши кнопку «Відкрити». При цьому з'явиться діалогове вікно, у якому треба буде вказати потрібний файл.

Формат шаблонів

Шаблон – текст, який буде завантажено у Вікі як вихідний код статті (вікірозмітка) і який може містити змінні, в які при перегляді (див. розділ «Перегляд заготовок») та завантаженні (див. розділ «Завантаження сторінок») будуть замінені на значення з джерела даних (див. розділ «Джерела даних»).

Змінна в шаблоні подається текстом вигляду {{{$НОМЕР}}}, де НОМЕР – номер змінної із джерела даних, яка має бути підставленою на вказане місце. (див. також розділ «Приклад»)

Шаблони назви сторінки і тексту сторінки опрацьовуються ідентично.

Джерела даних

Файли Excel (.xlsx, .csv)

Таблиця Excel є джерелом даним для завантаження, де кожен рядок відповідає одній статті, а кожен стовпець – параметрові у шаблоні з відповідним порядковим номером (нумерація починається з одиниці). Тобто, змінна {{{$1}}} відповідає вмісту клітинки у стовпці А. (див. також розділ «Приклад»)

Перегляд заготовок

Перегляд заготовки
При розробці шаблона можна переглянути результат без заливки його у Вікі. Для цього треба вибрати файл джерела даних (кнопка «Знайти файл») і натиснути кнопку «Переглянути» в нижньому рядку вікна. При цьому у шаблони назв і тексту будуть підставлені значення змінних із вибраного файлу і результат буде виведений для перегляду.

Для перегляду використовується лише перший рядок даних.

Повернутися до редагування шаблона можна натиснувши кнопку «Ага»

Завантаження сторінок

Для завантаження сторінок у Вікі треба вибрати файл джерела даних (кнопка «Знайти файл») і натиснути кнопку «Завантажити» в нижньому рядку вікна. Якщо перед цим була вибрана опція «попередній перегляд», то після підготовки кожної заготовки (підстановки значень змінних із джерела даних) і перед її завантаженням у Вікі програма зупинятиметься і очікуватиме на рішення користувача завантажити підготовлену сторінку у Вікі, чи припинити заливку.

При попередньому перегляді у готовий текст статті можна внести зміни, які в разі підтвердження увійдуть до тексту, завантаженого у Вікі.

Якщо ж опція «попередній перегляд» не була вибрана, підготовлений текст одразу завантажується у Вікі і програма переходить до підготовки наступної заготовки.

Заливка продовжується, поки у джерелі будуть наявні дані, або поки користувач не зупинить її.

Перед початком заливки треба увійти у Вікі, вказавши її адресу і дані облікового запису, з якого виконуватимуться завантаження і натиснувши кнопку «Увійти у Вікі».

Для виконання масових завантажень наполегливо рекомендується використовувати обліковий запис з прапорцем бота.

Прив'язка до Вікіданих

Ця функція доступна з версії 1.1

Для прив'язки новоствореної статті до Вікіданих до інтерфейсу додано додаткові поля — «Шаблон елемента Вікіданих» та «Шаблон опису Вікіданих». Шаблони в цих полях будуються за тим же принципом, що й шаблони назви та вмісту статті.

Після підстановки змінних вміст «Шаблона елемента Вікіданих» має мати вигляд назви елемента Вікіданих вигляду Q00000. Якщо елемента з утвореною назвою у Вікіданих не існує, або поле порожнє, прив'язка не відбудеться.

Вміст «Шаблона опису Вікіданих» буде перетворено на рядок, який буде додано у поле «Опис» відповідного елемента Вікіданих, якщо опис елемента відсутній.

Також за відсутності значення «Назва» в елементі Вікіданих його буде заповнено назвою залитої статті.

Наявність опису та назви в елементі Вікіданих перевіряється і за необхідності додається для мови проекту, куди заливається стаття.

Для збереження шаблона статті із підтримкою інформації про Вікідані для раніше існуючого шаблону, натисніть «Зберегти як» і виберіть формат файла з підтримкою Вікіданих (.atd). Якщо зберегти старий шаблон не змінивши формат, інформація про шаблон елемента та опис Вікіданих буде втрачена.

Для пошуку раніше створених шаблонів виберіть у діалоговому вікні пошуку файли шаблона з розширенням .at

Для виконання прив'язок на Вікіданих, наполегливо рекомендується використовувати обліковий запис з прапорцем бота в обох проектах — і на Вікіданих, і куди заливається сама стаття.

Приклад

Приклад
Наприклад, шаблон на знімку екрану містить такий текст у полі «Шаблон назви сторінки»:

Користувач:SergoBot/Ген_{{{$1}}}

а в полі «Шаблон тексту сторінки» – такий:

{{Картка гена|{{{$3}}}}} '''{{{$1}}}''' – ген, розташований на {{{$2}}} хромосомі людини. Довжина поліпептидного ланцюга кодованого ним білка становить {{{$4}}}, а його молекулярна маса – {{{$5}}}. == Література == {{refbegin|2}} {{{$6}}} {{refend}} == Примітки == {{reflist}} == Див. також == * [[Хромосома {{{$2}}} (людина)|Хромосома {{{$2}}}]] {{protein-stub}}

В якості джерела даних вибрано файл «гени.xlsx» такого змісту:

A B C D E F
1 COPS7A 12 Q18039858 1234 999 * Книжка 1 * Книжка 2
2 BHLHE41 12 Q18046111 4321 888 * Книжка 3 * Книжка 4

При натисканні на кнопку «Переглянути» буде сформовано такий текст сторінки:

{{Картка гена|Q18039858}} '''COPS7A''' – ген, розташований на 12 хромосомі людини. Довжина поліпептидного ланцюга кодованого ним білка становить 1234, а його молекулярна маса – 999. == Література == {{refbegin|2}} * Книжка 1 * Книжка 2 {{refend}} == Примітки == {{reflist}} == Див. також == * [[Хромосома 12 (людина)|Хромосома 12]] {{protein-stub}}

і заголовок Користувач:SergoBot/Ген_COPS7A, під яким цей текст завантажувався б у Вікі.

При підстановці змінних, значення, які починаються на «*», або «#» підставляються у шаблон як елементи списків вікірозмітки.

Після натискання кнопки «Завантажити» для цього шаблону і джерела даних було завантажено дві статті: Користувач:SergoBot/Ген_COPS7A та Користувач:SergoBot/Ген_BHLHE41

Оновлення

Для оновлення необхідно розпакувати архів у папку з попередньою версією, замінивши всі існуючі файли.

Щоби зберегти усі версії програми, необхідно розпакувати нову версію в окрему папку. Після цього можна перенести налаштування з попередньої версії, скопіювавши файл налаштувань Settings.xml у папку з новою версією.