Jump to content
Justin Huang

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

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>

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

×