Шаблон:Файл/doc: различия между версиями

Материал из Space Station 14 Вики
обновил документацию. Можно использовать как /, так и \
мНет описания правки
 
(не показано 5 промежуточных версий 2 участников)
Строка 1: Строка 1:
'''{{t|Файл}}''' — универсальный шаблон для оформления описаний файлов, загружаемых на вики. Поддерживает как игровые спрайты, так и прочие графические файлы. Автоматизирует подстановку данных по id, позволяет указывать источник, проект, путь и автора файла.
Обязателен к вызову и заполнению у каждого файла, также как и указание лицензии. См. {{ссылка на раздел|SS14W:Файлы#Лицензии}}.
== Шаблон для копирования ==
== Шаблон для копирования ==
<pre>{{Файл
|Описание = <!--Название изображения здесь-->
|Id      = <!--Id из кода игры-->
|Сервера  = <!--Смотрим Шаблон:abb-->
|Источник = <!--Ссылка на источник-->
|Путь    = <!--Путь к файлу, начиная с Resources, обязательно для спрайтов из общего доступа-->
|Теги    = <!--Возможный список тегов будет позже-->
}}</pre>
== Параметры ==
{{OptionsTable
|content =


{{OptionsLine
=== Для файлов игры ===
|option = Описание
<pre>
|desc   = Используется для уточнения, расшифровки аббревиатур в названии (пример: СМЭС), описания скриншотов, рендеров.
{{Файл
|status = Обязательный для скриншотов, рендеров, а также при наличии аббревиатур.
|Описание =
|Id      =  
|Проект   =  
|Путь    =
|Автор    =
}}
}}
</pre>


{{OptionsLine
=== Для прочих изображений ===
|option = Id
<pre>
|desc  = Использует Id предмета из файлов игры и добавляет его в строчку "Описание" в начало строки. Если ввести неверный Id, то будет выведет текст "Не найдено".
{{Файл
|status = Обязательный для спрайтов предметов из игры. Для иных файлов не заполняется.
|Описание =  
|Источник =  
|Автор    =
}}
}}
</pre>


{{OptionsLine
== Параметры ==
|option = Сервера
{{Параметры|
|desc  = Определяет принадлежность файла к серверу. Опирается на [[Шаблон:abb]], сервера указываются через запятую.
{{Параметры/строка|Описание|Используется для пояснения, расшифровки аббревиатур в названии (например, СМЭС), а также для описания скриншотов и рендеров.|Нет; автоматически заполняется названием предмета по id, если это файл. В остальных случаях желателен.}}
|status = Обязательный для всех файлов
{{Параметры/строка|Id|Идентификатор сущности, выводимой, если это спрайт из игровых файлов. Используется в других параметрах для автоматического подстановки строк.|Да, если это спрайт из файлов игры.}}
{{Параметры/строка|Проект|Указывает, к какому проекту относится файл. Опирается на шаблоне {{шс|abb}}; сервера перечисляются через запятую.|Да, для всех файлов подпроектов. Также желательно указывать {{шс|abb|SS14}} для файлов из основной игры.}}
{{Параметры/строка|Путь|Путь к спрайту от папки "<code>Resources</code>" до папки с файлом. Допустимо использовать как "<code>/</code>", так и "<code>\</code>" в качестве разделителя. Если файл собран из нескольких файлов из разных папок, путь указывается для каждой из них.|Нет; может выводиться по id.}}
{{Параметры/строка|Источник|Ссылка на источник, откуда был получен файл. Если файл собран из нескольких источников (например, разных папок на GitHub), необходимо указать ссылки на каждый уникальный источник.|Да, при использовании файлов, полученных не с ресурсов space-syndicate.}}
{{Параметры/строка|Автор|Имя или псевдоним автора произведения.|Нет; автоматически заполняется из <code>meta.json</code> по id, если доступен. В остальных случаях указывается в соответствии с условиями лицензии.}}
}}
}}


{{OptionsLine
== Пример использования ==
|option = Источник
На основе [[:Файл:CableApcStack.png]].
|desc   = Ссылка на источник (для спрайтов из репозитория - ссылка на папку со спрайтом), откуда скачан файл или "Личная работа" (например: скриншоты, рендеры, спрайты, нарисованные для Вики). Если файл собран из других файлов, у которых источники отличаются (например, разные папки на github), то ссылки должны быть указаны на каждый уникальный источник. Разделяйте ссылки при помощи <nowiki>be</nowiki>.
{{начало цитаты}}
|status = Обязательный
<pre>
== Краткое описание ==
{{Файл
|Описание =  
|Id      = CableApcStack
|Проект   = {{abb|SS14}}
|Автор    =
|Источник =
|Путь    =  
}}
}}


{{OptionsLine
== Лицензирование ==
|option = Путь
{{CC-BY-SA-3.0}}
|desc   = Путь к спрайту, начиная с папки "Resources" и заканчивая папкой с файлом. Допускается использование как "<code>/</code>", так и "<code>\</code>" в качестве разделителя. Если файл собран из других файлов, у которых папки отличаются, то путь должен быть указан указан на каждую папку.
</pre>
|status = Обязательный для спрайтов из репозитория. Разделяйте пути при помощи <nowiki>be</nowiki>.
{{оригинальный текст||
== Краткое описание ==
{{Файл
|Описание =  
|Id      = CableApcStack
|Проект   = {{abb|SS14}}
|Автор    =
|Источник =
|Путь    =  
}}
}}


{{OptionsLine
== Лицензирование ==
|option = Теги
{{CC-BY-SA-3.0}}
|desc  = Теги указываются через запятую, смотрим [[#Теги]]
|status = Обязательный
}}
}}
{{конец цитаты}}


На основе [[:Файл:Information icon4.svg]].
{{начало цитаты}}
<pre>
== Краткое описание ==
{{Файл
|Описание = Wikipedia port
|Источник = https://ru.wikipedia.org/wiki/%D0%A4%D0%B0%D0%B9%D0%BB:Information_icon4.svg
|Автор    =
}}
}}


== Теги ==
== Лицензирование ==
Просто список тегов (пока так):
{{PD-self}}
</pre>
{{оригинальный текст||
== Краткое описание ==
{{Файл
|Описание = Wikipedia port
|Источник = https://ru.wikipedia.org/wiki/%D0%A4%D0%B0%D0%B9%D0%BB:Information_icon4.svg
|Автор    =
}}


Теги еды:
== Лицензирование ==
Еда, суп, салат, бургер, пирог, мясо, ингредиент, кебаб
{{PD-self}}
 
}}
ОТДЕЛЫ:
{{конец цитаты}}
 
Командование:
КОМ, капитан, ЦК, ДСО
 
Служба безопасности:
СБ, кадет, офицер, детектив, глава службы безопасности, департамент СБ
 
Сервис:
СЕР, гидропоника, кухня, напиток, еда, бутылка, уборка, музыкальный, клаксон
 
Снабжение:
СНБ, грузчик, утилизатор, квартирмейстер,
 
Научно-исследовательский отдел:
НИО, научный ассистент, учёный, научный руководитель, cиликон, боты, прибор
 
Медицинский:
МЕД, интерн, врач, химик, психолог, парамедик, главный врач, химия, хирургия, пила, скальпель
 
Инженерный:
ИНЖ, сингулярность, электричество, генератор, компьютер, УЧ, солнечные панели, кабель, инженер, технический ассистент, атмосферный техник, старший инженер
 
Антагонисты:
Синдикат, ревенант
 
Прочие роли:
Животные, карпы, призраки, паук
 
Оружие:
Оружие, пистолет, ПП, лёгкий пулемёт, огнестрельное, лазерное, импульсное, магазин, стан, ближний бой, энергетическое, граната, бомба, пусковая установка
 
Без категории:
Сигареты, пачка, свет, канистра, ДСО, ящик, ключ шифрования, мыло, инструмент, гарнитура, игрушка, торговый автомат, хранилище
 
Одежда:
Одежда, маска, обувь, клоун, вещмешок, аптечка, юбка, кобура, перчатки, бронежилет, шляпа, скафандр
 
 
 
Прочее:
Лор, действие, интерфейс, шаттл, рендер, станция, комната, иконка, скриншот, персонаж

Текущая версия от 22:39, 18 апреля 2025

{{Файл}} — универсальный шаблон для оформления описаний файлов, загружаемых на вики. Поддерживает как игровые спрайты, так и прочие графические файлы. Автоматизирует подстановку данных по id, позволяет указывать источник, проект, путь и автора файла.

Обязателен к вызову и заполнению у каждого файла, также как и указание лицензии. См. SS14W:Файлы § Лицензии.

Шаблон для копирования

Для файлов игры

{{Файл
|Описание = 
|Id       = 
|Проект   = 
|Путь     = 
|Автор    =
}}

Для прочих изображений

{{Файл
|Описание = 
|Источник = 
|Автор    =
}}

Параметры

ПараметрОписаниеОбязателен?
|Описание =Используется для пояснения, расшифровки аббревиатур в названии (например, СМЭС), а также для описания скриншотов и рендеров.Нет; автоматически заполняется названием предмета по id, если это файл. В остальных случаях желателен.
|Id =Идентификатор сущности, выводимой, если это спрайт из игровых файлов. Используется в других параметрах для автоматического подстановки строк.Да, если это спрайт из файлов игры.
|Проект =Указывает, к какому проекту относится файл. Опирается на шаблоне {{abb}}; сервера перечисляются через запятую.Да, для всех файлов подпроектов. Также желательно указывать {{abb|SS14}} для файлов из основной игры.
|Путь =Путь к спрайту от папки "Resources" до папки с файлом. Допустимо использовать как "/", так и "\" в качестве разделителя. Если файл собран из нескольких файлов из разных папок, путь указывается для каждой из них.Нет; может выводиться по id.
|Источник =Ссылка на источник, откуда был получен файл. Если файл собран из нескольких источников (например, разных папок на GitHub), необходимо указать ссылки на каждый уникальный источник.Да, при использовании файлов, полученных не с ресурсов space-syndicate.
|Автор =Имя или псевдоним автора произведения.Нет; автоматически заполняется из meta.json по id, если доступен. В остальных случаях указывается в соответствии с условиями лицензии.

Пример использования

На основе Файл:CableApcStack.png.

== Краткое описание ==
{{Файл
|Описание = 
|Id       = CableApcStack
|Проект   = {{abb|SS14}}
|Автор    = 
|Источник = 
|Путь     = 
}}

== Лицензирование ==
{{CC-BY-SA-3.0}}

На основе Файл:Information icon4.svg.

== Краткое описание ==
{{Файл
|Описание = Wikipedia port
|Источник = https://ru.wikipedia.org/wiki/%D0%A4%D0%B0%D0%B9%D0%BB:Information_icon4.svg
|Автор    = 
}}

== Лицензирование ==
{{PD-self}}