xmlcreate

2019-01-12 admin

xmlcreate是什么

什么是xmlcreate,Simple XML builder for Node.js

xmlcreate使用教程帮助文档

xmlcreate

Build Status npm version

Overview

xmlcreate is a Node.js module that can be used to build XML using a simple API.

Features

xmlcreate allows you to use a series of chained function calls to build an XML tree.

Once the tree is built, it can be serialized to text. The formatting of the text is customizable.

xmlcreate can perform some basic validation to check that the resulting XML is well-formed.

Installation

The easiest way to install xmlcreate is using npm:

npm install xmlcreate

You can also build xmlcreate from source using npm and gulp:

git clone https://github.com/michaelkourlas/node-xmlcreate.git
npm install
./node_modules/.bin/gulp

The default target will build the production variant of xmlcreate, run all tests, and build the documentation.

You can build the production variant without running tests using the target prod. You can also build the development version using the target dev. The only difference between the two is that the development version includes source maps.

Usage

The documentation for the current version is available here.

You can also build the documentation using gulp:

gulp docs

Examples

The following example illustrates the basic usage of xmlcreate:

import {document} from "xmlcreate";

const tree = document();
tree
    .decl({encoding: "UTF-8"})
        .up()
    .dtd({
             name: "html",
             pubId: "-//W3C//DTD XHTML 1.0 Strict//EN",
             sysId: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
        })
        .up()
    .element({name: "root"})
        .attribute({name: "xmlns"})
            .text({charData: "http://www.w3.org/1999/xhtml"})
                .up()
            .up()
        .attribute({name: "xml:lang"})
            .text({charData: "en"})
                .up()
            .up()
        .element({name: "head"})
            .element({name: "title"})
                .charData({charData: "My page title"})
                    .up()
                .up()
            .up()
        .element({name: "body"})
            .element({name: "h1"})
                .charData({charData: "Welcome!"})
                    .up()
                .up()
            .element({name: "p"})
                .charData({charData: "This is some text on my website."})
                    .up()
                .up()
        .element({name: "div"})
            .element({name: "img"})
                .attribute({name: "src"})
                    .text({charData: "picture.png"})
                        .up()
                    .up()
                .attribute({name: "alt"})
                    .text({charData: "picture"})
                        .up()
                    .up()
                .up()
            .up()
        .up();

console.log(tree.toString({doubleQuotes: true}));

This example produces the following XML:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
        <title>My page title</title>
    </head>
    <body>
        <h1>Welcome!</h1>
        <p>This is some text on my website.</p>
    </body>
</html>

Additional examples can be found in examples/example.js.

Tests

xmlcreate includes a set of tests to verify core functionality. You can run the tests using gulp:

gulp test

The test target builds the production variant of xmlcreate before running the tests. The test-prod target does the same thing, while the test-dev target builds the development variant first instead.

License

xmlcreate is licensed under the Apache License 2.0. Please see the LICENSE.md file for more information.

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-50820.html

文章标题:xmlcreate

回到顶部