1. Общие положения
2. Письменный отчет
2.1. Промежуточные отчеты студентов 2 курса и студентов, выполняющих промежуточный отчет впервые после смены темы.
2.2. Промежуточные отчеты студентов четвертого курса, готовящих выпускные квалификационные работы бакалавра.
3. Инструкция по созданию HTML-презентаций отчетов о курсовых и дипломных работах.
3.1. Размещение на сервере кафедры
3.2. Файлы презентации и их размещение
3.3. Стандарты и валидация

1. Общие положения

Отчет о выполнении курсовой работы состоит из письменного отчета и HTML-презентации, демонстрацией которой студент должен сопровождать свое выступление на защите курсовой работы в конце весеннего семестра.

При разработке отчетов нужно руководствоваться указаниями, приведенными в утвержденном Деканом Математического факультета документе: В. В. Поляков "Положение о курсовых, квалификационных и дипломных работах, выполняемых студентами математичесокго факультета Петрозаводского государственного Университета", Методические указания, Издательство ПетрГУ, 1997

Этот документ можно получить в библиотеке или на сервере кафедры ИМО: www.cs.karelia.ru, раздел "Курсовые работы"

2. Письменный отчет

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

Для формирования этого навыка в учебном плане предусмотрено выполнение курсовых работ с подготовкой письменного отчета в конце каждого семестра, а также подготовка выпускных квалификационных работ бакалавра (четвертый год обучения), дипломных работ специалиста (пять лет обучения) и магистерских диссертаций.

Отчет о курсовой работе в осеннем семестре называется промежуточным, в весеннем - окончательным.

Вообще говоря, форма отчета, подготовленного в любой организации России, должна соответствовать государственному стандарту (ГОСТ 7.32-2001). См. примеры форматов отчетов, которые подготавливаются в университете.

Для того, чтобы студент, при разработке отчета, мог полностью сконцентрироваться на его содержании, не отвлекаясь на технические детали, кафедрой ИМО разработана модель отчета в виде файла на языке ТеХ, реализующая основные требования ГОСТ. Автор модели отчета - ст. преподаватель кафедры ИМО А. В. Бородин, ссылки см. ниже.

Эта модель делает работу студента по разработке отчета КРАЙНЕ ПРОСТОЙ. Использование модели не требует знания языка ТеХ, достаточно уметь отличать конструкции ТеХ от содержательного текста.

Для получения отчета с помощью модельного файла необходимо выполнить следующие шаги:

Ознакомиться с литературой по теме работы, разработать структуру и содержание отчета, если потребуется подготовить файлы рисунков.
Отредактировать модельный файл, заменяя содержательный текст на свой собственный, без изменения конструкций языка ТеХ. Для вставки рисунков скопировать в соответствующие места файла отчета фрагменты модельного файла, обеспечивающие подключение рисунков, и модифицировать имена файлов с рисунками и ссылок на рисунки. В тексте модельного файла содержатся дополнитнельные указания.
Для проверки русской орфографии в командной строке на любой из ЭВМ кафедры (серверы, в том числе студенческий сервер kappa, рабочие станции) в любой из ОС (Linux, Windows) выполнить команду:

ispell -d russian file-of-my-report.tex
Для получения графического файла отчета в формате DVI, в командной строке на любой из ЭВМ кафедры (серверы, в том числе студенческий сервер kappa, рабочие станции) в любой из ОС (Linux, Windows) выполнить команду:

latex file-of-my-report.tex

ТеХ автоматически собирает и размещает оглавление отчета, что требует двух, иногда трех проходов по исходному файлу. Поэтому то при первом запуске эту команду нужно выполнить три раза подряд.

Затем для получения PostScript версии файла выполнить команду:

dvips file-of-my-report.dvi

Для работы вне ЭВМ кафедры ИМО нужно иметь установленную систему TeX версий: TeX (Web2C 7.4.5) 3.14159, kpathsea version 3.4.5.
Полученный на языке postscript файл file-of-my-report.ps содержит (ОЧЕНЬ КРАСИВУЮ!) версию Вашего отчета, предназначенную для печати. Студенты, выполняющие курсовые работы на кафедре ИМО, могут напечатать отчет командой:

lpr file-of-my-report.ps

обратившись к научному руководителю, дежурному инженеру или методисту кафедры.

2.1. Промежуточные отчеты студентов 2 курса и студентов, выполняющих промежуточный отчет впервые после смены темы.

Те из этих студентов, которые к моменту подготовки промежуточного отчета могут не имеют большого объема разработанного материала, могут представить отчет в следующем минимальном формате:

