smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #220 from efx/topic-docs

Browse Source 
add documentation on positioning units
This commit is contained in:
Dolan
2018-12-12 00:17:55 +00:00
committed by GitHub
parent d3af3663ec 249e44532f
commit 3b6aca2451
1 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/usage/document.md
View File

@ -5,7 +5,7 @@
To create a new document, it is very easy:
```js
var doc = new docx.Document();
const doc = new docx.Document();
```
## Document properties
@ -13,7 +13,7 @@ var doc = new docx.Document();
You can add properties to the Word document by specifying options, for example:
```js
var doc = new docx.Document({
const doc = new docx.Document({
creator: "Dolan Miu",
description: "My extremely interesting document",
title: "My Document",
@ -22,14 +22,18 @@ var doc = new docx.Document({
### Full list of options:
```
creator
description
title
subject
keywords
lastModifiedBy
revision
```
* creator
* description
* title
* subject
* keywords
* lastModifiedBy
* revision
You can mix and match whatever properties you want, or provide no properties.
### units for positioning
Various parts of the API require positioning arguments. The units are "20ths of a point" from the [OOXML](http://officeopenxml.com/index.php) specification.
See [Lars Corneliussen's blog post](https://startbigthinksmall.wordpress.com/2010/01/04/points-inches-and-emus-measuring-units-in-office-open-xml/) for more information and how to convert units.