Глава 4. Внутри документа

Вы должны попытаться:

• Подписывать свою работу

• Дать ей статус

• Делать ссылки на страницы контекста.

• Используйте независимый от контекста заголовок

• Формат, независимый от устройства вывода

• Пишите так, чтобы вашу работу можно было бы печатать

• Пишите читаемый текст несмотря на ссылки

• Старайтесь не говорить о технических деталях

Подписывайтесь!

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

Создайте страницу для себя, с вашим почтовым адресом и номером телефона. В конце файла, за который вы ответственны, сделайте маленькую заметочку — укажите только свои инициалы — и создайте ссылку на свою авторскую страницу. Адресный стиль (обычно текст, выровненный по правой границе) вполне подойдет для этого.

Ваша авторская страница является традиционным местом помещения отказа от прав, заметок об авторском праве и т.д., требуемые законом или традициями. Это спасает сами ваши заметки и послания от длинных подписей.

Статус вашей информации

Некоторая информация носит строго определенный характер, другая может быть поспешно объединенной и незавершенной. И та и другая может быть полезна читателю, так что не стесняйтесь публиковать незавершенную или устаревшую информацию — она может оказаться незаменимой. Однако, не забывайте устанавливать ее статус. Когда она последний раз обновлялась? Полная ли она? Что она охватывает? Для телефонной книги, например, что за люди присутствуют в ней?

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

Вы конечно можете дать оттенок статуса текста через его язык: синтаксические ошибки, пропущенные заглавные буквы, «расслабленная» грамматика, все это указывает на неофициальность стиля. Осторожно используйте глаголы «shall» и «should» (для английского текста), а инструкция Long Capitalised Noun Phrases (LCNPs) в конце концов создаст впечатление изучения ISO стандарта.

Датируйте

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

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

Ссылка на контекст

Главным различием между написанием части последовательного текста и online документа является то, что читатель может попасть в него откуда угодно. Даже если вы только создали ссылки на документ только из одного места, любой другой человек может пожелать ссылаться на какую то определенную точку и таким образом сделать ссылку на некоторую часть вашей работы из своей собственной. Так что вы не можете положиться на читателя, что он последует вашим путем изучая вашу работу.

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

• Следите чтобы ваш текст и словарь описывали сами себя. Начиная документ со слов «Следующая мысль рассматривает...» или «Единственным решением этой проблемы является...» конечно собьет с толку.

• Иногда введение нового слова или понятия относится к контексту и может быть ссылкой на общую информацию. Например: в документации проекта WWW, первое появление понятия WWW ссылается на центральный документ проекта.

• Советы по навигации вверху или внизу документа могут давать подробные указатели. Примером может служить текущий документ.

В момент написания вами документа было бы неплохо помнить о том, что вы когда-нибудь можете от него отказаться.

Навигационные рисунки (icons)

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

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

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

Заголовок

Заголовок документа определяется элементом — TITLE. Элемент TITLE должен появляться в HEAD документа.

У любого документа может быть только один заголовок. Он должен идентифицировать содержание документа в довольно широком контексте.

Заголовок не является частью текста документа, но он относится ко всему документу. Он не может содержать ссылок, меток параграфов или подчеркиваний. Заголовок может использоваться для определения строк в history list, для заголовков окон, показывающих отдельные документы, и т.д. Он обычно не отображается в тексте собственно документа. Этим различаются titles и headings. Идеальная длина заголовка — менее 64 знаков. Таким образом, многие приложения будут показывать заголовки документов в окне для заголовков, в меню, и т.д. — там, где место ограничено. Не существует ограничений на длину заголовков (так как они могут быть автоматически сгенерированными из других данных), но информационные провайдеры должны помнить, что слишком длинные заголовки могут обрезаться.

Независимость от устройства

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

Это дает большие преимущества для успешного переноса вашего документа на различные платформы, включая простые текстовые терминалы.

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

Например:

• Всегда используйте уровни заголовков в следующемпорядке, один заголовок 1-го уровня в начале документа, если необходимо, то несколько заголовков 2-го уровня, и далее, если необходимо, несколько заголовков 3-го уровня внутри каждого заголовка 2-го уровня. Если вам не нравится то, как форматируется заголовок 2-го уровня, настройте это в своем клиенте, но не перепрыгивайте на следующий уровень заголовков.

• Не делайте дополнительных пробелов или пустых линий в вашем тексте только для «раздувания» документа, исключая преформатированную часть (тэг PRE).

• Не ссылайтесь в вашем тексте на особенностиопределенного просмотрщика. Просить кого-то «нажмите здесь» не имеет смысл без мышки, также как и просьба кого-то «выберите ссылку по номеру» опровергается фактом того, что вы используете не line-mode просмотрщик. Оставьте только ссылку. Инструкции излишни, если пользователь сам знает как выбирать ссылки.

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

Печать гипертекста

В идеальном мире бумага перестанет быть необходимой. Из этого следует, что будет достаточно времени чтобы написать гипертекстовую версию документа и также сделать отдельную версию на бумаге. Однако, в условиях реального мира вы возможно захотите генерировать любые печатные и online документы из одного файла.

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

Старайтесь избегать ссылок в тексте на специфические моменты online гипертекста. «Смотрите раздел независимость от устройства» лучше, чем «За подробностями по идеям о независимости от устройств, нажмите здесь.». Фактически, мы говорим о форме подачи независимости от устройств. К сожалению, рекомендованная практика подписи каждого документа и построения навигационных ссылок имеет тенденцию портить печатные копии, таким образом вы можете развивать способы удаления подобных вещей если ваши документы следуют общему формату.

Читаемый гипертекст

Первое — это синдром _HERE_, т.е.:

Информацию о Blah Blah Blah можно получить нажав here, где слово here ссылка. Этот стиль неуклюж, когда вы нажимаете here, вы должны «посмотреть по сторонам», чтобы убедиться, что нажимаете правильно.

Совет: когда вы создаете свою HTML страницу, убедитесь что то, на что нужно нажать фактически является чем то типа заголовка для того материала, на который вы перейдете, нажав. Т.е., говорите

Информация о Blah Blah Blah теперь доступна.

И используйте:

Информация о способах поиска доступна.

Вместо

Если хотите получить информацию о способах поиска, выберите эту ссылку.

Не так уж и плохо, но все же неудобно если кто-то будет использовать словарное слово, как ссылку, одновременно говоря о «ссылке».

Здесь ссылки на страницы кредитов и технических деталей

вместо этого попытайтесь написать что-то типа:

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

Сообщения об Интернет службах обычно следуют на страницах для информации о том, как использовать FTP, почтовых службы и т.д. для получения информации. WWW было создано для того, чтобы избежать необходимости использования этого. Соблазном является вырезать все эти инструкции и оставить ссылку типа:

Это WWW доступ к нашему большому FTP архиву, который ранее был доступен только через FTP, NFS и mail. Эта коллекция включает множество программных средств и текстов, авторские права на которые уже закончились.

Web обычно читают люди, которые либо не нуждаются, либо, что бывает чаще, не хотят знать о FTP, NFS и даже WWW! Лучше написать следующее:

Наш архив включает множество программных средств и текстов, авторские права на которые уже закончились.

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

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

Вы можете найти больше информации в части, посвященной обучению, которая имеет ссылку на home-page.

Очевидно будет лучше написать: Обучающая часть содержит больше информации об этом.

Еще одна общая идея

Обучающая часть содержит разделы Урок 1, Урок 2 и Урок 3. Дайте читателю передохнуть и позвольте ему обратиться непосредственно к тому разделу, который ему необходим!