Титульный лист
Оглавление (автоматически формируется системой TeX)
Ведение
1. Обзор предметной области
1.1. Ваши содержательные параграфы (хотя бы один)
2. Постановка задачи
2.1. Ваши содержательные параграфы (хотя бы один)
Библиографический список использованной литературы (хотя бы одна ссылка)

Для такого отчета кафедрой разработан сокращенный модельный файл, который можно загрузить здесь.
PDF версия этого файла загружается здесь.

2.2. Промежуточные отчеты студентов четвертого курса, готовящих выпускные квалификационные работы бакалавра.

Промежуточный отчет этих студентов должен представлять собой план-конспект выпускной работы, подготовленный согласно положениям курса "Подготовка научных текстов". Виза А. А. Котова на отчете обязательна. Термин план-конспект означает, что структура содержания работы должна быть уже сформирована, но каждый из текстов параграфов представлен только одним или двумя абзацами.

Загрузка полного модельного файла промежуточного отчета для студентов третьего и старших курсов.

Экстракция файлов в Linux системах командой

tar -xzvf <имя файла>

Экстракция файлов в Windows системах пакетом WinRAR

Примеры отчетов

3. Инструкция по созданию HTML-презентаций отчетов о курсовых и дипломных работах.

3.1. Размещение на сервере кафедры

HTML-презентация работы, включая HTML-слайды и иллюстрации, должна быть размещена на Web-сервере кафедры, в отдельном каталоге. К нему можно получить доступ по SFTP, подключившись под своим именем пользователя к серверу kappa.cs.karelia.ru (подробнее см. инструкцию по доступу к вычислительным ресурсам кафедры). Путь к этому каталогу на сервере имеет вид:
/srv/www/projects/<календарный_год_начала_учебного_года>/<группа>/<ваш_login>
Для промежуточных отчетов этот каталог имеет вид:
/srv/www/projects/pre-<календарный_год_начала_учебного_года>/<группа>/<ваш_login>

Из Internet презентация будет доступна по адресу:
http://kappa.cs.karelia.ru/p/<календарный_год_начала_учебного_года>/<группа>/<ваш_login>/
Для промежуточных отчетов:
http://kappa.cs.karelia.ru/p/pre-<календарный_год_начала_учебного_года>/<группа>/<ваш_login>/
Эти каталоги также доступны на kappa.cs.karelia.ru.

Например: для студента Петрова из группы 22303, в которой он начал учиться в 2005-2006 учебном году, URL будет иметь вид http://kappa.cs.karelia.ru/p/2005/22303/petrov/

3.2. Файлы презентации и их размещение

В каталоге презентации должен быть индексный файл (index.html или index.php), отображающий титульную страницу.

Для каждого студента установлено ограничение на использование дискового пространства под презентации за все время его обучения - 5МБ. Поэтому рекомендуется создавать презентации объемом не более 1МБ каждая.

Все гиперссылки между слайдами вашей презентации, и все адреса иллюстраций на слайдах, должны быть относительными.
Например, в презентации вышеуказанного студента Петрова есть рисунок x.jpg, имеющий в файловой системе полное имя /srv/www/projects/2005/22303/petrov/pictures/x.jpg,
а документ, в который включается рисунок - /srv/www/projects/2005/22303/petrov/01.htm.
Тогда включение этого рисунка в код HTML должно иметь следующий вид: <img src="pictures/x.jpg" alt="иллюстрация">
Недопустимо обращение к файлам по полным адресам (адреса вида http://kappa.cs.karelia.ru/p/2005/22303/petrov/pictures/x.jpg).

Иллюстрации необходимо хранить в формате JPEG, GIF или PNG.

Использование символа '\' в качестве разделителя каталогов в URL расценивается как грубейшая ошибка и незнание HTML!

3.3. Стандарты и валидация

Все слайды презентации должны соответствовать HTML-стандарту W3C и успешно проходить валидацию.

На каждом слайде обязательны кнопки:

Вадидатора W3C для версии HTML, которая использовалась при создании страницы;
Валидатора CSS, если вы используете таблицы стилей.
Счетчиков посещений HotLog и Yellow Pages.

Код, отображающий эти кнопки, включен в приведенные ниже коды примеров презентаций.

Примеры презентации:

1. valid HTML 4.01 (исходный код)
2. PHP, valid XHTML 1.0, valid CSS (исходный код)
Студентам, знакомым с PHP и XML (или желающим изучить их), будет удобнее руководствоваться последним примером.

Экстракция файлов в Linux системах командой

tar -xzvf <имя файла>

Экстракция файлов в Windows системах пакетом WinRAR

9 декабря 2006 г.
Зав. кафедрой ИМО
к.т.н., доцент,
Ю. А. Богоявленский