Модуль:File link/документація

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

Використання у вікітексті

У вікітексті, цей модуль має викликатися через шаблон, зазвичай {{file link}}. Будь ласка, дивіться сторінку шаблону щодо документації. Однак, його також можна викликати, використавши синтаксис {{#invoke:File link|main|аргументи}}.

Використання у модулі Lua

Спершу, вам необхідно імпортувати модуль.

local mFileLink = require('Module:File link')

Тоді ви зможете створити посилання на файли, використавши функцію _main.

mFileLink._main(args)

args — таблиця аргументів, що має наступні ключі:

• file — назва файлу. (обов'язковий)
• format — формат файлу, наприклад, «thumb», «thumbnail», «frame», «framed» або «frameless».
• formatfile — назва файлу, що зазначається з опцією формату «thumbnail». Зазначена назва файлу буде використана замість автоматично створеної мініатюри.
• border — встановіть true, «так» або «yes» (або будь-яке інше значення, що розпізнається як true модулем Модуль:Yesno), щоб встановити межі для зображення.
• location — горизонтальне вирівнювання файлу, наприклад, «right», «left», «center» або «none».
• alignment — вертикальне вирівнювання файлу, наприклад, «baseline», «middle», «sub», «super», «text-top», «text-bottom», «top» або «bottom».
• size — розмір зображення, наприклад, «100px», «x100px» або «100x100px».
• upright — параметр «upright», використовується для налаштування розміру високих і тонких зображень.
• link — сторінка, на яку має посилатися зображення. Використайте пустий рядок '', щоб не використовувати стандартне посилання на сторінку опису файлу.
• alt — альтернативний текст. Використайте пустий рядок '', щоб не використовувати стандартний альтернативний текст.
• caption — підпис файлу.
• page — встановлює номер сторінки для файлів з кількома сторінками, таких як PDF.
• class — додає параметр class до посилань зображень. Програмне забезпечення MediaWiki додає цей параметр до атрибута class="..." елемента зображення <img />, коли сторінка перетворюється в HTML.
• lang — додає атрибут мови, що зазначає якою мовою відображати файл.
• start — зазначає місце початку для аудіо і відеофайлів.
• end — зазначає місце кінця для аудіо і відеофайлів.
• thumbtime — зазначає час, який використовувати для створення мініатюри для відеофайлу.

Щоб побачити дію кожного з цих параметрів, дивіться сторінку допомоги щодо зображень на mediawiki.org.

Приклади

З лише опцією file:

mFileLink.main{file = 'Example.png'}
-- Відображається як [[File:Example.png]]

З опціями format, size, link та caption:

mFileLink.main{
	file = 'Example.png',
	format = 'thumb',
	size = '220px',
	link = 'Вікіпедія:Пісочниця',
	caption = 'Приклад.'
}
-- Відображається як [[File:Example.png|thumb|220px|link=Вікіпедія:Пісочниця|Приклад.]]

З опціями format, size та border:

mFileLink.main{
	file = 'Example.png',
	format = 'frameless',
	size = '220px',
	border = true
}
-- Відображається як [[File:Example.png|frameless|border|220px]]