Наш комплект документации на ~1500 страниц содержит многочисленные снимки экрана и соответствующую графику (схемы, блок-схемы и т. д.). Иногда пользовательский интерфейс меняется, и нам приходится обновлять всю затронутую графику. Затронутые графики не обязательно все в одной книге; они могут быть распределены по нескольким. Короче говоря, они могут быть где угодно, поэтому мы полагаемся на знание авторами набора документов, а иногда просто просматриваем все это в поисках графики, которая больше не соответствует действительности. Первый хрупкий, а второй утомительный (и тоже может быть хрупким).
В самом источнике XML-документа я могу вставлять (и делаю) внутренние теги, которые я могу позже искать. Думайте об этом как о метаданных для документов. Я ищу способ связать метаданные с изображениями, чтобы я мог найти все изображения, которые показывают такую-то функцию или такой-то виджет или что-то еще. Я мог бы настроить внешний индексный файл или базу данных, но это означает, что метаданные далеки от изображений, и я беспокоюсь о том, чтобы они соответствовали данным (каждый писатель всегда будет помнить об обновлении базы данных, когда он создает или редактирует изображение и его метаданные меняются?). Могу ли я сделать что-нибудь умное, чтобы приблизить метаданные к данным?
Форматы изображений: PNG для снимков экрана, GIF для штриховой графики. Есть ли инструмент, который позволил бы нам встраивать и запрашивать метаданные прямо в файлы в этих форматах?
Наши существующие соответствующие инструменты: Perforce для управления версиями, DocBook XML для источника документации, Ant для целей сборки. Что касается графики, мы используем PaintShop Pro и/или SnagIt для создания/редактирования снимков экрана и в основном Visual Thought для штриховой графики (хотя у нас есть доступ к InkScape, и мы можем изучить его, если это поможет). Наши рабочие столы - Windows (XP сейчас, 7 позже в этом году).
Редактировать: снимки экрана также имеют текстовое значение — обычно у нас есть не просто снимок экрана, а снимок экрана и текст, в котором рассказывается об опциях или о том, что вы можете сделать с помощью этого инструмента. Снимки экрана являются неотъемлемой частью документации, и если снимок экрана необходимо обновить, мы также должны посмотреть места, где используется это изображение. Найти эти точки в тексте легко (я могу просто найти источник имени файла каждого изображения при его обновлении), но найти снимки экрана, которые должны измениться в первую очередь (из-за изменения пользовательского интерфейса), гораздо сложнее. . Этот вопрос касается управления этим процессом, чтобы мы могли поддерживать всю документацию в актуальном состоянии.
Поскольку это считается по теме, я дам свою рекомендацию в качестве правильного ответа.
Вместо того, чтобы рекомендовать другие инструменты, судя по вашей установке (Paintshop Pro, Windows XP или Windows 7), самый простой способ — использовать эти существующие инструменты, чтобы делать то, что вам нужно:
Используйте Paintshop Pro для добавления метаданных к вашим изображениям. Вы можете сделать это, выбрав Изображение > Информация об изображении. Я добавил метаданные в поле «Описание» для изображения. Таким образом, вы можете добавлять слова (возможно, даже разработать собственную систему тегов), которые будете использовать для поиска. Вы также можете добавить другие данные, например, кто сделал снимок экрана, дату его последнего изменения и т. д. Если вы спланируете метаданные, вы сможете создать действительно хорошую систему для организации ваших изображений.
Как только это будет сделано, вы можете использовать встроенный поиск Windows XP, чтобы найти файл (то же самое должно работать и в Windows 7). Просто укажите нужный каталог, выберите только «Картинки и фотографии», а затем выберите «для фразы или слова в файле». Введите фразу / тег, который вы ищете, нажмите «Поиск», и он должен найти изображение, которое вы ищете.
Для книги, которую я сейчас пишу, которая не написана непосредственно в docbook, а написана с помощью разметки, которая будет переведена в DocBook для публикации, я использую файл XML для захвата метаданных для каждой иллюстрации.
<?xml version="1.0" encoding="UTF-8"?>
<image>
<source>assemble.svg</source>
<fo>
<href>assemble.svg</href>
<contentwidth>4.25in</contentwidth>
<align>center</align>
</fo>
<epub>
<href>assemble.png</href>
</epub>
<alt>
<p>A diagram showing multiple pieces being combined in different ways to produce different outputs.</p>
</alt>
</image>
Поскольку книга будет опубликована как в бумажном, так и в электронном виде, нам нужны разные форматы файлов для каждой графики. Здесь исходная графика assemble.svg
и тот же файл используется для печати (имеется в fo
виду xsl-fo). Но для epub, который не поддерживает SVG, мы используем assemble.png
. XML также предоставляет alt
графическое изображение и позволяет также включать информацию о размерах.
Когда я включаю графику в книгу, инструкция включения фактически указывает на XML-файл, а не непосредственно на графический файл. Затем код обработки считывает XML-файл и создает условную разметку DocBook для использования с каждой версией сборки книги.
Этот подход позволяет обойти любые трудности с включением метаданных в сами графические файлы и обеспечивает уровень абстракции, позволяющий использовать разные форматы файлов для разных носителей.
Что-то подобное должно работать для ваших сборок. Просто потребуется либо некоторая предварительная обработка ваших исходных файлов, либо какие-то дополнительные правила обработки графики.
Недостаток указания на файл XML, а не на графику, заключается в том, что графика не будет отображаться в графическом редакторе XML. Но есть обходной путь. Вместо того, чтобы указывать на XML-файл в источнике, укажите на графический файл, как обычно, но перепишите код обработки для инструкции включения, чтобы удалить расширение графического файла и прочитать XML-файл с тем же именем в том же каталоге.
Раньше я работал над проектом, в котором мы писали графический пользовательский интерфейс для группы художников. Хотя я не могу связать эту конкретную программу. По сути, Subversion должна уметь делать все, что вам нужно. Пример статьи: http://www.wensh.net/archive.php/topic/1556.html
Madcap Flare должен помочь.
Стивен Дреннон
просто
Лорен-Клир-Моника-Ипсум
Моника Челлио
просто
Ральф Галлахер
Моника Челлио
Крэйг Сефтон
Крэйг Сефтон
Отойди
Джон Смитерс
Моника Челлио