Holarch

Управление и рецензирование

Файлы Word и PDF как Artifact

Добавление документов Word и PDF в проект как Artifact, рецензирование и комментирование их страниц, хранение всех версий и освобождение места за счёт удаления файлов старых версий.

Как использовать →

На этой странице
  1. Понятия
  2. Как использовать
    1. Когда и зачем
    2. Добавление файлов Word или PDF
    3. Загрузка новой версии
    4. Рецензирование и комментарии
    5. Комментарии к более поздним версиям
    6. Комментарии и исправления из Word
    7. Сравнение двух версий
    8. Разобранный пример: рецензирование проекта в демо CubeSat EO-1
    9. Советы и рекомендации
    10. Типичные ошибки
    11. Как это связано с остальным
  3. Раздел «Файл»
  4. Удаление файлов старых версий
  5. Добавляемые файлы
  6. Без преобразования
  7. Сообщения
  8. Ограничения
  9. Связанные материалы

Документ Word или PDF может храниться в проекте как Artifact. Рецензенты читают его в Holarch, комментируют его страницы и утверждают, как любой другой элемент. Каждая новая загрузка того же документа становится новой версией, а более ранние версии остаются доступными для чтения.

В облачном сервисе файлы Word при добавлении преобразуются в PDF, а файлы PDF сжимаются. Именно PDF все читают, скачивают и комментируют.

Понятия

  • Файловый Artifact: Artifact, содержащий файл. На его странице вверху есть раздел Файл со средством просмотра, версиями и инструментами для файла.
  • Версия: одна загрузка документа. Каждая версия хранит свой PDF, кто её загрузил, дату и необязательное примечание. По умолчанию показывается самая новая версия.
  • Преобразование: перевод файла Word в PDF и сжатие PDF. Для всех одновременно преобразуется один файл; файлы разных учётных записей обрабатываются по очереди, поэтому один большой пакет не задерживает остальных.
  • Закреплённый комментарий: комментарий, относящийся к месту в одной версии: выделенным словам, точке, рамке или целой странице (или, в представлении Word, абзацу). «Обсуждение» показывает, где он находится, например “в версии 2, страница 3”.

Как использовать

Когда и зачем

Используйте файловый Artifact, когда результат работы написан вне Holarch: пакет для рецензирования проекта, документ управления интерфейсом поставщика, отчёт об испытаниях. Хранение в проекте помещает его рядом с требованиями и элементами, которые он охватывает. Рецензенты комментируют в одном месте, а базовые линии записывают, какая версия была утверждена.

Добавление файлов Word или PDF

  1. Откройте Базу данных проекта LML.
  2. Нажмите + Новый элемент, затем Artifact из файла Word или PDF… под полем Имя. Когда база данных показывает только Artifact, кнопка называется + Новый Artifact, а кнопка диалога — Из файла Word или PDF…. Диалог закрывается, и открывается окно выбора файла.

    Та же кнопка есть в диалоге нового элемента везде, где он открывается, например ⌘K / Ctrl+K → Новый элемент…. Можно также перетащить файлы .docx и .pdf на таблицу базы данных или нажать ⌘K / Ctrl+K и выполнить Artifact из файла… на любой странице проекта.

  3. Выберите один или несколько файлов.

    Над таблицей появится Добавляемые файлы с состоянием каждого файла: “Ожидание (впереди 2)”, Преобразование…, Сжатие… или Сохранение….

  4. Подождите или продолжайте работать. Вкладку можно закрыть.

    Когда файл готов, Holarch сообщает: “Файл Design Review.docx готов как Artifact.” Если у вас не открыта ни одна вкладка Holarch, сообщение приходит по электронной почте.

Каждый файл становится одним Artifact с именем файла без расширения. Уведомление сообщает сохранённый размер, например “Сохранено как 2.1 MB, сжато из 15 MB.”

Загрузка новой версии

  1. Откройте Artifact.
  2. В разделе Файл нажмите Загрузить новую версию… и выберите файл.
  3. При желании введите Примечание к новой версии, например “Comments from the design review addressed”, и нажмите Загрузить как новую версию.

    Пока новая версия не готова, на странице показывается “Новая версия Design Review.docx: Преобразование…”.

Когда вы добавляете файл, имя которого совпадает с Artifact, уже созданным из файла с таким именем, диалог Файл уже в проекте спрашивает, что делать:

  • Загрузить как новую версию (по умолчанию): файл становится следующей версией этого Artifact.
  • Сохранить оба: отдельный Artifact, к имени которого добавляется “ (2)”.
  • Отмена: ничего не добавляется.

