Jump to content

Is to good to add a view to list user guide in component description?


Justin Huang

Recommended Posts

I'd like to describe IP documents, e.g., user guide, in IP-XACT XML file.

I did not find any example showing how to describe docs in IP-XACT XML, I added a Documentation view, documentation componentInstantiation and fileSets as shown below, is it recommended way?

 

<ipxact:component ...>
    ...
    <ipxact:model>
        <ipxact:views>
            <ipxact:view>
                <ipxact:name>Documentation</ipxact:name>
                <ipxact:envIdentifier>::</ipxact:envIdentifier>
                <ipxact:componentInstantiationRef>documentation</ipxact:componentInstantiationRef>
            </ipxact:view>
        </ipxact:views>
        <ipxact:instantiations>
            <ipxact:componentInstantiation>
                <ipxact:name>documentation</ipxact:name>
                <ipxact:fileSetRef>
                    <ipxact:localName>UG</ipxact:localName>
                </ipxact:fileSetRef>
            <ipxact:componentInstantiation>
        <ipxact:instantiations>
    </ipxact:model>
    <ipxact:fileSets>
        <ipxact:fileSet>
            <ipxact:name>UG</ipxact:name>
            <ipxact:file>
                <ipxact:name>docs/xxx_user_guide.pdf</ipxact:name>
                <ipxact:fileType user="pdf">user</ipxact:fileType>
            </ipxaxct:file>
    </ipxact:fileSets>
    ...
</ipxact:component>

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...