[PATCH] Add support for ordered list to ox-confluence.el

[PATCH] Add support for ordered list to ox-confluence.el

[Lungang Fang]

[-- Attachment #1.1: Type: text/plain, Size: 421 bytes --]

Hi there,

Attached is a patch for contrib/lisp/ox-confluence.el generated following
instructions on http://orgmode.org/worg/org-contribute.html#patches . It
adds support for ordered list.

I didn't find where I should send this patch. Hopefully, this is the
correct email list for patch request. If it is not, could anyone please
tell me the correct way to submit a patch request to org-mode?

Regards,
-- 
Lungang Fang

[-- Attachment #1.2: Type: text/html, Size: 946 bytes --]

[-- Attachment #2: 0001-ox-confluence.el-Add-support-for-ordered-list.patch --]
[-- Type: application/octet-stream, Size: 1285 bytes --]

From 1cef0cda8f975eda3adc4c46614aad2097ba2baf Mon Sep 17 00:00:00 2001
From: Lungang Fang <lungang.fang@gmail.com>
Date: Wed, 7 Dec 2016 17:26:04 +1100
Subject: [PATCH] ox-confluence.el: Add support for ordered list

* contrib/lisp/ox-confluence.el (org-confluence-item): Support ordered
list

When converting a bullet item, examine the type of it and convert
accordingly.

TINYCHANGE
---
 contrib/lisp/ox-confluence.el | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/contrib/lisp/ox-confluence.el b/contrib/lisp/ox-confluence.el
index 5de9e0f..de8b00e 100644
--- a/contrib/lisp/ox-confluence.el
+++ b/contrib/lisp/ox-confluence.el
@@ -81,9 +81,12 @@
   (format "_%s_" contents))
 
 (defun org-confluence-item (item contents info)
-  (concat (make-string (1+ (org-confluence--li-depth item)) ?\-)
-          " "
-          (org-trim contents)))
+  (let* ((plain-list (org-export-get-parent item))
+         (type (org-element-property :type plain-list))
+         (bullet (if (eq type `ordered) ?\# ?\-)))
+    (concat (make-string (1+ (org-confluence--li-depth item)) bullet)
+            " "
+            (org-trim contents))))
 
 (defun org-confluence-fixed-width (fixed-width contents info)
   (format "\{\{%s\}\}" contents))
-- 
2.9.3 (Apple Git-75)

Fwd: [PATCH] Add support for ordered list to ox-confluence.el

[Lungang Fang]

[-- Attachment #1.1: Type: text/plain, Size: 561 bytes --]

Resend since the previous one seems lost.


Hi there,

Attached is a patch for contrib/lisp/ox-confluence.el generated following
instructions on http://orgmode.org/worg/org-contribute.html#patches . It
adds support for ordered list.

I didn't find where I should send this patch. Hopefully, this is the
correct email list for patch request. If it is not, could anyone please
tell me the correct way to submit a patch request to org-mode?

Regards,
-- 
Lungang Fang




-- 
Lungang Fang
Sydney, NSW 2153, Australia
M: +61 431 208 979 | E: lungang.fang@gmail.com

[-- Attachment #1.2: Type: text/html, Size: 1725 bytes --]

[-- Attachment #2: 0001-ox-confluence.el-Add-support-for-ordered-list.patch --]
[-- Type: application/octet-stream, Size: 1285 bytes --]

From 1cef0cda8f975eda3adc4c46614aad2097ba2baf Mon Sep 17 00:00:00 2001
From: Lungang Fang <lungang.fang@gmail.com>
Date: Wed, 7 Dec 2016 17:26:04 +1100
Subject: [PATCH] ox-confluence.el: Add support for ordered list

* contrib/lisp/ox-confluence.el (org-confluence-item): Support ordered
list

When converting a bullet item, examine the type of it and convert
accordingly.

TINYCHANGE
---
 contrib/lisp/ox-confluence.el | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/contrib/lisp/ox-confluence.el b/contrib/lisp/ox-confluence.el
index 5de9e0f..de8b00e 100644
--- a/contrib/lisp/ox-confluence.el
+++ b/contrib/lisp/ox-confluence.el
@@ -81,9 +81,12 @@
   (format "_%s_" contents))
 
 (defun org-confluence-item (item contents info)
-  (concat (make-string (1+ (org-confluence--li-depth item)) ?\-)
-          " "
-          (org-trim contents)))
+  (let* ((plain-list (org-export-get-parent item))
+         (type (org-element-property :type plain-list))
+         (bullet (if (eq type `ordered) ?\# ?\-)))
+    (concat (make-string (1+ (org-confluence--li-depth item)) bullet)
+            " "
+            (org-trim contents))))
 
 (defun org-confluence-fixed-width (fixed-width contents info)
   (format "\{\{%s\}\}" contents))
-- 
2.9.3 (Apple Git-75)

Re: Fwd: [PATCH] Add support for ordered list to ox-confluence.el

[Nicolas Goaziou]

Hello,

Lungang Fang <lungang.fang@gmail.com> writes:

> Attached is a patch for contrib/lisp/ox-confluence.el generated following
> instructions on http://orgmode.org/worg/org-contribute.html#patches . It
> adds support for ordered list.

Thank you. 

However, this somewhat conflicts with a patch recently sent on the ML,
but not yet applied, by Charles Durst (Cc'ed).

Could one double-check if one doesn't supersede the other, or if they
could be merged (although I suspect the former) and report back so
I know what patch to apply?

Regards,

-- 
Nicolas Goaziou

Re: Fwd: [PATCH] Add support for ordered list to ox-confluence.el

[Charles Durst]

They do conflict.  My version is slightly more complicated since it
also supports nested mixed lists.

For example:

1. Here
   * is
   * an
2. example
   * of
   * a
3. mixed
4. list

Which translates to:

# Here
#- is
#- an
# example
#- of
#- a
# mixed
# list

Which is effectively the same as the example in the Confluence documentation:
https://confluence.atlassian.com/confcloud/confluence-wiki-markup-724765099.html#ConfluenceWikiMarkup-Mixedlists
--
Charles Durst
cdurst@alum.rpi.edu


On Thu, Dec 8, 2016 at 5:49 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Hello,
>
> Lungang Fang <lungang.fang@gmail.com> writes:
>
>> Attached is a patch for contrib/lisp/ox-confluence.el generated following
>> instructions on http://orgmode.org/worg/org-contribute.html#patches . It
>> adds support for ordered list.
>
> Thank you.
>
> However, this somewhat conflicts with a patch recently sent on the ML,
> but not yet applied, by Charles Durst (Cc'ed).
>
> Could one double-check if one doesn't supersede the other, or if they
> could be merged (although I suspect the former) and report back so
> I know what patch to apply?
>
> Regards,
>
> --
> Nicolas Goaziou

Re: Fwd: [PATCH] Add support for ordered list to ox-confluence.el

[Charles Durst]

They do conflict.  My version is slightly more complicated since it
also supports nested mixed lists.

For example:

1. Here
   * is
   * an
2. example
   * of
   * a
3. mixed
4. list

Which translates to:

# Here
#- is
#- an
# example
#- of
#- a
# mixed
# list

Which is effectively the same as the example in the Confluence documentation:
https://confluence.atlassian.com/confcloud/confluence-wiki-markup-724765099.html#ConfluenceWikiMarkup-Mixedlists

--
Charles Durst
cwdurst+orgmode@gmail.com


On Thu, Dec 8, 2016 at 5:49 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Hello,
>
> Lungang Fang <lungang.fang@gmail.com> writes:
>
>> Attached is a patch for contrib/lisp/ox-confluence.el generated following
>> instructions on http://orgmode.org/worg/org-contribute.html#patches . It
>> adds support for ordered list.
>
> Thank you.
>
> However, this somewhat conflicts with a patch recently sent on the ML,
> but not yet applied, by Charles Durst (Cc'ed).
>
> Could one double-check if one doesn't supersede the other, or if they
> could be merged (although I suspect the former) and report back so
> I know what patch to apply?
>
> Regards,
>
> --
> Nicolas Goaziou

Re: Fwd: [PATCH] Add support for ordered list to ox-confluence.el

[Lungang Fang]

[-- Attachment #1: Type: text/plain, Size: 1976 bytes --]

Hi Charles and Nicholas,

My code also supports nested mixed lists but is simpler. I mean, my code
will convert the list given by Charles to

# Here
-- is
-- an
# example
-- of
-- a
# mixed
# list

Although this format is not mentioned in confluence wiki, it is supported
by conflucence according to my test (in Jira).

So, in my opinion, it is a matter of personal preference: more complicated
code complies with documented interface, or simpler code that exploits
undocumented feature.

I prefer my code. But you guys feel free to make decision. I am OK with
whatever you choose.

Cheers,
Lungang

On Fri, Dec 9, 2016 at 10:37 AM, Charles Durst <cwdurst+orgmode@gmail.com>
wrote:

> They do conflict.  My version is slightly more complicated since it
> also supports nested mixed lists.
>
> For example:
>
> 1. Here
>    * is
>    * an
> 2. example
>    * of
>    * a
> 3. mixed
> 4. list
>
> Which translates to:
>
> # Here
> #- is
> #- an
> # example
> #- of
> #- a
> # mixed
> # list
>
> Which is effectively the same as the example in the Confluence
> documentation:
> https://confluence.atlassian.com/confcloud/confluence-wiki-
> markup-724765099.html#ConfluenceWikiMarkup-Mixedlists
>
> --
> Charles Durst
> cwdurst+orgmode@gmail.com
>
>
> On Thu, Dec 8, 2016 at 5:49 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr>
> wrote:
> > Hello,
> >
> > Lungang Fang <lungang.fang@gmail.com> writes:
> >
> >> Attached is a patch for contrib/lisp/ox-confluence.el generated
> following
> >> instructions on http://orgmode.org/worg/org-contribute.html#patches .
> It
> >> adds support for ordered list.
> >
> > Thank you.
> >
> > However, this somewhat conflicts with a patch recently sent on the ML,
> > but not yet applied, by Charles Durst (Cc'ed).
> >
> > Could one double-check if one doesn't supersede the other, or if they
> > could be merged (although I suspect the former) and report back so
> > I know what patch to apply?
> >
> > Regards,
> >
> > --
> > Nicolas Goaziou
>

[-- Attachment #2: Type: text/html, Size: 3552 bytes --]

Re: Fwd: [PATCH] Add support for ordered list to ox-confluence.el

[Charles Durst]

I have tried the results of both versions and loaded them into the
Confluence Wiki, and Lungang is correct, from what I can tell, they
both will work.

So I don't really care which one you choose either.  I just needed the
functionality.
--
Charles Durst
cwdurst+orgmode@gmail.com

On Thu, Dec 8, 2016 at 9:32 PM, Lungang Fang <lungang.fang@gmail.com> wrote:
> Hi Charles and Nicholas,
>
> My code also supports nested mixed lists but is simpler. I mean, my code
> will convert the list given by Charles to
>
> # Here
> -- is
> -- an
> # example
> -- of
> -- a
> # mixed
> # list
>
> Although this format is not mentioned in confluence wiki, it is supported by
> conflucence according to my test (in Jira).
>
> So, in my opinion, it is a matter of personal preference: more complicated
> code complies with documented interface, or simpler code that exploits
> undocumented feature.
>
> I prefer my code. But you guys feel free to make decision. I am OK with
> whatever you choose.
>
> Cheers,
> Lungang
>
> On Fri, Dec 9, 2016 at 10:37 AM, Charles Durst <cwdurst+orgmode@gmail.com>
> wrote:
>>
>> They do conflict.  My version is slightly more complicated since it
>> also supports nested mixed lists.
>>
>> For example:
>>
>> 1. Here
>>    * is
>>    * an
>> 2. example
>>    * of
>>    * a
>> 3. mixed
>> 4. list
>>
>> Which translates to:
>>
>> # Here
>> #- is
>> #- an
>> # example
>> #- of
>> #- a
>> # mixed
>> # list
>>
>> Which is effectively the same as the example in the Confluence
>> documentation:
>>
>> https://confluence.atlassian.com/confcloud/confluence-wiki-markup-724765099.html#ConfluenceWikiMarkup-Mixedlists
>>
>> --
>> Charles Durst
>> cwdurst+orgmode@gmail.com
>>
>>
>> On Thu, Dec 8, 2016 at 5:49 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr>
>> wrote:
>> > Hello,
>> >
>> > Lungang Fang <lungang.fang@gmail.com> writes:
>> >
>> >> Attached is a patch for contrib/lisp/ox-confluence.el generated
>> >> following
>> >> instructions on http://orgmode.org/worg/org-contribute.html#patches .
>> >> It
>> >> adds support for ordered list.
>> >
>> > Thank you.
>> >
>> > However, this somewhat conflicts with a patch recently sent on the ML,
>> > but not yet applied, by Charles Durst (Cc'ed).
>> >
>> > Could one double-check if one doesn't supersede the other, or if they
>> > could be merged (although I suspect the former) and report back so
>> > I know what patch to apply?
>> >
>> > Regards,
>> >
>> > --
>> > Nicolas Goaziou
>
>

Re: [PATCH] Add support for ordered list to ox-confluence.el

[Lungang Fang]

[-- Attachment #1: Type: text/plain, Size: 2972 bytes --]

Great! Then, what about using my patch ? It would be my first patch adopted
by any open source project, a real milestone  :)

On Friday, December 9, 2016, Charles Durst <cwdurst+orgmode@gmail.com>
wrote:

> I have tried the results of both versions and loaded them into the
> Confluence Wiki, and Lungang is correct, from what I can tell, they
> both will work.
>
> So I don't really care which one you choose either.  I just needed the
> functionality.
> --
> Charles Durst
> cwdurst+orgmode@gmail.com <javascript:;>
>
> On Thu, Dec 8, 2016 at 9:32 PM, Lungang Fang <lungang.fang@gmail.com
> <javascript:;>> wrote:
> > Hi Charles and Nicholas,
> >
> > My code also supports nested mixed lists but is simpler. I mean, my code
> > will convert the list given by Charles to
> >
> > # Here
> > -- is
> > -- an
> > # example
> > -- of
> > -- a
> > # mixed
> > # list
> >
> > Although this format is not mentioned in confluence wiki, it is
> supported by
> > conflucence according to my test (in Jira).
> >
> > So, in my opinion, it is a matter of personal preference: more
> complicated
> > code complies with documented interface, or simpler code that exploits
> > undocumented feature.
> >
> > I prefer my code. But you guys feel free to make decision. I am OK with
> > whatever you choose.
> >
> > Cheers,
> > Lungang
> >
> > On Fri, Dec 9, 2016 at 10:37 AM, Charles Durst <
> cwdurst+orgmode@gmail.com <javascript:;>>
> > wrote:
> >>
> >> They do conflict.  My version is slightly more complicated since it
> >> also supports nested mixed lists.
> >>
> >> For example:
> >>
> >> 1. Here
> >>    * is
> >>    * an
> >> 2. example
> >>    * of
> >>    * a
> >> 3. mixed
> >> 4. list
> >>
> >> Which translates to:
> >>
> >> # Here
> >> #- is
> >> #- an
> >> # example
> >> #- of
> >> #- a
> >> # mixed
> >> # list
> >>
> >> Which is effectively the same as the example in the Confluence
> >> documentation:
> >>
> >> https://confluence.atlassian.com/confcloud/confluence-wiki-
> markup-724765099.html#ConfluenceWikiMarkup-Mixedlists
> >>
> >> --
> >> Charles Durst
> >> cwdurst+orgmode@gmail.com <javascript:;>
> >>
> >>
> >> On Thu, Dec 8, 2016 at 5:49 PM, Nicolas Goaziou <mail@nicolasgoaziou.fr
> <javascript:;>>
> >> wrote:
> >> > Hello,
> >> >
> >> > Lungang Fang <lungang.fang@gmail.com <javascript:;>> writes:
> >> >
> >> >> Attached is a patch for contrib/lisp/ox-confluence.el generated
> >> >> following
> >> >> instructions on http://orgmode.org/worg/org-contribute.html#patches
> .
> >> >> It
> >> >> adds support for ordered list.
> >> >
> >> > Thank you.
> >> >
> >> > However, this somewhat conflicts with a patch recently sent on the ML,
> >> > but not yet applied, by Charles Durst (Cc'ed).
> >> >
> >> > Could one double-check if one doesn't supersede the other, or if they
> >> > could be merged (although I suspect the former) and report back so
> >> > I know what patch to apply?
> >> >
> >> > Regards,
> >> >
> >> > --
> >> > Nicolas Goaziou
> >
> >
>

[-- Attachment #2: Type: text/html, Size: 4787 bytes --]

Re: [PATCH] Add support for ordered list to ox-confluence.el

[Nicolas Goaziou]

Hello,

Lungang Fang <lungang.fang@gmail.com> writes:

> Great! Then, what about using my patch ? It would be my first patch adopted
> by any open source project, a real milestone  :)

Applied. Thanks to both of you.

Regards,

-- 
Nicolas Goaziou

Re: [PATCH] Add support for ordered list to ox-confluence.el

[Lungang Fang]

[-- Attachment #1: Type: text/plain, Size: 405 bytes --]

Hi Nicolas and Charles,

Thank you both.

Lungang

On Sat, Dec 10, 2016 at 7:34 AM, Nicolas Goaziou <mail@nicolasgoaziou.fr>
wrote:

> Hello,
>
> Lungang Fang <lungang.fang@gmail.com> writes:
>
> > Great! Then, what about using my patch ? It would be my first patch
> adopted
> > by any open source project, a real milestone  :)
>
> Applied. Thanks to both of you.
>
> Regards,
>
> --
> Nicolas Goaziou
>

[-- Attachment #2: Type: text/html, Size: 948 bytes --]

Re: [PATCH] Add support for ordered list to ox-confluence.el

[Charles Durst]

Oops, I just realized an important difference.  My version also
supported descriptive lists.  The version with only Nicholas' changes
will lose the item name:

* item-name :: description

Will just become

- description

Here is a fix based on Nicholas' version:


* contrib/lisp/ox-confluence.el (org-confluence-item): Support
  descriptive list

When converting a descriptive list item, be sure to include the "item"
part, not just the description.

TINYCHANGE
---
 contrib/lisp/ox-confluence.el | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/contrib/lisp/ox-confluence.el b/contrib/lisp/ox-confluence.el
index de8b00e..a1318f9 100644
--- a/contrib/lisp/ox-confluence.el
+++ b/contrib/lisp/ox-confluence.el
@@ -83,9 +83,13 @@
 (defun org-confluence-item (item contents info)
   (let* ((plain-list (org-export-get-parent item))
          (type (org-element-property :type plain-list))
-         (bullet (if (eq type `ordered) ?\# ?\-)))
+         (bullet (if (eq type 'ordered) ?\# ?\-)))
     (concat (make-string (1+ (org-confluence--li-depth item)) bullet)
             " "
+    (if (eq type 'descriptive)
+ (concat "*"
+ (org-export-data (org-element-property :tag item) info)
+ "* - "))
             (org-trim contents))))

 (defun org-confluence-fixed-width (fixed-width contents info)
-- 
2.5.4 (Apple Git-61)


On Sat, Dec 10, 2016 at 2:54 AM, Lungang Fang <lungang.fang@gmail.com> wrote:
> Hi Nicolas and Charles,
>
> Thank you both.
>
> Lungang
>
> On Sat, Dec 10, 2016 at 7:34 AM, Nicolas Goaziou <mail@nicolasgoaziou.fr>
> wrote:
>>
>> Hello,
>>
>> Lungang Fang <lungang.fang@gmail.com> writes:
>>
>> > Great! Then, what about using my patch ? It would be my first patch
>> > adopted
>> > by any open source project, a real milestone  :)
>>
>> Applied. Thanks to both of you.
>>
>> Regards,
>>
>> --
>> Nicolas Goaziou
>
>

Re: [PATCH] Add support for ordered list to ox-confluence.el

[Nicolas Goaziou]

Hello,

Charles Durst <cwdurst+orgmode@gmail.com> writes:

> Oops, I just realized an important difference.  My version also
> supported descriptive lists.  The version with only Nicholas' changes
> will lose the item name:
>
> * item-name :: description
>
> Will just become
>
> - description
>
> Here is a fix based on Nicholas' version

Applied. Thank you.

Regards,

-- 
Nicolas Goaziou