Рецензирование и комментарии

  1. Откройте Artifact. Страницы показывает PDF в средстве просмотра документов: панель инструментов, страницы и рядом панель Комментарии.
  2. Перемещайтесь по документу с помощью панели инструментов: Страница 3 из 12 (введите номер страницы и нажмите Enter), кнопки предыдущей и следующей страницы, Миниатюры, масштаб (По ширине, Страница целиком или фиксированный размер) и Найти (⌘F / Ctrl+F). Клавиши: ← и → листают страницы, Home и End переходят к первой и последней странице, + и − меняют масштаб.
  3. Комментировать можно четырьмя способами:
    • Выделить текст: выделите слова на странице (их можно также скопировать), затем нажмите Комментировать выделенное. Слова подсвечиваются.
    • Точка: щёлкните место на странице, к которому относится комментарий.
    • Рамка: обведите рамкой область, например рисунок или таблицу.
    • Комментировать страницу: комментарий к показанной странице в целом.

      Введите комментарий на панели и нажмите Добавить комментарий (⌘Enter / Ctrl+Enter). Введите @ и имя, чтобы упомянуть кого-либо.

  4. Панель Комментарии перечисляет обсуждения в порядке страниц, пронумерованные так же, как их маркеры на странице. Нажмите обсуждение, чтобы перейти к его месту; нажмите маркер или подсветку, чтобы открыть его обсуждение. Ответить, Решить и Открыть снова работают так же, как в «Обсуждении»; Показать решённые показывает решённые обсуждения.
  5. Чтобы было больше места, нажмите Режим рецензирования (версия на всё окно) или Открепить (отдельное окно, например на втором экране). Оба остаются актуальными по мере того, как люди комментируют.

Каждый комментарий относится к версии, в которой он сделан, и «Обсуждение» тоже это показывает, например “в версии 2, страница 3”. Комментирование никогда не меняет файл: подписанный PDF сохраняет свою подпись.

Комментарии к более поздним версиям

Когда добавляется новая версия, открытые обсуждения переходят в неё, поэтому рецензирование продолжается от версии к версии:

  • Holarch находит слова каждого обсуждения в новой версии, даже если они переместились на другую страницу или окружающий текст перетёк. Обсуждение показывается там с пометкой Из версии 1 (версии, в которой оно было сделано).
  • Если слова были отредактированы, обсуждение также помечается Текст изменён с тех пор и показывает, что было в более ранней версии, например “В версии 1 было: «reject 40 W»”.
  • Если слов больше нет, обсуждение указывается в разделе Более ранние версии в конце панели «Комментарии» с цитируемыми словами и кнопкой Показать в версии 1 (последней версии, где они есть).
  • Точка или Рамка следует за ближайшей строкой текста. На странице без текста (чертёж или скан) она остаётся на месте, если страница в новой версии выглядит так же; иначе она переходит в «Более ранние версии».
  • Решённые обсуждения остаются в тех версиях, где они были. Откройте обсуждение снова, чтобы оно перешло в более новые версии.
  • Сделаны в (над обсуждениями, когда есть обсуждения из нескольких версий) показывает только обсуждения, сделанные в одной версии, или все.
  • Обсуждения из Word подчиняются тем же правилам.

Это происходит при добавлении новой версии. Проекты с комментариями, сделанными до появления этой функции, обрабатываются так же при первом показе более новой версии. В «Обсуждении» комментарий из более старой версии сообщает, где он находится сейчас, например “On version 1, page 2, «radiator» · carried to version 3” или “· not in version 3”.

Комментарии сохраняют цитируемые слова, поэтому их можно прочитать и после удаления файла старой версии. Отредактированный комментарий сохраняет прежний текст: Прежний текст под комментарием перечисляет каждую прежнюю формулировку с автором и временем.

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

Комментарии и исправления из Word

В облачном сервисе собственная рецензионная разметка файла Word переносится при его добавлении:

  • Его комментарии становятся обсуждениями на PDF — на тех словах, к которым они были сделаны, — вместе с ответами. Каждый сохраняет автора и дату из Word и помечается Из Word. Комментарий, отмеченный в Word как выполненный, приходит решённым.
  • Его исправления перечисляются как предложения: “Suggested insertion: …” или “Suggested deletion: …” от имени того, кто их сделал.
  • PDF показывает комментарии на полях, а исправления — как правку красным.

