Difference between revisions of "Main Page"

From Stepik Wiki
Jump to: navigation, search
Line 1: Line 1:
Consult the [//meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.
+
<big>Добро пожаловать на [[#top|Stepik Wiki]], сборник конспектов курсов платформы для онлайн-обучения [http://www.stepik.org Stepik], который [[#Кто может редактировать|может редактировать каждый]].</big>
  
== Courses ==
+
== Что это и зачем нужно ==
 +
 
 +
 
 +
Идея создания данной wiki пришла при поптыке решить две проблемы:
 +
 
 +
* В процессе прохождении курса на [http://www.stepik.org stepik] (например при решении задачи) пользователю понадобилась некоторая информация (формула, определение, команда bash и т.д.), которая была где-то раньше в этом курсе (в видео), но пользователь точно не помнит где. Искать нужную информацию во множестве видеозаписей сложно, долго, неудобно.
 +
* Пользователь прошел курс, а через полгода-год ему понадобилась эта информация где-то (на экзамене, собеседовании, по работе и т.д.), и нужно в максимально короткий срок повторить ее. Делать это по видео сложно, т.к. ничего лучше, чем просмотреть все заново на 2x скорости не придумаешь.
 +
 
 +
 
 +
Обе эти проблемы решаются при наличии у пользователя конспекта курса, т.к. искать информацию в тексте значительно проще, а при повторении можно просмотреть его по диагонали и останавливаться только на самых непонятных моментах. Но писать конспект самостоятельно у пользователей не вегда есть возможность, преподаватели предоставляют конспекты своих курсов довольно редко, а у команды stepik-а нет ресурсов на написание конспектов по всем курсам, представленным на платформе.
 +
 
 +
 
 +
Решение, предлагаемое на данной wiki, состоит из двух этапов:
 +
# Автоматическая генерация чернового варианта конспекта
 +
# Совместное редактирование пользователями, благодаря механизму [https://ru.wikipedia.org/wiki/%D0%92%D0%B8%D0%BA%D0%B8 wiki].
 +
 
 +
 
 +
Таким образом у пользователей, у которых нет возможности писать конспект, появляется доступ к готовым, представленным на данной wiki.
 +
 
 +
Пользователям, у которых есть возможность и желание писать конспект, данная wiki предоставляет возможность:
 +
* писать конспект прикладывая меньше усилий (т.к. есть черновой вариант)
 +
* получать в итоге более качественный конспект (т.к. другие пользователи будут помогать в его написании)
 +
* поделиться ранее написанными и создаваемыми конспектами с другими пользователями, помогая им учиться, а stepik-у развиваться.
 +
 
 +
 
 +
== Структура конспектов ==
 +
 
 +
Структура конспектов повторяет структуру сущностей на stepik-е и реализована с помощью механизма [https://www.mediawiki.org/wiki/Help:Categories/ru категорий].
 +
На stepik-е представлены следующие сущности:
 +
* Курс
 +
* Модуль
 +
* Урок
 +
* Шаг
 +
 
 +
[[File:Stepik structure.png|framed|Структура сущностей на Stepik]]
 +
 
 +
Причем контент (видео, теория, задачи) находится только в шагах, а остальные сущности представляют собой списки более мелких сущностей.
 +
 
 +
Некоторые особенности:
 +
* Каждый шаг входит ровно в 1 урок
 +
* Каждый урок может входить в произвольное число модулей
 +
* Каждый модуль входит ровно в 1 курс
 +
 
 +
 
 +
Таким образом, для каждой сущности создаётся страница на wiki. Причем страницы курса, модуля и урока являются категориями. Для обозначения, что, например, шаг Some_Step входит в урок Some_Lesson, на странице шага добавляется строка <code><nowiki>[[Category:Some_Lesson|  n]]</nowiki></code>, где n -- позиция шага в уроке, таки образом, на странице урока появился ссылка на шаг, и на странице шага будет ссылка на урок, в которых он входит.
 +
 
 +
Посмотреть все категории, в которые входит страница можно в самом низу страницы. Т.е. там можно увидеть: для шага -- урок в который он входит, для урока -- все модули, в которые он входит, для модуля -- курс.
 +
 
 +
 
 +
''Не рекомендуется менять всё, что связано с категориями, т.к. эта информация формируется автоматечески и нужна для формирования и поддержания актуальной структуры страниц.''
 +
 
 +
 
 +
== Кто может редактировать ==
 +
 
 +
Для того, чтобы начать вносить правки нужно войти под своим stepik-аккаунтом, сделать это можно нажав на <code>Log in / create account with Stepik</code> в верхнем правом углу страницы.
 +
 
 +
== Краткое руководство ==
 +
 
 +
=== Форматирование ===
 +
 
 +
Для форматирования используется [https://www.mediawiki.org/wiki/Help:Formatting/ru вики-разметка].
 +
 
 +
Основные возможности по форматированию предоставляет [https://www.mediawiki.org/wiki/Extension:WikiEditor/ru Wikieditor]
 +
[[File:Wikieditor.png|framed|none|Wikieditor]]
 +
 
 +
=== Изображнения ===
 +
 
 +
Есть 2 способа вставить изображение на страницу:
 +
 
 +
* Тег [http://htmlbook.ru/html/img img], используется для вставки изображений с внешних ресурсов.
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Текст на странице !! Результат
 +
|-
 +
| <code><nowiki><img src="https://stepik.org/static/classic/ico/favicon_128.png"></nowiki></code> || <img src="https://stepik.org/static/classic/ico/favicon_128.png">
 +
|}
 +
 
 +
* Загрузка изображения на wiki.
 +
 
 +
Чтобы добавить на страницу изображение, которое уже загружено на wiki, можно воспользоваться Wikieditor-ом:
 +
 
 +
[[File:Img tutorial 1.png|framed|none|200px|Вставка изображения]]
 +
 
 +
 
 +
Далее нужно ввести имя загруженного файла и необходимые параметры, а затем нажать "вставка".
 +
 
 +
[[File:Img tutorial 2.png|framed|none|Вставка изображения]]
 +
 
 +
 
 +
Список уже загруженных файлов есть [[Special:ListFiles|тут]]
 +
 
 +
 
 +
Если же нужного файла еще нету, то нужно нажать "Загрузить", пройти процедуру загрузки файла, а затем вернуться к вставке.
 +
 
 +
 
 +
В итоге в текст добавиться строка вроде такой <code><nowiki>[[File:Some file.png|framed|none|Some file]]</nowiki></code>.
 +
 
 +
 
 +
Более подробно про вставку изображений можно почитать [https://www.mediawiki.org/wiki/Help:Images/ru тут]
 +
 
 +
 
 +
Второй способ сложнее, но предоставляет намного больше возможностей по настройке того, как будет отображаться изображение.
 +
 
 +
=== Подсветка синтаксиса ===
 +
Для подсветки синтаксиса используется тег <code>syntaxhighlight</code>
 +
 
 +
Пример разметки:
 +
 
 +
<nowiki>
 +
<syntaxhighlight lang="python" line='line'>
 +
def quickSort(arr):
 +
    less = []
 +
    pivotList = []
 +
    more = []
 +
    if len(arr) <= 1:
 +
        return arr
 +
    else:
 +
        pass
 +
</syntaxhighlight></nowiki>
 +
 
 +
Результат:
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
def quickSort(arr):
 +
less = []
 +
pivotList = []
 +
more = []
 +
if len(arr) <= 1:
 +
return arr
 +
else:
 +
pass
 +
</syntaxhighlight>
 +
 
 +
Подробнее [https://www.mediawiki.org/wiki/Extension:SyntaxHighlight тут]
 +
 
 +
== Курсы ==
 +
 
 +
Список курсов, по кторотым сгенерированны конспекты:
  
 
{{#categorytree:Category:Courses}}
 
{{#categorytree:Category:Courses}}

Revision as of 13:35, 27 July 2017

Добро пожаловать на Stepik Wiki, сборник конспектов курсов платформы для онлайн-обучения Stepik, который может редактировать каждый.

Что это и зачем нужно

Идея создания данной wiki пришла при поптыке решить две проблемы:

  • В процессе прохождении курса на stepik (например при решении задачи) пользователю понадобилась некоторая информация (формула, определение, команда bash и т.д.), которая была где-то раньше в этом курсе (в видео), но пользователь точно не помнит где. Искать нужную информацию во множестве видеозаписей сложно, долго, неудобно.
  • Пользователь прошел курс, а через полгода-год ему понадобилась эта информация где-то (на экзамене, собеседовании, по работе и т.д.), и нужно в максимально короткий срок повторить ее. Делать это по видео сложно, т.к. ничего лучше, чем просмотреть все заново на 2x скорости не придумаешь.


Обе эти проблемы решаются при наличии у пользователя конспекта курса, т.к. искать информацию в тексте значительно проще, а при повторении можно просмотреть его по диагонали и останавливаться только на самых непонятных моментах. Но писать конспект самостоятельно у пользователей не вегда есть возможность, преподаватели предоставляют конспекты своих курсов довольно редко, а у команды stepik-а нет ресурсов на написание конспектов по всем курсам, представленным на платформе.


Решение, предлагаемое на данной wiki, состоит из двух этапов:

  1. Автоматическая генерация чернового варианта конспекта
  2. Совместное редактирование пользователями, благодаря механизму wiki.


Таким образом у пользователей, у которых нет возможности писать конспект, появляется доступ к готовым, представленным на данной wiki.

Пользователям, у которых есть возможность и желание писать конспект, данная wiki предоставляет возможность:

  • писать конспект прикладывая меньше усилий (т.к. есть черновой вариант)
  • получать в итоге более качественный конспект (т.к. другие пользователи будут помогать в его написании)
  • поделиться ранее написанными и создаваемыми конспектами с другими пользователями, помогая им учиться, а stepik-у развиваться.


Структура конспектов

Структура конспектов повторяет структуру сущностей на stepik-е и реализована с помощью механизма категорий. На stepik-е представлены следующие сущности:

  • Курс
  • Модуль
  • Урок
  • Шаг
Структура сущностей на Stepik

Причем контент (видео, теория, задачи) находится только в шагах, а остальные сущности представляют собой списки более мелких сущностей.

Некоторые особенности:

  • Каждый шаг входит ровно в 1 урок
  • Каждый урок может входить в произвольное число модулей
  • Каждый модуль входит ровно в 1 курс


Таким образом, для каждой сущности создаётся страница на wiki. Причем страницы курса, модуля и урока являются категориями. Для обозначения, что, например, шаг Some_Step входит в урок Some_Lesson, на странице шага добавляется строка [[Category:Some_Lesson| n]], где n -- позиция шага в уроке, таки образом, на странице урока появился ссылка на шаг, и на странице шага будет ссылка на урок, в которых он входит.

Посмотреть все категории, в которые входит страница можно в самом низу страницы. Т.е. там можно увидеть: для шага -- урок в который он входит, для урока -- все модули, в которые он входит, для модуля -- курс.


Не рекомендуется менять всё, что связано с категориями, т.к. эта информация формируется автоматечески и нужна для формирования и поддержания актуальной структуры страниц.


Кто может редактировать

Для того, чтобы начать вносить правки нужно войти под своим stepik-аккаунтом, сделать это можно нажав на Log in / create account with Stepik в верхнем правом углу страницы.

Краткое руководство

Форматирование

Для форматирования используется вики-разметка.

Основные возможности по форматированию предоставляет Wikieditor

Wikieditor

Изображнения

Есть 2 способа вставить изображение на страницу:

  • Тег img, используется для вставки изображений с внешних ресурсов.
Текст на странице Результат
<img src="https://stepik.org/static/classic/ico/favicon_128.png"> <img src="https://stepik.org/static/classic/ico/favicon_128.png">
  • Загрузка изображения на wiki.

Чтобы добавить на страницу изображение, которое уже загружено на wiki, можно воспользоваться Wikieditor-ом:

Вставка изображения


Далее нужно ввести имя загруженного файла и необходимые параметры, а затем нажать "вставка".

Вставка изображения


Список уже загруженных файлов есть тут


Если же нужного файла еще нету, то нужно нажать "Загрузить", пройти процедуру загрузки файла, а затем вернуться к вставке.


В итоге в текст добавиться строка вроде такой [[File:Some file.png|framed|none|Some file]].


Более подробно про вставку изображений можно почитать тут


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

Подсветка синтаксиса

Для подсветки синтаксиса используется тег syntaxhighlight

Пример разметки:

<syntaxhighlight lang="python" line='line'>
def quickSort(arr):
    less = []
    pivotList = []
    more = []
    if len(arr) <= 1:
        return arr
    else:
        pass
</syntaxhighlight>

Результат:

1 def quickSort(arr):
2 	less = []
3 	pivotList = []
4 	more = []
5 	if len(arr) <= 1:
6 		return arr
7 	else:
8 		pass

Подробнее тут

Курсы

Список курсов, по кторотым сгенерированны конспекты: