https://github.com/sergei-mironov/urxml

XML parser and indenter supporting Ur/Web's dialect. VIM-friendly.
https://github.com/sergei-mironov/urxml

Last synced: 5 days ago
JSON representation

XML parser and indenter supporting Ur/Web's dialect. VIM-friendly.

• Host: GitHub
• URL: https://github.com/sergei-mironov/urxml
• Owner: sergei-mironov
• License: other
• Created: 2013-09-04T14:59:49.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-31T08:42:37.000Z (about 11 years ago)
• Last Synced: 2024-10-28T14:22:17.975Z (17 days ago)
• Language: Haskell
• Homepage:
• Size: 133 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
UrXML

=====

UrXML is yet another XML parser/pretty-printer based on

[RSXP](http://hackage.haskell.org/package/really-simple-xml-parser) package by

CK Kashyap.

UrXML is vim-friendly and can be used to pretty-print the XML-fragment of

non-XML file.

Additionaly, the tool is able to translate the usual XML into

[Ur/Web](http://www.impredicative.com/ur/) dialect of XML (uses several

hardcoded rules)

Installation

------------

[Haskell platform](http://www.haskell.org/platform/) is required.

    $ git clone https://github.com/grwlf/urxml

    $ cd urxml

    $ cabal configure

    $ cabal build

    $ cabal install

Usage

-----

    $ urxml --help

    XML converter/indenter

    Usage: urxml [-w|--text-width INT] [-m|--right-margin INT] [-i|--start-indent INT] [-s|--tab-stop INT] [-e|--expand-tab] [-1|--skip-first] [-S|--skip-schema] [-u|--ur-attrs] [FILE]

      Ur/Web XML indenter (Ur/Web dialect of XML supports {}-style attributes).

    Available options:

      -h,--help                Show this help text

      -w,--text-width INT      Recommended text width (not strict)

      -m,--right-margin INT    Right margin

      -i,--start-indent INT    Indent to start from

      -s,--tab-stop INT        Tab stop

      -e,--expand-tab          Expand tab

      -1,--skip-first          Don't indent 1st line

      -S,--skip-schema         Don't print DOCTYPE and stuff

      -u,--ur-attrs            Convert tag attributes to the Ur/Web format

      FILE                     File or `stdin' to read from the stdin

Examples

--------

Simple pretty-printing:

    $ urxml test.xml 

    

        Under a

        

            

                under c1 asd asd asd asd asd as dasd asd as dasdasd asd asdas dasd asdas das das

                dasdas dasdasdas das dasdasdasd

            

            under c2

            under c3

            under c4

        

    

Pretty-print with indentation:

    $ urxml -i 5 test.xml 

         

             Under a

             

                 

                     under c1 asd asd asd asd asd as dasd asd as dasdasd asd asdas dasd asdas das das

                     dasdas dasdasdas das dasdasdasd

                 

                 under c2

                 under c3

                 under c4

             

         

Pretty-print with indentation, don't indent first line:

    $ urxml -i 5 -1 test.xml 

    

             Under a

             

                 

                     under c1 asd asd asd asd asd as dasd asd as dasdasd asd asdas dasd asdas das das

                     dasdas dasdasdas das dasdasdasd

                 

                 under c2

                 under c3

                 under c4

             

         

and so on.

VIM integration

---------------

UrXML is the easy way of formatting XML inside non-XML documents. Just paste

the following lines into your ~/.vimrc and format the XML by visually selecting

the fragment (note, that it should be a correct part of XML with matching tags)

and pressing the '!' key, as set in the last line of the fragment.

    " ~/.vimrc fragment

    function! ProgramFilter(vt, ...)

      normal `<

      let p = getpos ('.')

      let [qr, qt] = [getreg('"'), getregtype('"')]

      let [oai, ocin, osi, oinde] = [&ai, &cin, &si, &inde]

      setl noai nocin nosi inde=

      let [sm, em] = ['[<'[a:0], ']>'[a:0]]

      exe 'norm!`' . sm . a:vt . '`' . em . 'x'

      let tw = &tw

      setl tw=0

      let cmd = 'urxml -i ' . (p[2]-1) . ' -1 --tab-stop 2 --ur-attrs stdin'

      let out = system(cmd, @")

      let out = substitute(out, '\n\n$', '', '')

      exe "norm!i\=out\r"

      let &tw = tw

      let [&ai, &cin, &si, &inde] = [oai, ocin, osi, oinde]

      call setreg('"', qr, qt)

    endfunction

    vnoremap  ! :call ProgramFilter(visualmode(), 1)

RSXP's README

-------------

The original project is located at

https://github.com/ckkashyap/really-simple-xml-parser

A really simple xml parser in Haskell using Parsec.

I wrote this primarily to learn Parsec and I intend to use it in my automations where I need to parse XML's returned from bug tracking systems and other systems.

I am not an XML fan - in fact, I hate it.

I'd like to acknowledge the help I got from the wonderful Haskell community for this. I'd particularly like to call out the help provided by the following folks -

1. Antoine Latter 

1. Simon Hengel