lua-docx's Introduction

lua-docx

Simple lua library to replace tags in the docx template file.

Usage

local sock_file = '/home/rogon/tmp/exec.sock' 
local tmp_dir = '/home/myhome/tmpdir'

local docx = require 'docx'
local docx_cleaner = require 'docx-cleaner'

local dc = docx_cleaner.new(tmp_dir, sock_file_path)
local cleaned_docx = dc:clean_xml(./tmp/docx-tpl.docx')

local doc  = docx.new(tmp_dir)
local ok, err = doc:replace_tags(cleaned_docx, { 
  ['#matters.name#'] = 'Some name',
  ['#matters.email#'] = '[email protected]'
})

-- copy docx file to public web directory
local res, err = os.rename(cleaned_docx, '/var/www/public/20170601.docx')

Forward the browser url point to this file eg: https://mydomain.com/20170601.docx

API

new(tmp_file_dir)

tmp_file_dir string output file directory

replace_tags(docx_tpl_path, tags)

docx_tpl_path string docx file with full path
tags table table of tag -> value
return boolean, err

Installation

It is important to configure the lua-docx-xml-cleaner in order for lua-docx to work properly.

#luarocks install --server=http://luarocks.org/dev lua-zip
#luarocks install lua-docx-xml-cleaner
#luarocks install lua-docx

lua-docx's People

Contributors

Stargazers

Watchers

lua-docx's Issues

Failed to generate content when the replacement text contain character "&"

Need to encode the character "&" to &

Move the xml cleaning part to separate repository

We are currently using libreoffice running as service in server to clean up dirty xml tags produced by Ms. Word. In the future, we might want to use a better way to cleanup the XML tags using lua xml parser.