Project:Упутства

Сврха ове странице јесте да корисницима SI Wiki да увид у процесе на викију и поједностављена упуства за праћење тих процеса.

Регистрација

Свако са Електротехничког факултета Универзитета у Београду има право да се региструје и да доприноси СИ Викију. Пре регистрације, прочитајте чланак о пројекту, на коме се налазе правила и важне информације.

Уколико се слажете са правилима, пошаљите захтев за налог. Као доказ да сте са факултета, неопходно је да користите адресу е-поште са домена etf.bg.ac.rs или etf.rs. Када администратор одобри ваш нов налог, биће вам послата порука са привременом лозинком, коју ћете морати да промените при првом пријављивању. Након тога, успешно сте отворили налог и можете почети са уређивањем.

Уколико сте наишли на неки проблем или недоумицу око процеса пријављивања, пријавите га администратору.

Хијерархија викија

Именски простори

На 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 изгледа за вас, попут:
  • Векторска или безвременска тема (ову страницу можете погледати у безвременској теми овде)
  • Датум и време
  • Да ли се садржај странице приказује испод разлика у верзијама или не
  • Да ли се приказују сакривене категорије или не
• Уређивање — Подешавања уређивања.
  • Уколико желите да подразумевано користите викитекст режим при уређивању, штиклирајте "Користи режим викитекста унутар визуелног уређивача."
  • Уколико желите да користите стабилни викитекст уређивач из 2010 уместо бета верзије визуелног уређивача, штиклирајте "Привремено онемогући визуелни уређивач док је у бета фази."
• Справице — Локални CSS и JavaScript који вам може учинити уређивање лакшим
  • Справица Поправке тамне теме поправља тамну тему која је постављена помоћу Chrome заставице chrome://flags/#enable-force-dark
  • Справица Истицање синтаксе додаје истицање синтаксе викитекста у стари уређивач викитекста (визуелни уређивач већ има истицање синтаксе). Ово је подразумевано укључено али га можете искључити уколико вам не ради добро.

Такође је вредно напоменути да уколико имате CSS или JavaScript који бисте желели да користите на SI Wiki, то можете урадити уређивањем ваших common.js и common.css корисничких подстраница.

Организација викија

Семестри

Сваки од 8 семестра основних академских студија Софтверског инжењерства има своју категорију:

• Први семестар
• Други семестар
• Трећи семестар
• Четврти семестар
• Пети семестар
• Шести семестар
• Седми семестар
• Осми семестар
• Мастер - зимски семестар

У тим категоријама налазе се искључиво странице предмета који припадају том семестру.

Предмети

Странице предмета се најлакше праве шаблоном на овој страници. Странице морају припадати категорији семестра у ком се налазе, као и категорији за обавезне односно изборне предмете.

На свакој страници предмета могу постојати следећи одељци по следећем редоследу:

• Странице — на којима се налазе везе (не обавезно спољашње), у вези са за предметом
• Предавања — чланци или материјали са или у вези са предавањима на предмету
• Вежбе — чланци или материјали са или у вези са аудиторним или рачунским вежбама на предмету
• Корисне везе — спољашње везе које могу бити од помоћи у савлађивању градива
• Испитни рокови — чланци или спољашње везе са задацима са колоквијума или испита
• Домаћи задаци — у зависности од предмета, овде се налазе информације у вези са домаћим задацима као предиспитним обавезама
• Лаб вежбе — у зависности од предмета, овде се налазе информације у вези са лабораторијским вежбама као предиспитним обавезама
• Начин оцењивања — Правила формирања оцене за предмет по школским годинама

Предмети могу имати своје категорије којима припадају материјали у вези са предметом (документи, слике, итд.) као и чланци који припадају неком предмету (предавања, вежбе, рокови, домаћи задаци итд.)

Рокови

Чланци у вези са роковима садрже текстове испитних рокова на неком предмету. Они се обавезно налазе у категорији за рокове, као и категорији предмета уколико постоји.

Облик именовања рокова је <Назив предмета>/<Тип рока> <Датум>, где је:

• назив предмета исти као назив чланка предмета,
• тип рока постављен на К1, К2 или К3 за колоквијуме, Лаб за лабораторијске вежбе и празан за интегралне испите, и
• датум у облику <Пун назива месеца> <Година (без тачке)>.
• Примери:
  • Програмирање 2/К1П 2019
  • Математика 2/Јун 2020
  • ПОРТ/Лаб Јул 2020

На страницама предмета, у одељку Испитни рокови, налазе се везе до чланака. Подељени су по врсти рока (колоквијум, интегрални испит, парцијални испит и сл.), па онда по самом испитном року, од најскоријих до најдавнијих.

Препорука је да уколико постоји званично објављен испит да текстови буду што ближи оригиналу, али су свака додатна појашњења добродошла. Идеално је да када доприносите додавањем решења рока да ви будете аутор тог решења. Према правилима пројекта, корисници не одговарају за своје доприносе уколико су погрешни, све док су у добром духу. Све недоумице око решења могу се решити на страници разговора самог чланка.

Чланци рокова, као и генерално сви чланци који на врху немају са десне стране других елемената нити предугачак садржај, треба да имају садржај постављен на десној страни шаблоном {{tocright}}, као и везу ка званичној верзији рока, уколико постоји.

Чланци рокова су подељени по делу испита (уколико постоји, нпр. теорија и задаци, питалице и задаци итд.) на нивоу наслова, затим задаци на нивоу првог поднаслова, а сваки задатак треба да има два поднаслова на нивоу 2 који се зову Поставка и Решење (поред тога што задатак можда тренутно није решен).

