[doc] Итоговый отчет по проекту Wiki

[Даниил Захаров]

Итоговый отчёт по проекту Wiki.

1. Страница QBE (http://83.149.198.179:8000/wiki/QBE) содержит общее описание языка. Ниже, на данной странице, приводится навигация по переведенной оригинальной документации;
2. Страница Си-интерфейс (http://83.149.198.179:8000/wiki/Си-интерфейс) является "входной" к страницам с описанием и разбором некоторого содержимого его файлов;
3. Страница Примеры кода QBE IL (http://83.149.198.179:8000/wiki/Примеры_кода_QBE_IL) содержит небольшую инструкцию по эксплуатации языка QBE;
4. Страница FAQ (http://83.149.198.179:8000/wiki/FAQ) ответит на распространенные вопросы, которые могут возникнуть при написании программ на языке QBE, либо с использованием Си библиотеки;
5. Страница Теория к заданиям (http://83.149.198.179:8000/wiki/Теория_к_заданиям) разъясняет некоторые термины, с которыми Вы столкнетесь в курсе "Конструирование компиляторов".


Перевод документации:

1. QBE (http://83.149.198.179:8000/wiki/QBE)
2. Типы
    1. Простые типы данных 
    2. Подтипирование
3. Константы
4. Объявления
    1. Составные типы данных
    2. Data
    3. Функции
5. Управление
    1. Блоки
    2. Переходы
6. Инструкции
    1. Арифметические и битовые операции
    2. Память
    3. Сравнения
    4. Преобразования
    5. Инструкции Cast и Copy
    6. Инструкция Call
    7. Вариативность
    8. Инструкция Phi
7. Список всех инструкций


Выводы.

Первоначальный план выполнен полностью, за исключением интеграции doxygen с помощью плагина DoxyWiki, по причине недоступности репозиториев плагина. Тем не менее, реализована страница для Си-интерфейса (http://83.149.198.179:8000/wiki/Си-интерфейс) и некоторых составляющих его функций и структур.

Оформлена главная страница (http://83.149.198.179:8000/wiki/Заглавная_страница), способствующая навигации по проекту.

Помимо прочего, добавлена страница с рекомендацией к оформлению (http://83.149.198.179:8000/wiki/Оформление) для тех, кто будет поддерживать и развивать проект в дальнейшем. Ссылка на эту страницу так же указана на главной странице.

P.S. Информация, предоставленная нашими коллегами в файле odt, так же размещена на Wiki.


Комментарии к MediaWiki.

Основной файл настроек находится в корневой директории движка — LocalSettings.php. На время разработки проекта в него были добавлены следующие настройки:

# Запрет самостоятельной регистрации новых пользователей:
$wgGroupPermissions['*']['createaccount'] = false;
# Запрет анонимного редактирования:
$wgGroupPermissions['*']['edit'] = false;
# Запрет анонимного создания страниц:
$wgGroupPermissions['*']['createpage'] = false;
$wgGroupPermissions['*']['createtalk'] = false;
$wgGroupPermissions['*']['writeapi']   = false;

Стоит отметить, что в LocalSettings.php находятся настройки взаимодействия с Базой Данных, адреса электронной почты, которым движок будет пользоваться для рассылки паролей и экстренной связи, управления адресацией внутри проекта ($wgArticlePath = "/wiki/$1»;), логотипом (в левом верхнем углу), фавиконом. Кроме того, в этом файле находятся два специальных ключа: приватный ключ, отвечающий за уникальность инсталляции MediaWiki и ключ обновления, который будет использоваться при восстановлении сайта из бэкапа.


С уважением,
Захаров Даниил