Уведомление после загрузки сообщает, что перенесено, например “Перенесено из Word: 3 комментария и 2 исправления.” Импортированные обсуждения принадлежат вам, поэтому вы можете решать или удалять их. Люди, отслеживающие элемент, не получают уведомления о каждом импортированном комментарии.

Сравнение двух версий

  1. Откройте Artifact. В разделе Файл нажмите Сравнить версии… (показывается, когда у Artifact две версии или больше).
  2. Выберите версии Старая и Новая. По умолчанию показанная версия сравнивается с предыдущей.

    Две версии появляются рядом, страница за страницей:

    • Вставленные слова выделены зелёным в более новой версии.
    • Удалённые слова выделены красным в более старой версии.
    • Перемещённые предложения и абзацы выделены фиолетовым в обоих местах. Перемещённый блок, который также был отредактирован, показывает и изменения слов. Список изменений называет обе страницы, например “Страница 2 → страница 5”.
    • Страницы без текста (чертежи, сканы) сравниваются как изображения. Изменённая страница обводится; на более новой странице Различия показывает красным места, где краска есть только в более старой версии, и зелёным — где только в более новой.
  3. Выберите изменение в списке или нажмите Назад и Далее (F7 и Shift+F7), чтобы показать его с обеих сторон. Синхронная прокрутка держит один и тот же текст рядом при прокрутке.

Текст сравнивается по всему документу, поэтому текст, перемещённый на другую страницу или перетёкший на другие строки, всё равно сопоставляется. Файл Word, сохранённый без преобразования, сравнивается как текст, без страниц. Для длинных документов во время чтения показывается индикатор хода выполнения.

То же сравнение отмечает изменения текста и в других местах: рецензирование запросов на изменение, история элемента, изменения документов и различия библиотек показывают перемещённые предложения как перемещённые со ссылкой Перемещено в / Перемещено из между двумя местами.

Разобранный пример: рецензирование проекта в демо CubeSat EO-1

  1. В демо CubeSat EO-1 откройте базу данных, нажмите + Новый элемент и добавьте “EO-1 CDR Package.docx” с помощью Artifact из файла Word или PDF….
  2. Когда он будет готов, откройте EO-1 CDR Package и свяжите его с требованиями, которые он охватывает.
  3. Рецензенты открывают его и используют Комментировать страницу… для страницы 12: “Thermal margin table is missing the eclipse case.”
  4. После исправлений снова загрузите “EO-1 CDR Package.docx” и выберите Загрузить как новую версию с примечанием “CDR comments addressed”.
  5. Создайте базовую линию. Страница Artifact показывает В базовых линиях с именем базовой линии для версии 2.

Советы и рекомендации

  • Загружайте каждую новую версию под тем же именем файла. Тогда один Artifact хранит всю историю.
  • Загружайте PDF вместо файла Word, когда макет должен точно совпадать с Word: преобразование может сдвинуть переносы строк.
  • Подписанные PDF, формы PDF, файлы PDF/A и зашифрованные PDF хранятся точно в загруженном виде. Сжатие нарушило бы подпись, форму или соответствие стандарту.

Типичные ошибки

  • Появился второй Artifact: вы выбрали Сохранить оба. Удалите его, затем снова загрузите файл и выберите Загрузить как новую версию.
  • Файл Word больше 100 МБ отклонён: в Word выберите File → Save As → PDF, затем загрузите PDF.

Как это связано с остальным

Раздел «Файл»

Элемент управленияЧто он делает
ВерсияПоказывает версию: “Версия 3 (последняя) · date · uploader”. Версии, файл которых удалён, помечены “файл удалён”.
Скачать (PDF)Сохраняет PDF показанной версии. Файл Word, показанный без преобразования, предлагает Скачать (.docx).
Восстановить как последнююСнова делает показанную версию самой новой — как новую версию. Ничего не перезаписывается. Только для редакторов, недоступно для последней версии.
Загрузить новую версию…Добавляет следующую версию. Только для редакторов.
Сравнить версии…Две версии рядом с отмеченным вставленным, удалённым и перемещённым текстом. См. “Сравнение двух версий”.
Удалить файлы старых версий…Удаляет файлы выбранных старых версий. См. ниже.
Страницы / Просмотр PDFСредство просмотра документов (страницы, поиск, комментарии) или собственное средство просмотра PDF браузера (печать).
Режим рецензирования / ОткрепитьСредство просмотра документов на всё окно или в отдельном окне.
Комментировать страницу… / Закрепить комментарийВ представлении Word (файл Word, сохранённый без преобразования): комментарий к странице по её номеру или к абзацу, который вы щёлкнете. Нажмите Прекратить закрепление, чтобы закончить. Для PDF используются собственные инструменты средства просмотра (см. «Рецензирование и комментарии»).

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