Препорука је да се делови дугих решења који нису кључни сакрију иза елемента за расклапање. Алтернативно, за питања са кратким одговорима могу се користити спојлери. Таг са класом unhide-spoilers формира дугме за приказ свих решења на страници, а таг са класом spoiler означава неки део текста као решење.

Примери сакривања решења:

Код	Изглед
<div class="mw-collapsible mw-collapsed" data-expandtext="Поступак"> Овде иде део поступка који не мора да буде видљив. </div>	Овде иде део поступка који не мора да буде видљив.
<div class="unhide-spoilers"></div> Задатак. <span class="spoiler">Решење.</span>	Задатак. Решење.

Датотеке

Датотеке можете отпремити помоћу ове посебне странице. Уколико нисте аутор датотеке или нисте сигурни ко је, одаберите подразумевану лиценцу.

Материјали у облику датотека морају да поштују правила именовања. Ако је датотека у вези са предметом, прва ствар у њеном називу је скраћено име тог предмета. Скраћена имена предмета могу се наћи овде. Уколико не постоји скраћено име предмета, усвојите разумну претпоставку.

Пример: Датотека:ORT1 Uputstvo za projektovanje MS flip-flopova.pdf

Датотеке у вези са роковима, одмах после назива предмета треба да имају и назив рока, као и број задатка, ако су у вези са задатком.

Пример: Датотека:ASP1 jul 2020 zadatak 3.2 rešenje.png

Уколико имате недоумица, погледајте остале датотеке у вези са предметом и примените најсличнију шему именовања.

Уређивање

Историјски, једна од највећих баријера уређивача на МедијаВики викијима јесте недостатак познавања целе процедуре уређивања. SI Wiki је пројекат више фокусиран на сам садржај а мање на његову организацију, тако да је најлакше решење при свакој недоумици са уређивањем оставити садржај који планирате да допринесете у што више људски-читљивом облику на страници, јер иако форматирање тог садржаја испадне ружно или нечитљиво на самој страници, други уређивачи викија су ту да тај садржај доведу у пристојан облик. Обично много више труда оде на прављење неког садржаја за вики него на његово форматирање, тако да није у интересу викија да због недостатка форматирања изгуби квалитетан садржај.

Ипак, уређивање је битан део учешћа на викију и било би вредно упознати се са његовим основама. Испод су већином дате везе до страница на званичном МедијаВики викију које објашњавају основе уређивања, али поред тих упутстава такође је добро:

• погледати који викитекст је коришћен на осталим страницама за потребе које вама требају при додавању новог садржаја, и
• питати остале уређиваче кроз које год комуникационе канале имате успостављене са њима.

Викитекст

На МедијаВики викијима, основни језик форматирања страница јесте викитекст. Викитекст може сам по себи бити значајно компликован, али за потребе SI Wiki биће вам потребни само неки његови основни делови, наведени на следећим страницама:

• Форматирање
• Везе (доступне међувики везе на SI Wiki можете наћи на Посебно:Међувики)
• Табеле
• Слике

Визуелни уређивач

Поред уређивања викитекста, на SI Wiki је такође инсталиран визуелни уређивач који са интефејсом сличним данашњим WYSIWYG уређивачима докумената омогућава уређивање викитекста. Детаљно упуство коришћења визуелног уређивача може се наћи овде. Свакако, за напредније опције викитекста као и интерактивнији садржај на викију предлаже се коришћење викитекст уређивача, који можете поставити као подразумевани у својим подешавањима.

Математичке формуле

За уредно и естетски прегледно исписивање математичких формула (као и делова текста који захтевају посебно форматирање) на викију, користи се $\mathrm{L}\!\!^{{}_{\scriptstyle \mathrm{A}}} \!\!\!\!\!\;\;\mathrm{T}\!_{\displaystyle \mathrm{E}} \!\mathrm{X}$. То је описни језик универзално прихваћен у академском свету за објављивање научних радова, као и књига. Уколико пишете математичке формуле на викију, најбоље је да их пишете користећи LaTeX уоквирен <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>	$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> \lim_{x \to a}{f(x)} = \infty </math>	$\lim_{x \to a}{f(x)} = \infty$
<math>\int \frac{\sqrt[3]{x} + \sqrt{x}}{\sqrt[3]{x} + \sqrt[6]{x}}dx </math>	$\int \frac{\sqrt[3]{x} + \sqrt{x}}{\sqrt[3]{x} + \sqrt[6]{x}}dx$
<math>\sum_{n = 1}^{+\infty} \frac{(2n+2)!}{\pi^n(n!)^2}</math>	$\sum_{n = 1}^{+\infty} \frac{(2n+2)!}{\pi^n(n!)^2}$

Програмски код

Програмски код на викију се пише уоквирен у <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 датотеку, ради бољег квалитета. Такође се препоручује да веза до изворне .drawio датотеке додате као везу у напоменама датотеке како би будући уређивачи могли да се њоме служе уколико буду мењали тај дијаграм.

Динамичке листе страница

Динамичка излиставања страница се користе на викију како странице са листама рокова, лабова и осталих страница и подстраница не би морале да се ажурирају сваки пут кад се дода нова страница. Обично се могу препознати у викитексту као {{#dpl:|…}} или <dpl>…</dpl>. Упутство за њихово коришћење се налази овде, али се генерално сматрају напреднијим опцијама викитекста тако да уколико вам буде требала измена на некој динамичкој листи страница или нова динамичка листа страница можете се обратити неком од искуснијих уређивача викија да их среди.

Уколико мислите да нека динамичка листа страница треба да излистава неку новонаправљену страницу а она то не ради, покушајте да очистите кеш те странице додавањем ?action=purge на крај URL-а странице.