xmlcreateFS

creates an XML file passing through publishFS

Syntax

  • docNode=xmlcreateFS(FileName)example
  • docNode=xmlcreateFS(FileName,Name,Value)example
  • [docNode,docNodechr]=xmlcreateFS(___)example

Description

example

docNode =xmlcreateFS(FileName) Create DOM object starting from file tclust.

example

[docNode, docNodechr] =xmlcreateFS(___)

Examples

expand all

  • Create DOM object starting from file tclust.
  • Make sure FSDA path is loaded.

    addFSDA2path;
    NameFile='tclust';
    [docNode,docNodechr]=xmlcreateFS(NameFile,'write2file',false);

    Input Arguments

    expand all

    FileName — MATLAB File. String.

    Full or partial path of the MATLAB file for which Structured XML help has to be created Example-'myfile.m'

    Data Types: single| double

    Name-Value Pair Arguments

    Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

    Example: 'write2file','false' , 'StartColumnEx',5

    write2file —Option to write XML file.logical.

    Option which specifies whether XML file must be created or if just structure docNode must be created. The default value of write2file is true, that is xml file is created in the following path (main root of FSDA) filesep helpfiles filesep XML where filesep means "\" or "/" according to the operating system

    Example: 'write2file','false'

    Data Types: Boolean

    StartColumnEx —Starting column for the code of the examples.scalar.

    This option specifies which is the starting column of the examples. For example if it is equal to 7, the first six spaces are trimmed. The default value of StartColumnEx is 5. This option is necessary to distinguish inside the code of the examples wanted and unwanted indentation.

    Example: 'StartColumnEx',5

    Data Types: double

    Output Arguments

    expand all

    docNodechr —Output string. Character

    Character vector that contains the serialized DOM node as it appears in an XML file.

    References

    See Also

    This page has been automatically generated by our routine publishFS