Удаление файлов старых версий

PDF старых версий занимают место в хранилище. Удалите те, которые никому не нужны:

  1. В Artifact нажмите Удалить файлы старых версий….
  2. Выберите версии.

    Появится сообщение “Removes the files of version 2 permanently. The version stays in the history.” (файлы версии 2 удаляются навсегда; версия остаётся в истории).

  3. Нажмите Удалить файлы.

    Появится сообщение “Removed the files of 1 version (12.4 MB freed).”

  • Кто может удалять: владелец учётной записи на личном тарифе (владелец проекта), администратор организации на тарифе Team. Администратору организации не нужен доступ на редактирование проекта; удаление выполняется от имени администратора.
  • Последнюю версию так удалить нельзя. Чтобы удалить её, удалите Artifact.
  • Версия остаётся в списке с пометкой “Файл удалён: name, date”. Её комментарии остаются в «Обсуждении» как текст.
  • Удаление записывается в журнал аудита вместе с версиями и освобождённым местом.

Добавляемые файлы

Пока ваши загрузки в пути, база данных показывает Добавляемые файлы.

  • Загрузка…: файл отправляется. Отмена останавливает загрузку, и ничего не добавляется.
  • Ожидание (впереди n) или Ожидание (следующий): файл ждёт своей очереди. Отмена убирает его из очереди.
  • Преобразование…, Сжатие…, Сохранение…: файл обрабатывается.
  • Файл, который не удалось добавить, остаётся в списке со своим сообщением, пока вы не нажмёте Скрыть.

Если сервер перезапускается во время преобразования, файл возвращается в очередь и обрабатывается ещё раз.

Без преобразования

Когда на сервере нет преобразователя, файлы хранятся в загруженном виде:

  • PDF хранятся без сжатия.
  • Файлы Word показываются в браузере только для чтения: “Shown read-only in the browser (no PDF conversion on this server). Layout may differ from Word.” (показано только для чтения; на этом сервере нет преобразования в PDF). Тогда Закрепить комментарий закрепляет комментарии к абзацам.

Сообщения

СообщениеЧто делать
“Файл file занимает 140 МБ. Файлы Word больше 100 МБ нельзя преобразовать. В Word выберите File → Save As → PDF, затем загрузите PDF.”Сохраните документ в Word как PDF и загрузите PDF.
“Не удалось преобразовать file: файл защищён паролем. Снимите пароль и загрузите файл снова.”Откройте файл в Word, снимите пароль на открытие, сохраните и загрузите снова.
“Не удалось преобразовать file: файл повреждён или не является документом Word.”Откройте и сохраните файл в Word или загрузите PDF.
“Не удалось преобразовать file: это заняло больше 5 минут (очень большой или сложный файл). Разделите его или сохраните как PDF и загрузите PDF.”Разделите документ или сохраните его в Word как PDF и загрузите PDF.
“Не удалось преобразовать file: нужно больше памяти, чем есть у преобразователя (много больших изображений). Уменьшите изображения или загрузите PDF.”Сожмите рисунки в Word (Picture Format → Compress Pictures) или загрузите PDF.
“Не удалось сохранить file: файл повреждён или не является PDF.”Сохраните PDF заново из программы, в которой он создан.
“Artifact становятся только документы Word (.docx) и PDF. Не добавлено: files.”Сначала сохраните файлы других форматов как .docx или PDF.
Сообщение об ограничении на файлФайл превышает ограничение вашего тарифа на размер файла. Для файла Word также дан совет сохранить его как PDF.

Если файл не удаётся добавить, ничего не сохраняется: ни Artifact, ни версия, а загрузка удаляется.

Ограничения

ТарифНа файл
Free / Academic10 МБ
Individual25 МБ
Team100 МБ
  • Файлы Word больше 100 МБ нельзя преобразовать ни на одном тарифе.
  • Ограничение на файл относится к загружаемому файлу. Сохранённый PDF учитывается в хранилище проекта и вашем хранилище.
  • Artifact из Word и PDF доступны в проектах LML.