aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2017-07-16 15:29:23 -0700
committerbnewbold <bnewbold@robocracy.org>2017-07-16 15:29:37 -0700
commit6844b59b818ec835fe5367979dc47efe04f62c4b (patch)
treed65fba91427b5a2e0f4b90463d6a0e99799a1c62
parentcb208a450611405c0de9ce112a5d0786b600c1df (diff)
downloaddivergence-6844b59b818ec835fe5367979dc47efe04f62c4b.zip
divergence-6844b59b818ec835fe5367979dc47efe04f62c4b.tar.gz
forgot to commit meta-json.template
-rw-r--r--LICENSE2
-rw-r--r--Makefile1
-rw-r--r--README.md21
-rw-r--r--meta-json.template1
-rw-r--r--pandoc_confluence.lua6
5 files changed, 31 insertions, 0 deletions
diff --git a/LICENSE b/LICENSE
index 824054e..5ae8250 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,3 +1,5 @@
+Note that pandoc_confluence.lua is from another author; see header for details.
+---------------------------------------------------------------------------
Copyright (c) 2017 Bryan Newbold
Permission is hereby granted, free of charge, to any person obtaining a copy
diff --git a/Makefile b/Makefile
index 08398e0..9771331 100644
--- a/Makefile
+++ b/Makefile
@@ -11,4 +11,5 @@ install:
$(INSTALL) -t $(PREFIX)/bin divergence
$(INSTALL) -d $(PREFIX)/lib/divergence
$(INSTALL) -t $(PREFIX)/lib/divergence pandoc_confluence.lua -m 0644
+ $(INSTALL) -t $(PREFIX)/lib/divergence meta-json.template -m 0644
diff --git a/README.md b/README.md
index 5e43752..df2b3e1 100644
--- a/README.md
+++ b/README.md
@@ -49,3 +49,24 @@ it yet.
You might want to write a shell script wrapper to help with configuration and
pushing multiple files to multiple spaces.
+
+It's probably possible to use any pandoc-supported markup file format (not just
+Markdown), but this hasn't been tested.
+
+Metadata can also be extracted from a pandoc-style YAML header in the markdown
+file itself. This is helpful if you want to override the (case-sensitive, and
+thus buggy) title/page matching behavior, or if you want to override the
+Confluence space for different documents.
+
+ ---
+ confluence-page-id: 12345
+ confluence-space-key: PRJ5
+ confluence-page-title: "Some Fancy Title Here"
+ ...
+
+Space Key is used for creating pages and doing title-based lookup. If page-id
+(a number which can be found in the URL of pages on the confluence site) is
+given, that is used for lookup and editing instead.
+
+Other confluence metadata, such as the page hierarchy, can be modified in the
+Confluence web interface and should persist across updates from this tool.
diff --git a/meta-json.template b/meta-json.template
new file mode 100644
index 0000000..fb36f0f
--- /dev/null
+++ b/meta-json.template
@@ -0,0 +1 @@
+$meta-json$
diff --git a/pandoc_confluence.lua b/pandoc_confluence.lua
index 83c60e2..18823a7 100644
--- a/pandoc_confluence.lua
+++ b/pandoc_confluence.lua
@@ -1,6 +1,12 @@
-- This is a custom writer for Pandoc to output Confluence Storage Format.
-- It is based on the sample custom HTML writer packaged with Pandoc.
--
+-- Copyright 2015 Avi Knoll <aknoll@atlassian.com>
+-- LICENSE: GPLv2
+--
+-- This file extracted from:
+-- https://bitbucket.org/atlassianlabs/confluence-pandoc-connect
+--
-- Note: you need not have lua installed on your system to use this
-- custom writer. However, if you do have lua installed, you can
-- use it to test changes to the script. 'lua sample.lua' will