Руководство по стилям для создания online гипертекста
Вы собираетесь писать (или генерировать)online гипертекст. Вы можете быть обескуражены тем, что гипертекст
потенциально свободен (не связан жесткими рамками). Не пугайтесь. Это не
доставит Вам сложностей. Во многих случаях, чем проще, тем лучше.
Вы будете писать определенное количество отдельных файлов. Эти файлы
будут соединены друг с другом и с внешними документами для завершения
Вашей работы.
Вы можете расценивать результат своей работы как "документ", ведь если бы он
существовал на бумаге, Вы назвали бы его документом. В случае online
документов, мы можем относиться к каждому отдельному файлу как к документу.
Документ может относиться, по аналогии с книгой, к разделу или подразделу
или даже сноске. В этом руководстве мы будем ссылаться на целые коллекции
документов как на самостоятельные работы.
Документ это минимальный модуль для представления информации. В любой момент
времени Ваш документ должен быть полностью загружен редактором. Также
естественно если Вы работаете одновременно над несколькими документами.
Это возможно если у Вас имеется хороший редактор, позволяющий одновременно
открывать несколько документов.
В этом руководстве частично описываются правила
этикета для каждого сервера,
который преимущественно применяется к администратору сервера: остальное
- к любой закладываемой на сервер информации.
В разделе структура обсуждается,
как преобразовать Ваши материалы в документы. В следующем разделе
обсуждается организация Ваших материалов
внутри документа.
(Назад к
)
версия этого документа.
Чтобы напечатать этот документ
включающая комментарии читателей доступна для печати, однако имеет некорректные ссылки и не соответствует стандарту html.Датируйте
В некоторых случаях может быть полезно ставить дату создания ипоследнего изменения Вашей работы. (Заметим, что это относится к
такого рода вещам, которые могут быть выполнены сервером автоматически
при минимальном программировании).
Выясняйте, когда установка даты может избавить читателя от использования
просроченной информации.
(Вернуться к
, Jan-94
версия этого документа.
Делайте Ваш (гипер)текст читаемым
Немного напыщенно вести речь о двух типах стилей статей в гипертексте,и
Я считаю излишним и не приветствую это.
Первое - это синдром _HERE_, т.е.:
Информацию о Blah Blah Blah можно получить нажав _here_.
где слово _here_ ссылка. Этот стиль неуклюж, когда Вы нажимаете 'here',
Вы должны "посмотреть по сторонам", чтобы убедиться, что нажимаете
правильно. Я настоятельно советую Вам, когда Вы создаете свою HTML
страницу, убедиться что то, на что нужно нажать фактически является
чем то типа заголовка для того материала, на который Вы перейдете,
нажав. Т.е., говорите
Информация о _Blah Blah Blah_ теперь доступна.
и используйте:
Информация о _способах поиска_ доступна.
вместо
Если хотите получить информацию о способах поиска, выберите _эту ссылку_.
Не так уж и плохо, но все же неудобно если
кто-то будет использовать словарное слово, как ссылку,
одновременно говоря о "ссылке".
Здесь ссылки на страницы _КРЕДИТОВ_ и _технических деталей_
вместо этого попытайтесь написать что-то типа:
Огромное спасибо _различным людям_ за их содействие
_технические детали_ этой системы теперь доступны всем. Т.е., делайте
Ваши HTML страницу такой, чтобы Вы могли читать ее даже если Вы не
проходите по всем ссылкам.
(Вернуться к
Contributed by Larry Masinter
версия этого документа.
Делегирование полномочий
Администратор сервера (единственный имеющий пароль root-а) в принципеимеет возможность включения/выключения сервера и контроля того, что
происходило. Однако, мудро иметь четко делегированную ответственность
для отдельных сфер Вашей документации. Возможно, администратор сервера
вообще не несет ответственности за актуальность данных, в этом случае
их задача сводится к поддержанию машины в рабочем состоянии.
Домашний стиль
Web напоминает собой травяные корни, без централизованного подчинения, ипри этом отлично работает. Это является обязательной частью творчества
лиц предоставляющих информацию и той свободой, которой они располагают для
выражения своей информации напрямую и настолько быстро, насколько они могут.
Читатели очень признательны этой гибкости. Однако, в больших web системах
логичность является приятной стороной.
Если Вы отвечаете за управление процесса предоставления информации Вашей
организации, Вы должны соблюдать баланс между преимуществами "домашнего
стиля" и предоставлением каждой группе или автору свободы творчества.
Если Вы приняли решения в этой сфере, хорошо бы их записать (не упоминая
записать их в web).
(по теме )
©1992-95
версия этого документа.
Дополнительное чтение
Ниже перечислены некоторые документы родственные по содержанию с:
список указателей
Много ссылок
Этот список далеко не полон. Сейчас много книг (1994) о том, как строить web site
и писать HTML. Если они имеют общие сбои это значит что они созданы под определенный просмотрщик.
Возьмите один, который Вам импонирует, так как все они полны хороших идей.
Походите по web, наберитесь идей, и напишите мне отзыв о руководстве.
(Часть ;
Назад к: тестированию, on to ...)
версия этого документа.
Избегайте разговоров о механике
Сообщения об Internet службах обычно следуют на страницах дляинформации о том, как использовать FTP, почтовых службы и т.д.
для получения информации. WWW было создано для того, чтобы
избежать необходимости использования этого. Соблазном является
вырезать все эти инструкции и оставить ссылку типа:
Это к нашему большому FTP архиву,
который ранее был доступен только через FTP, NFS и mail. Эта коллекция включает
множество программных средств и текстов, авторские права на которые уже закончились.
Web обычно читают люди, которые либо не нуждаются, либо,
что бывает чаще, не хотят знать о FTP,NFS и даже WWW!
Лучше написать следующее:
Наш включает
множество программных средств и текстов, авторские права на которые уже закончились.
Описывайте предмет рассуждений чаще, чем механизмы и протоколы,
при этом не забывайте о краткости текста, которая способна
привлечь читателей.
Даже если Вы работаете с метафорами web, используйте ссылки,
но не говорите о них. Например:
Вы можете найти больше информации в части, посвященной обучению,
которая имеет ссылку на home-page.
очевидно будет лучше написать
содержит больше информации об этом.
Еще одна общая идея
содержит разделы по mowing, sharpening the mower,
и buying a mower.
Дайте читателю передохнуть и позвольте ему обратиться непосредственно
к тому разделу, который ему необходим!
содержит разделы по mowing, sharpening the mower,
и buying a mower.
(Вернуться к:
к:
версия этого документа.
Этот документ открыт для комментариев!
Предложения приветствуются, если Вы что-то придумаете, отправьте мне письмо по адресу , упомянув the Style Guide for Online Hypertext. Я также заинтересован в URL других руководств по стилям, руководств по корпоративным стилям или Вашей любимой книги по стилям (гипертекст или что-то еще).Легко печатающийся гипертекст
В идеальном мире бумага перестанет быть необходимой. Из этогоследует, что будет достаточно времени чтобы написать
гипертекстовую версию документа и также сделать отдельную
версию на бумаге. Однако, в условиях реального мира Вы
возможно захотите генерировать любые печатные и online
документы из одного файла.
Предполагая, что HTML файлы будут эталонными, Вы будете генерировать из
них версию для печати, создавая один длинный документ и возможно печатая его
оттранслировав в формат некоторого текстового процессора, например, TeX.
Возможно не сейчас, но когда-нибудь, такое желание у Вас возникнет.
Старайтесь избегать ссылок в тексте на специфические моменты online
гипертекста. "Смотрите раздел
независимость от устройства" лучше, чем "За подробностями
по идеям о независимости от устройств, нажмите
здесь.". Фактически,
мы говорим о форме подачи
независимости от устройств.
К сожалению, рекомендованная практика подписи каждого документа
и построения навигационных ссылок имеет тенденцию портить
печатные копии, таким образом Вы можете развивать способы удаления
подобных вещей если Ваши документы следуют общему формату.
Например, самый общий комментарий по этому документу,
что он сложен для печати. Здесь я сделал версию всей работы. Она создавалась несколькими
программами. Я поместил указатель на нее из . Но последовали вопросы от тех людей, которые
не читали эту страницу. (Программы были типа "sed", которые я не
поддерживаю. Я установил правила вверху и внизу каждой страницы
и программы использовали это для удаления информации, которая не
нужна в печатной копии.)
(Вернуться к:
внутри каждого документа;
Назад к
независимости от устройств ,
по теме .читаемый текст)
версия этого документа.
Насколько большим делать каждый документ
Наиболее важным здесь является, чтобы каждый документ был завершеннымс логической точки зрения. Так, не стоит резать одну идею на два
произвольных кусочка только для того, чтобы сделать каждый из них меньше.
Наоборот, не является хорошим стилем соединять не пересекающиеся между собой
идеи, только для того, чтобы увеличить размер документа.
Документ может быть совсем малым по размеру. Например, это
примечание.
Существует два верхних предела для размера документа.
Один из них, что длинный документ требует больше времени для передачи ,
поэтому читатель не может быстро входить в него и возвращаться назад, как ему бы хотелось.
В наибольшей степени это зависит, конечно, от скорости передачи. Другим пределом
является сложность для читателя пролистать длинный документ. Читатели,
работающие за алфавитно-цифровыми терминалами не в состоянии читать больше нескольких
экранов. Они часто смотрят только информацию первого экрана и,
если он их не заинтересовал, им очень докучает дальнейшее его пролистывание.
Читатели также могут выйти из документа, находясь еще только
в самом начале документа.
Читатели, использующие графический интерфейс, обычно пролистывают длинные
документы используя scroll bar. Когда scroll bar немного перемещается,
документ должен перемещаться на соответственное малое значение, так, чтобы часть
оригинального окна осталась видимой. Это позволяет читателю сканировать документ.
Если документ оказывается больше, тогда он становится нечитаемым и, при каждом
передвижении scroll bar, читатель может потерять место на котором он остановился.
Аргументом в защиту длинных документов может служить легкость просмотра документа
непрерывным потоком для читателей, имеющих scroll bars, так что они могут воспринимать
его так, как он был написан.
Также они не приносят авторам неприятностей создания (или генерирования) большого количества
связей и постоянного их обновления в случае изменения данных. Если создание ссылок
является проблемой используйте в документе только одну ссылку - на страницу содержания. Некоторые
просмотрщики имеют кнопки
NAME="z7" HREF="http://www.w3.org/pub/WWW/DesignIssues/Navigation.html#z12">"next"
и "previous", позволяющие просматривать документы по списку.
(Фактически, можно нормально просматривать длинные документы вверх и вниз
последовательно страницу за страницей, но это создает впечатление, что Вы
работаете с алфавитно-цифровым терминалом).
Приблизительным руководством по размеру документа может служить:
превышать 24 линии. Проверьте это утверждение сидя за текстовым терминалом.
(Вернуться к
NAME="z2" HREF="3.shtml">структура , назад к
NAME="z3" HREF="5.shtml">перекрывающиеся деревья , по теме:
NAME="z8" HREF="7.shtml">ссылка или копия.)
NAME="0" HREF="http://www.w3.org./hypertext/TBL_Disclaimer.html">Tim BL
HREF="http://www.w3.org/pub/WWW/Provider/Style/DocSize.html">Оригинальная
версия этого документа.
Навигационные рисунки (icons)
Icons выполняют роль навигационных советчиков. Очень эффективно иметьодинаково составленные картинки на протяжении всей работы, всегда (за
исключением начальной страницы) ссылающихся назад на первую страницу.
Вы можете убить этим двух зайцев: Это дает согласованность Вашей работе,
так что читатель всегда знает, когда он находится внутри нее а когда нет,
также это дает ему быстрый путь возврата к началу работы.
Вы можете сделать то же самое и с секциями, так что на верху (или внизу)
каждой страницы Вы можете поместить небольшой ряд картинок, первая -
переход на самый первый документ, вторая - к началу главы, третья -
к началу раздела в главе, например.
[This style guide was for a long time empty of icons
because I was editing it
with the old hypertext editor
which doesn't handle images. I may fix that with time -tbl]
(К началу
руководства по стилям для online гипертекста
. назад к
Внутри каждого документа , по теме
Title tag )
версия этого документа.
Независимость от устройства
Гипертекст, который Вы пишете запоминается в терминах языка HTML,которые не содержат информации о font-ах, форматах параграфа
и заполнителях (метод заполнения пустого пространства), которые
должны быть использованы для изображения документа на дисплее.
Это дает большие преимущества для успешного переноса Вашего
документа на различные платформы, включая простые текстовые терминалы.
Вы должны учитывать, что разные клиенты используют различные
заполнители и font-ы. Вы должны быть осторожны в использовании
структурных элементов, таких как заголовки и списки в том виде,
для которого они предназначены. Если Вам не нравится то , как
Вашу информацию представляет определенный клиент, не пытайтесь
исправить положение использованием нестандартных элементов и
не пытайтесь наполнить пространство пустыми элементами. Это
может привести к различной интерпретации различными клиентами
и выглядеть очень странно. Во многих случаях Вы можете
сконфигурировать как клиент выводит каждый элемент
Например:
один заголовок 1-го уровня в начале документа, если необходимо,
то несколько заголовков 2-го уровня, и далее, если необходимо,
несколько заголовков 3-го уровня внутри каждого заголовка 2-го
уровня. Если Вам не нравится то, как форматируется заголовок
2-го уровня, настройте это в своем клиенте, но не перепрыгивайте
на следующий уровень заголовков.
тексте только для "раздувания" документа, исключая
преформатированную части (tag PRE).
просмотрщика. Просить кого-то "нажмите здесь" не имеет смысл
без мышки, также как и просьба кого-то "выберите ссылку по номеру"
опровергается фактом того, что Вы используете не line-mode
просмотрщик. Оставьте только ссылку. Инструкции излишни,
если пользователь сам знает как выбирать ссылки.
Смотрите также: проверка
Вашего документа .
Следуя этим указаниям Вы можете
обнаружить, что конечный результат появляется на Вашем
экране не в том виде, в котором Вы бы хотели, но возможно
Вашим читателям повезет больше.
(Это часть
. Вернуться к
, назад к ,
по теме
версия этого документа.
Перекрывающиеся деревья
Вы видите пример работы с двумя отдельными структурами (взято описаниенекоторых программных функций):
Обучение Справочник
| |
Давайте знакомиться вместе -----------------
от простого к сложному | |
| по Функциональным Имена функций
| группам в алфавитном порядке
Примеры, ориентированные на задания | |
| -----------------
| |
Примеры использования Синтаксические определения
специфических функций <--------> для специфических функций
Новичок начинает сверху-слева и двигается вниз. Когда ему потребуются
специфические детали, он будут брать примеры снизу (нижний уровень дерева) и из
них ссылку на лежащее в основе определение для каждой детали.
Как только он все усвоил, он переходит к чтению материала имеющего
структуру в виде дерева. Фактически, он читает такую же информацию,
как и эксперт, который заинтересовался определенной функцией и затем
обращается за примером ее использования.
(Вернуться к
по теме: