Project:Упутства
Сврха ове странице јесте да корисницима SI Wiki да увид у процесе на викију и поједностављена упутства за праћење тих процеса. Опширнију помоћ у вези са МедијаВикијем можете наћи на MediaWiki.org.
Није неопходно да прочитате сва ова упутства пре уређивања. Штавише, већина уређивача обично не прочита ниједно од ових упутстава пре уређивања. Ако нисте планирали да се удубљујете у уређивање викија, најбржи начин да допринесете јесте да:
- погледате како постојећи садржај изгледа, па на основу њега додајете нови (на пример, уколико додајете страницу за рок, можете видети како изгледају странице са претходним таквим роковима), и
- ако се заглавите у уређивању, питате на SI Wiki Discord серверу.
Регистрација
Свако са Електротехничког факултета Универзитета у Београду има право да се региструје и да доприноси SI Wiki. Потребно је само отворити налог са својом студентском адресом е-поште (@student.etf.bg.ac.rs
) и потом је потврдити. (Иако се на неким местима могу видети помињања "захтевања налога", ово је само имплементациони детаљ и налози се могу самостално отварати док год су преко студентске адресе.)
Уколико сте наишли на неки проблем или недоумицу око процеса пријављивања, пријавите га администраторима. Регистрацијом на SI Wiki слажете се са правилима пројекта.
Након регистрације, могу вам бити од користи следеће везе:
- Ваша корисничка страница (уколико не постоји, можете на њу поставити информације о себи)
- Промена лозинке
- Ресетовање лозинке (уколико сте заборавили своју лозинку)
Хијерархија викија
Именски простори
На SI Wiki, као и на свим МедијаВики викијима (попут Википедије), већина корисничког садржаја организована је у странице. Свака страница има свој назив преко којег јој се приступа и садржај који се на њој приказује. Као један вид организације страница постоје именски простори, префикси назива страница који означавају основну функцију свих страница са тим префиксом. Неки од основних именских простора у МедијаВики су:
- Главни именски простор — У овом именском простору не постоји префикс испред страница и он се користи за садржај директно у вези са темом викија, странице за предмете, рокове и остале материјале. Странице у овом именском простору се обично називају чланцима.
Корисник:
— Странице и подстранице за сваког корисника викија.Корисник:Корисничко име
је обично главна страна за корисника са датим корисничким именом где се налазе информације о самом кориснику, а подстранице те странице се обично користе за тестирање и остале пројекте тог корисника.Project:
— Странице у вези са самим викијем, процесима и упутствима.Датотека:
— Странице на којима се налазе описи отпремљених датотека. Ови описи се генеришу из описа задатог на страници за отпремање датотека и више информација о њима се може наћи на Шаблон:File.МедијаВики:
— Странице које подешавају како вики изгледа. Доступне за уређивање само администраторима викија.Шаблон:
— Често коришћен викитекст може се претворити у шаблон у овом именском простору како би се олакшало његово коришћење на вики страницама.Категорија:
— Категорије су други основни облик организације страница на МедијаВики викијима. За разлику од именском простора, једна страница може припадати више категорија, и функција страница из неке категорије одређена је називом и описом те категорије.Модул:
— Пошто викитекст није програмски језик а нашим шаблонима понекад треба компликованија логика, овде се чува програмски код у Lua програмском језику који руководи уносним аргументима наших шаблона.Посебно:
— Ово није прави именски простор јер се у њему не чува кориснички садржај, већ се само користе за остале функционалности викија. Описане су даље у одељку испод.Медија:
— Ни ово није прави именски простор, већ именски простор који се користи за директне везе до датотека. На пример, када се посети веза до Датотека:M1 K3 - Rašajski (P2-3).pdf дође се на страницу са описом датотеке, док када се постави веза до Медија:M1 K3 - Rašajski (P2-3).pdf дође се до саме датотеке.
Овде су наведени само именски простори који се тренутно користе на SI Wiki. Шаблон:
, Модул:
и МедијаВики:
именски простори вам најчешће неће требати при уређивању на викију, а више о именским просторима можете прочитати на MediaWiki.org.
Посебне странице
Посебне странице су странице које се не могу уређивати и које се користе за посебне радње над осталим страницама. Све посебне странице су излистане овде, а испод су наведене неке од битнијих посебних страница:
- Посебно:Отпреми — Отпремање датотека. На страници се такође налазе поља за испуњавање при слању датотеке која ће бити аутоматски додата на страницу описа датотеке.
- Посебно:Подешавања — Разна подешавања вашег налога. Више о доступним подешавањима објашњено је у одељку испод.
- Посебно:СкорашњеИзмене и Посебно:Дневник — Сви скорашњи догађаји на викију. Вероватно вам је лакше да уместо овога користите заједнички канал комуникације о викију на ком се све ове измене појављују.
- Посебно:СтраницеСаПрефиксом — Излиставање свих страница у неком именском простору (на пример, Посебно:СтраницеСаПрефиксом/Корисник:, као и свих страница које почињу неким префиксом (на пример, Посебно:СтраницеСаПрефиксом/АСП1).
- Извештаји одржавања викија могу се видети на врху листе свих посебних страница. Ови извештаји указују на могуће грешке на викију, на пример, уколико се у Посебно:ТраженеСтранице појављује страница чији је назив очигледно погрешно написан тиме се могу наћи странице на којима је тај погрешан назив коришћен како би се исправиле.
Подешавања
Подешавања вашег налога се налазе на Посебно:Подешавања и подељена су на следеће одељке:
- Профил — Опште информације о вама, попут:
- Право име — уколико ово поставите, приказиваће се у ауторима страница које сте измењивали уместо "корисник на пројекту SI Wiki".
- Промена лозинке — Посебно:ПромениЛозинку
- Језик — у којем ће се приказивати интерфејс, између осталог садржи латиницу, ћирилицу (подразумевано) и енглески.
- Род — мушки, женски или неутрални
- Изглед — Подешавања како SI Wiki изгледа за вас, попут:
- Векторска, тамна векторска или безвременска тема (ову страницу можете погледати у тамној векторској теми овде, а у безвременској теми овде)
- Датум и време
- Да ли се садржај странице приказује испод разлика у верзијама или не
- Да ли се приказују сакривене категорије или не
- Уређивање — Подешавања уређивања.
- Уколико желите да подразумевано користите викитекст режим при уређивању, штиклирајте "Користи режим викитекста унутар визуелног уређивача."
- Справице — Локални CSS и JavaScript који вам може учинити уређивање лакшим
- Справица Инверзија боја, уколико сте на светлој теми, инвертује боје тако да тема буде још тамнија од тамне теме.
- Справице Учлањивање, Очисти кеш и Решења су подразумевано укључене справице за све чланове викија, али уколико знате да вам те функционалности нису потребне можете да их искључите.
Такође је вредно напоменути да уколико имате CSS или JavaScript који бисте желели да користите на SI Wiki, то можете урадити уређивањем ваших common.js и common.css корисничких подстраница.
Организација викија
Семестри
Сваки од 8 семестара основних академских студија Софтверског инжењерства има своју категорију (уколико у њој постоје предмети):
- Први семестар
- Други семестар
- Трећи семестар
- Четврти семестар
- Пети семестар
- Шести семестар
- Седми семестар
- Осми семестар
У тим категоријама налазе се искључиво странице предмета који припадају том семестру.
Предмети
Странице предмета се најлакше праве шаблоном на овој страници. Странице морају припадати категорији семестра у ком се налазе, као и категорији за обавезне односно изборне предмете.
На свакој страници предмета могу постојати следећи одељци по следећем редоследу:
- Странице — на којима се налазе везе (не обавезно спољашње), у вези са за предметом
- Предавања — чланци или материјали са или у вези са предавањима на предмету (шта се ради на предмету; где могу да се нађу материјали)
- Вежбе — чланци или материјали са или у вези са аудиторним или рачунским вежбама на предмету
- Корисне везе — спољашње везе које могу бити од помоћи у савлађивању градива
- Испитни рокови — чланци, датотеке или спољашње везе са задацима (и понекад решењима) са колоквијума или испита
- Домаћи задаци — у зависности од предмета, овде се налазе информације у вези са домаћим задацима као предиспитним обавезама
- Пројекат — слично као за домаће задатке
- Лаб вежбе — у зависности од предмета, овде се налазе информације у вези са лабораторијским вежбама као предиспитним обавезама
- Литература — у зависности од предмета, овде се налазе битне информације и савети везани за објављену литературу везану за предмет
- Начин оцењивања — правила формирања оцене за предмет по школским годинама
- Потребна помоћ — ствари у вези са тим предметом око којих је на викију потребна помоћ
- Овде користити
{{задаци|тип}}
ако желите да наведете најчешће ствари око којих је потребна помоћ, како би се те странице појавиле на главној страни за потребну помоћ.тип
може да буде један одrokovi
,rešenja
иprepis
.
- Овде користити
Предмети могу имати своје категорије којима припадају материјали у вези са предметом (документи, слике, итд.) као и чланци који припадају неком предмету (предавања, вежбе, рокови, домаћи задаци итд.)
Рокови
Чланци у вези са роковима садрже текстове испитних рокова на неком предмету. Они се обавезно налазе у категорији за рокове, као и категорији предмета коме припада, коју треба направити ако не постоји.
Облик именовања рокова је <Назив предмета>/<Тип рока> <Датум>, где је:
- назив предмета исти као назив чланка предмета,
- тип рока постављен на К1, К2 или К3 за колоквијуме, Лаб за лабораторијске вежбе и празан за интегралне испите, и
- датум у облику <Пун назива месеца> <Година (без тачке)>.
- Сви карактери треба да буду ћирилични
- Примери:
- Програмирање 2/К1П 2019
- Математика 2/Јун 2020
- ПОРТ/Лаб Јул 2020
На страницама предмета, у одељку Испитни рокови, налазе се везе до чланака. Подељени су по врсти рока (колоквијум, интегрални испит, парцијални испит и сл.), па онда по самом испитном року, од најскоријих до најдавнијих.
Препорука је да уколико постоји званично објављен испит да текстови буду што ближи оригиналу, али су свака додатна појашњења добродошла. Идеално је да када доприносите додавањем решења рока да ви будете аутор тог решења. Према правилима пројекта, корисници не одговарају за своје доприносе уколико су погрешни, све док су у добром духу. Све недоумице око решења могу се решити на страници разговора самог чланка.
Чланци рокова, као и генерално сви чланци који на врху немају са десне стране других елемената нити предугачак садржај, треба да имају садржај постављен на десној страни шаблоном {{tocright}}
, као и везу ка званичној верзији рока, уколико постоји.
Чланци рокова су подељени по делу испита (уколико постоји, нпр. теорија и задаци, питалице и задаци итд.), затим задацима, а сваки задатак, уколико се очекује да буде решен, треба да буде подељен на поставку и решење.
Препорука је да се делови дугих решења који нису кључни сакрију иза елемента за расклапање. За питања са кратким одговорима могу се користити спојлери. Таг са класом spoiler
означава неки део текста као решење, таг са класом solution
означава један елемент листе решења као тачно решење (за питања са више могућих одговора), док шаблон {{решења}}
формира упутства за горенаведене елементе и приказује дугме за њихово сакривање и откривање.
Интерактивни режим
SI Wiki подржава и интерактивни режим, где посетилац може да провери знање уносом одговора и провером кликом на тастер "Прикажи решење", као на платформи Moodle. За сада су подржани следећи формати питања:
- Питања са понуђеним одговорима, где је један тачан (
single
) - Питања са понуђеним одговорима, где су више одговора тачни (
multiple
) - Питање са пољем за унос (
text
) - Питања са падајућим менијем за избор (
select
) - Питања без начина уноса одговора (
plain
)
Уз сваку врсту питања могу се наћи и објашњења (explanation
)
Код | Изглед |
---|---|
<div class="mw-collapsible mw-collapsed" data-expandtext="Поступак">
Овде иде део поступка који не мора да буде видљив.
</div>
|
Овде иде део поступка који не мора да буде видљив. |
Задатак. <span class="spoiler" data-solution="text">Решење.</span>
|
Задатак. Решење. |
Задатак
<div class="abc-list" data-solution="single">
# Решење 1
# <span class="solution">Решење 2</span>
# Решење 3
</div>
'''Објашњење:''' <span class="spoiler" data-solution="explanation"> Објашњење. </span>
|
Задатак
Објашњење: Објашњење. |
Задатак са више тачних одговора
<div class="abc-list" data-solution="mutliple">
# Решење 1
# <span class="solution">Решење 2</span>
# Решење 3
</div>
|
Задатак са више тачних одговора
|
Задатак са падајућим менијем
<div data-solution="select" data-options="Решење 1,Решење 2,Решење 3,Решење 4,Решење 5,Решење 6">
# Питање 1 <span class="spoiler">Решење 3</span>
# Питање 2 <span class="spoiler">Решење 4</span>
# Питање 3 <span class="spoiler">Решење 6</span>
</div>
|
Задатак са падајућим менијем
|
Друга варијанта задатка са падајућим менијем
<div class="abc-sublist" data-solution="select">
# На Програмирању 1 уче се језици <span class="spoiler" data-options="mikroKnjiga, picoComputer, nanoLaptop">picoComputer</span> и <span class="spoiler" data-options="Pascal, Python, Prolog">Python</span>.
## mikroKnjiga / Pascal
## picoComputer / Python
## nanoLaptop / Prolog
# На Програмирању 2 испит се састоји из <span class="spoiler" data-options="питалица, патње">питалица</span> и <span class="spoiler" data-options="питалица, задатака, бола">задатака</span>.
## питалица / питалица
## питалица / задатака
## патње / бола
</div>
|
Друга варијанта задатка са падајућим менијем
|
Пример без уноса одговора <syntaxhighlight lang="bash" class="spoiler" data-solution="plain"> find . -type f -size +10M </syntaxhighlight> |
Пример без уноса одговора
find . -type f -size +10M
|
Датотеке
Датотеке можете отпремити помоћу посебне странице за то. Уколико јесте аутор датотеке које отпремате, изаберите ту лиценцу. Уколико нисте, а имате дозволу за отпремање, изаберите ту лиценцу, а у супротном изаберите подразумевану лиценцу.
Материјали у облику датотека морају да поштују правила именовања. Ако је датотека у вези са предметом, прва ствар у њеном називу је скраћено име тог предмета. Скраћена имена предмета могу се наћи овде. Уколико не постоји скраћено име предмета, усвојите разумну претпоставку.
Датотеке у вези са роковима, одмах после назива предмета треба да имају и назив рока, као и број задатка, ако су у вези са задатком.
Уколико имате недоумица, погледајте остале датотеке у вези са предметом и примените најсличнију шему именовања.
Уређивање
Историјски, једна од највећих баријера уређивача на МедијаВики викијима јесте недостатак познавања целе процедуре уређивања. SI Wiki је пројекат више фокусиран на сам садржај а мање на његову организацију, тако да је најлакше решење при свакој недоумици са уређивањем оставити садржај који планирате да допринесете у што више људски-читљивом облику на страници, јер иако форматирање тог садржаја испадне ружно или нечитљиво на самој страници, други уређивачи викија су ту да тај садржај доведу у пристојан облик. Обично много више труда оде на прављење неког садржаја за вики него на његово форматирање, тако да није у интересу викија да због недостатка форматирања изгуби квалитетан садржај.
Ипак, уређивање је битан део учешћа на викију и било би вредно упознати се са његовим основама. Испод су већином дате везе до страница на званичном МедијаВики викију које објашњавају основе уређивања, али поред тих упутстава такође је добро:
- погледати који викитекст је коришћен на осталим страницама за потребе које вама требају при додавању новог садржаја, и
- питати остале уређиваче кроз које год комуникационе канале имате успостављене са њима.
Викитекст
На МедијаВики викијима, основни језик форматирања страница јесте викитекст. Викитекст може сам по себи бити значајно компликован, али за потребе SI Wiki биће вам потребни само неки његови основни делови, наведени на следећим страницама:
- Форматирање
- Везе (доступне међувики везе на SI Wiki можете наћи на Посебно:Међувики)
- Табеле
- Слике
Математичке формуле
За уредно и естетски прегледно исписивање математичких формула (као и делова текста који захтевају посебно форматирање) на викију, користи се . То је описни језик универзално прихваћен у академском свету за објављивање научних радова, као и књига. Уколико пишете математичке формуле на викију, најбоље је да их пишете користећи уоквирен <math>…</math>
таговима уместо обичним текстом.
За рад на викију, срећом, није неопходно познавати језик у ширини, већ само делове у вези са исписивањем математичких формула користећи amsmath
пакет. Постоји безброј упутства и водича на интернету, као на пример на WikiBooks-у, са доста корисних примера.
Код | Изглед |
---|---|
<math>P = \left\{
\begin{array}{ll}
0.3 \cdot K1 + 0.35 \cdot K2 + 0.35 \cdot K3 \\
0.3 \cdot K1 + I
\end{array}\right.
</math>
|
|
<math> \lim_{x \to a}{f(x)} = \infty </math>
|
|
<math>\int \frac{\sqrt[3]{x} + \sqrt{x}}{\sqrt[3]{x} + \sqrt[6]{x}}dx </math>
|
|
<math>\sum_{n = 1}^{+\infty} \frac{(2n+2)!}{\pi^n(n!)^2}</math>
|
Програмски код
Програмски код на викију се пише уоквирен у <syntaxhighlight lang="…">…</syntaxhighlight>
тагове, где се унутар тагова налази програмски код а у lang
атрибуту ознака језика, како би се јасно истакла његова синтакса. Ознаке језика могу бити било које из ове листе, попут c
, cpp
, html
. На SI Wiki такође постоји додатан језик milo
за истицање синтаксе псеудокода коришћеном у књизи Алгоритми и структуре података од Мила В. Томашевића, за лакше истицање синтаксе на чланцима у вези са алгоритмима и структурама података.
Код | Изглед |
---|---|
<syntaxhighlight lang="c"> #include <stdio.h> // Исписује "Hello world!". int main(void) { printf("Hello world!"); return 0; } </syntaxhighlight> |
#include <stdio.h>
// Исписује "Hello world!".
int main(void) {
printf("Hello world!");
return 0;
}
|
<syntaxhighlight lang="milo"> DECODE MORSE(msg) i = 0 new_msg = "" while msg[i] ≠ 0 do p = root while (msg[i] ≠ ' ') and (p ≠ nil) do if msg[i] = '.' then p = left(p) else if msg[i] = '-' then p = right(p) else ERROR(Invalid code) end_if i = i + 1 end_while i = i + 1 if (p = nil) or (sign(p) = 0) then ERROR(Invalid code) end_while new_msg = new_msg + sign(p) end_while return new_msg </syntaxhighlight> |
DECODE MORSE(msg)
i = 0
new_msg = ""
while msg[i] ≠ 0 do
p = root
while (msg[i] ≠ ' ') and (p ≠ nil) do
if msg[i] = '.' then
p = left(p)
else if msg[i] = '-' then
p = right(p)
else
ERROR(Invalid code)
end_if
i = i + 1
end_while
i = i + 1
if (p = nil) or (sign(p) = 0) then
ERROR(Invalid code)
end_while
new_msg = new_msg + sign(p)
end_while
return new_msg |
Дијаграми
Дијаграме попут графова или хијерархијских приказа је најбоље отпремати као слике на вики. Препоручује се коришћење draw.io за цртање дијаграма, али било који бесплатан софтвер за то са више формата извоза би требало да послужи. Дијаграме отпремајте као SVG датотеке уколико вам софтвер за цртање то дозвољава, а ако сте цртали кроз draw.io штиклирајте и опцију за чување дијаграма унутар SVG, како би неко могао тај дијаграм накнадно да уреди. Такође се препоручује да везу до изворне .drawio
датотеке додате као везу у напоменама датотеке.
Калкулатори
За потребе рачунања броја поена по пропозицијама неких предмета може се користити справица калкулатор. Имплементирање калкулатора се своди на дефиниснање променљивих и дефинисање израза. Дат је пример:
Код | Изглед |
---|---|
<div class="calculator"> * <math>A</math>: <span data-variable="A" data-max="50"></span> * <math>B</math>: <span data-variable="B" data-min="10"></span> * Сума: <span data-variable="Suma" data-expression="A B +"></span> * Оцена: <span data-expression="P 10 / ceil 5 max 10 min"></span> </div> |
|
Променљиве
Дефинисање променљивих се ради помоћу span тагова са атрибутима data-variable. Променљива не сме да се зове исто као оператор. Могући параметри за променљиве су:
Атрибут | Значење |
---|---|
data-min | Минимална вредност променљиве |
data-max | Максимална вредност променљиве |
data-step |
Корак у вредности променљиве |
Изрази
Изрази се дефинише као span таг са атрибутом data-expression. При промени вредности променљивих, вредност израза се аутоматски ажурира. Сама формула израза дефинише се у атрибуту data-expression, користећи обрнуту пољску нотацију (постфикс). Вредност израза се може накнадно користити као променљива, наводећи њен назив са data-variable атрибутом. Може се дефинисати константа тако што у data-expression упишете њену вредност а у data-variable њен назив. Табела могућих оператора:
Симбол у изразу | Операција |
---|---|
+ | Сабирање |
- | Одузимање |
* | Множење |
/ | Дељење |
% | Остатак при дељењу |
^ |
Степеновање |
max | Максимум 2 променљиве |
min | Минимум 2 променљиве |
round | Заокруживање променљиве на цео број |
floor | Заокруживање на доле |
ceil | Заокруживање на горе |
Динамичке листе страница
Динамичка излиставања страница се користе на викију како странице са листама рокова, лабова и осталих страница и подстраница не би морале да се ажурирају сваки пут кад се дода нова страница. Обично се могу препознати у викитексту као {{#dpl:|…}}
или <dpl>…</dpl>
. Упутство за њихово коришћење се налази овде, али се генерално сматрају напреднијим опцијама викитекста тако да уколико вам буде требала измена на некој динамичкој листи страница или нова динамичка листа страница можете се обратити неком од искуснијих уређивача викија да их среди.
Уколико мислите да нека динамичка листа страница треба да излистава неку новонаправљену страницу а она то не ради, покушајте да очистите кеш те странице коришћењем "Очисти кеш" дугмета у падајућем менију поред дугмета за уређивање (или у десној траци, уколико постоји).
Квалитет материјала
Иако SI Wiki прихвата сваки добронамерни допринос викију, неки стандарди квалитета садржаја морају да постоје у сврхе лакше организације. Испод су наведени типови отпремљеног материјала и означени као добри (материјал се може без много измена убацити на вики), прихватљиви (материјал ће моћи да се нађе на викију, али се охрабрује реконструкција материјала у квалитетнијем облику) и лоши (материјал ће вероватно моћи да се нађе са викија али неће бити на самом викију).
Слике
- Добро
- Слике дијаграма у SVG формату
- Прихватљиво
- Слике дијаграма у PNG формату — требало би да буду извезене као SVG
- Скениране слике дијаграма на папиру — требало би да буду исцртани у неком софтверу за цртање дијаграма
- Лоше
- Слике штампаних докумената (на пример, ОРТ2 рокова) — требало би да ти документи буду прекуцани, уколико се ради о роковима могу се убацити у одељак за потребну помоћ
- Слике куцаног текста (на пример, слике текста куцаног у Word или Notepad) — требало би да текст буде прекуцан, ако не аутоматски детектован са слике
- Слике папира — идеално би било када би текст био преписан, али је прихватљиво и ако се слике скенирају неком мобилном апликацијом а затим комбинују у PDF документе по логичкој повезаности
Документи
- Добро
- Изворни документи поставки рокова који нису доступни јавно
- Прихватљиво
- PDF документи писани специфично за вики — требало би да буду писани у викитексту
- Документи као колекције скенираних слика — идеално би било када би те слике биле прекуцане
- Лоше
- Документи који садрже једну слику — уместо тога отпремити слику
- Документи који се могу наћи из званичних извора и уз себе не носе никакве додатне информације (на пример, П2 рокови) — уместо тога само линковати до званичног извора