Использование метаданных prodname в DITA?

Каково предполагаемое использование элементов метаданных внутри элемента prodinfo в метаданных DITA?

Каждая prodinfo (может быть несколько) имеет только одно prodname, а потом внутри можно указать компонент, марку, серию и т.д.

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

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

Пример:

    <metadata>
        <prodinfo>
            <prodname>SuperMachine</prodname>
            <vrmlist>
                <vrm version="1.0"/>
            </vrmlist>
            <component>power pack</component>
            <component>engine</component>
            <brand>ACME</brand>
            <series>Z32</series>
        </prodinfo>
    </metadata>

Я думаю, что в этом случае метаданные компонента не должны быть привязаны к конкретному продукту. Итак, как эти части предназначены для использования в метаданных DITA?


dita
person Anders    schedule 26.02.2013    source источник

Ответы (3)


arrow_upward
1
arrow_downward

Мы используем prodname в наших файлах карты, чтобы определить шаблон PDF для использования в наших сценариях преобразования. Каждый продукт имеет свой внешний вид, и значение prodname определяет, какой формат использовать. И мы используем марку, серию и т. д. (также указанные в файле карты) в качестве значений для создания первой страницы PDF.

Не уверен, что это лучший подход, но для нас он работает достаточно хорошо.

person Nathalie Laroche    schedule 08.03.2013
comment
Я согласен, такое использование имеет смысл, и в этом отношении у меня не так много проблем с prodinfo, хотя я до сих пор не понимаю, для чего в этом контексте будет предназначен компонентный подэлемент. Проблема больше в его полезности в темах. Исходная ситуация заключалась в том, что нам нужен был элемент метаданных для компонента, и мы нашли его в prodinfo. Но это не имело для нас смысла, так как мы считали компонент типом метаданных, которым можно пометить что-то независимо от того, к какому продукту принадлежал этот конкретный компонент... - person Anders; 08.03.2013
comment
Натали, ваш ответ может не совсем быть ответом на мой вопрос, но он указывает на то направление, которое я прокомментировал в своем первом комментарии, - что prodinfo больше всего подходит в качестве метаданных ditamap, и что могут быть проблемы в его структуре (как с метаданными компонентов), присущими самой модели. Из-за отсутствия доказательств против этого я буду считать это своей интерпретацией вашего ответа :-) и отмечу его как ответ. - person Anders; 13.03.2013
comment
Я все еще относительно новичок в DITA, поэтому я не чувствую себя достаточно уверенно, чтобы иметь возможность полностью отвечать на вопросы и обсуждать проблемы. Все же. :) Но я хотел поделиться тем, как мы используем prodinfo в наших картах, и я рад, что это немного помогло. - person Nathalie Laroche; 13.03.2013

arrow_upward
3
arrow_downward

Для наших целей способ prodinfo для описания метаданных продукта просто работает. У нас следующая ситуация: у нас есть программный продукт (серверное приложение), который продается под собственной торговой маркой, а также в OEM-модели с разными брендами.

Итак, что мы делаем дальше:

<metadata>
    <prodinfo>
        <prodname>OurBigServerSoftware</prodname>
        <vrmlist>
            <vrm version="10"/>
        </vrmlist>
        <component>PDF rendering engine</component>
        <brand>OEM Partner 1</brand>
    </prodinfo>
</metadata>

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

Я думаю, это просто способ сказать, что есть сценарий, в котором это имеет смысл :-)

person David Heijl    schedule 28.02.2013
comment
Ок, немного другая ситуация. Я имею в виду метаданные, которые можно использовать для поиска повторно используемого контента, а не для фильтрации. Таким образом, в основном тема может быть о дизельном двигателе, например, в настоящее время используется для одного продукта, и потенциально может использоваться повторно, поэтому другой пользователь может захотеть найти темы о дизельном двигателе. Но тогда эти метаданные не должны быть привязаны к метаданным конкретного продукта (как это делается в prodinfo). - person Anders; 28.02.2013
comment
Понимаю. Я могу ошибаться, но не могли бы вы добавить в тему дизельного двигателя вторую продинфо, чтобы указать, что она действительна как для дизеля грузовика А (с версией X, марки Y, ...), так и для грузовика B (с версией Z, маркой Y, ...)? - person David Heijl; 01.03.2013
comment
Ну, я думал об этом, но в этом и суть проблемы - это кажется нелогичным и повторяющимся: если продинформация предназначена для уникальных продуктов, а метаданные компонентов должны быть общими (дизельный двигатель как в повторно используемом материале), то нет смысла повторять эти метаданные внутри каждой prodinfo. Для многих тем вообще не имеет смысла использовать prodinfo, если это очень многоразовые темы, и тогда компонент даже не будет доступен. - person Anders; 01.03.2013

arrow_upward
3
arrow_downward

Мысль об этом вопросе заключалась бы в том, чтобы полагаться на карту для определения метаданных для конкретного контекста. Затем вы можете использовать @conkeyref в теме для извлечения из карты, чтобы в выходных данных генерировалась правильная информация для правильной структуры, которую вы описываете в этот момент. Таким образом, у вас не будет нескольких элементов в одной теме, чтобы показать применимость темы.

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

person JulioV    schedule 07.03.2013
comment
Интересные моменты, но, боюсь, не совсем то, что мне нужно. Я забыл упомянуть, что я говорю об использовании в CMS, причем без поддержки conkeyref или keyref, поскольку DITA 1.2 еще не поддерживается. Кроме того, я сомневаюсь в полезности элемента prodinfo в контексте темы для поиска, и особенно в подэлементе компонента. И если он используется для поиска, то получить его с карты будет невозможно. Но может в этом и проблема - продинфо есть и для дитамапов и для тем, тогда как в дитамапах смысл есть, а в темах возможно нет... - person Anders; 08.03.2013
comment
Хотя это не тот ответ, который мне нужен, я награжу вас наградой за интересные идеи, так как срок действия награды истечет, если я подожду ответа, который мне нужен :-) - person Anders; 13.03.2013