Дисциплина оформления иллюстраций

Глобальное-генеричное или предисловие

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

Иллюстрации прикрепляются к странице лекции, которой они соответствуют (например, если иллюстрация соответствует лекции в рамках проекта документирвания ПСПО от 22 июля, то она должна быть прикреплена к странице PspoClasses/080722).

В случае, если иллюстрация соответствует нескольким лекциям, то она должна быть прикреплена ко всем страницам лекций, которым она соответствует.

На случай упущения важных деталей человеком, подготавливающим иллюстрации на основании сырых материалов, к странице лекции также рекомендуется прикреплять архив с оригинальными материалами (например, PspoClasses/080805/080805.tar.bz2).

Общие слова об именовании

Ссылки и включение

Для ссылания/включения иллюстраций в содержимое фрагментов лекций используются entities [[attachment:]] и {{attachment:}} соответственно. При этом настоятельно рекомендуется использовать относительный путь к иллюстрации (например, {{attachment:../attachment_name.ext}}).

Окружение

Так как лекции читались в различных местах и с раздличным окружением, то и некие сущности в процессе иллюстрирования отличались. Решено не приводить всё к единому окружению, а задокументировать его.

Entity

VirtualBox

Terminal Server

Real class

Домен

class.altlinux.ru

class.altlinux.ru

class.mpgu.edu.ru

Hostname

demo; lite

altsp; ??..??

host1; host2..host254

IP

172.0.0.1/24, 10.0.2.15/24; 172.16.0.2/24

192.168.0.1/24, 10.0.2.15/24; 192.168.0.20/24..192.168.0.254/24

10.30.5.1/24, 192.168.201.241/24; 10.30.5.2/24..10.30.5.254/24

Gateway

10.0.2.1; 172.16.0.1

10.0.2.1; 192.168.0.1

192.168.201.10; 10.30.5.1

DNS Server IP

10.0.2.1; 172.16.0.1

10.0.2.1; 192.168.0.1

192.168.201.10; 10.30.5.1

DHCP Server IP

10.0.2.1; 172.16.0.1

10.0.2.1; 192.168.0.1

—; 10.30.5.1

Login

demo; demo

user

user

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

Типоспецифичное

Скриншоты

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

for i in "$@"
do
  W=`identify -format "%w" $i`
  H=`identify -format "%h" $i`
  
  convert $i -background none -size ${W}x${H} xc:white -fill black \
    -draw "point 0,0" \
    -draw "point 0,1" \
    -draw "point 1,0" \
    -draw "point $((W-2)),0" \
    -draw "point $((W-1)),0" \
    -draw "point $((W-1)),1" \
    -draw "point 0,$((H-1))" \
    -draw "point $((W-1)),$((H-1))" \
    -transparent black -compose Copy_Opacity -composite $i
done

Схемы

Схемы рекомендуется делать векторными (предпочтительный формат — SVG). При этом желательно прикреплять следующие файлы:

Некоторые гайдлайны:

Логи

Гайдлайны:


CategoryPolicy

PSPO/Policy/Illustrations (last edited 2008-10-04 14:29:12 by eSyr)