Export Org checkboxes in ox-html using UTF-8 symbols

Export Org checkboxes in ox-html using UTF-8 symbols

[Grant Rettke]

Hi,

Sacha Chua made a nice hack to export checkboxes as unicode symbols to
HTML here:

http://sachachua.com/blog/2014/03/emacs-tweaks-export-org-checkboxes-using-utf-8-symbols/?shareadraft=baba27119_533313c944f64

(defun sacha/org-html-checkbox (checkbox)
  "Format CHECKBOX into HTML."
  (case checkbox (on "<span class=\"check\">&#x2611;</span>") ;
checkbox (checked)
        (off "<span class=\"checkbox\">&#x2610;</span>")
        (trans "<code>[-]</code>")
        (t "")))
(defadvice org-html-checkbox (around sacha activate)
  (setq ad-return-value (sacha/org-html-checkbox (ad-get-arg 0))))

Thanks Sacha.

Regards,

Grant Rettke | AAAS, ACM, AMA, COG, IEEE, Sigma Xi
grettke@acm.org | http://www.wisdomandwonder.com/
“Wisdom begins in wonder.” --Socrates
((λ (x) (x x)) (λ (x) (x x)))
“Life has become immeasurably better since I have been forced to stop
taking it seriously.” --Thompson

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Nicolas Goaziou]

Hello,

Grant Rettke <gcr@wisdomandwonder.com> writes:

> Sacha Chua made a nice hack to export checkboxes as unicode symbols to
> HTML here:
>
> http://sachachua.com/blog/2014/03/emacs-tweaks-export-org-checkboxes-using-utf-8-symbols/?shareadraft=baba27119_533313c944f64
>
> (defun sacha/org-html-checkbox (checkbox)
>   "Format CHECKBOX into HTML."
>   (case checkbox (on "<span class=\"check\">&#x2611;</span>") ;
> checkbox (checked)
>         (off "<span class=\"checkbox\">&#x2610;</span>")
>         (trans "<code>[-]</code>")
>         (t "")))
> (defadvice org-html-checkbox (around sacha activate)
>   (setq ad-return-value (sacha/org-html-checkbox (ad-get-arg 0))))
>
> Thanks Sacha.

There is also:

  (setq org-html-checkbox-type 'unicode)


You need a recent Org, though (maybe development version, I didn't check).


Regards,

-- 
Nicolas Goaziou

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Rick Frankel]

On 2014-03-27 04:43, Nicolas Goaziou wrote:
> Hello,
> 
> Grant Rettke <gcr@wisdomandwonder.com> writes:
> 
> Sacha Chua made a nice hack to export checkboxes as unicode symbols to
> HTML here:
> 
> http://sachachua.com/blog/2014/03/emacs-tweaks-export-org-checkboxes-using-utf-8-symbols/?shareadraft=baba27119_533313c944f64
> 
> (defun sacha/org-html-checkbox (checkbox)
> "Format CHECKBOX into HTML."
> (case checkbox (on "<span class=\"check\">&#x2611;</span>") ;
> checkbox (checked)
> (off "<span class=\"checkbox\">&#x2610;</span>")
> (trans "<code>[-]</code>")
> (t "")))
> (defadvice org-html-checkbox (around sacha activate)
> (setq ad-return-value (sacha/org-html-checkbox (ad-get-arg 0))))
> 
> Thanks Sacha.
> 
> There is also:
> 
> (setq org-html-checkbox-type 'unicode)
> 
> 
> You need a recent Org, though (maybe development version, I didn't 
> check).

I didn't apply it in maint, so it's only in master.

BTW, i used "[&nbsp;]" for the unchecked box (we use the same for 
checked and trans)... I think i'll change the unchecked box to &#x2610; 
to match the checked box (same as sachua).

rick

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Sebastien Vauban]

Rick Frankel wrote:
> BTW, i used "[ ]" for the unchecked box (we use the same for
> checked and trans)... I think i'll change the unchecked box to
> ☐ to match the checked box (same as sachua).

Isn't it error-prone and very misleading to have 3 different states in
the Org files, and just 2 different in the HTML exports?

Best regards,
  Seb

-- 
Sebastien Vauban

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Rick Frankel]

On 2014-03-28 10:01, Sebastien Vauban wrote:
> Rick Frankel wrote:
> BTW, i used "[ ]" for the unchecked box (we use the same for
> checked and trans)... I think i'll change the unchecked box to
> ☐ to match the checked box (same as sachua).
> 
> Isn't it error-prone and very misleading to have 3 different states in
> the Org files, and just 2 different in the HTML exports?

There *are* three different states in the exported file -- the
"transient" mode is for partially completed rollups:

#+BEGIN_SRC org
,* rollup
- [-] All done
- [X] one
- [ ] two
#+END_SRC

Generates (abbreviated and indented):

#+BEGIN_SRC html
<ul class="org-ul">
<li><code>[-]</code> All done
<ul class="org-ul">
<li><code>[X]</code> one
</li>
<li><code>[&#xa0;]</code> two
</li>
</ul>
</li>
</ul>
#+END_SRC

rick

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Sebastien Vauban]

Rick Frankel wrote:
>> Isn't it error-prone and very misleading to have 3 different states in
>> the Org files, and just 2 different in the HTML exports?
>
> There *are* three different states in the exported file -- the
> "transient" mode is for partially completed rollups:

OK, excellent!  Sorry for my misunderstanding.

Best regards,
  Seb

-- 
Sebastien Vauban

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Marcin Borkowski]

Dnia 2014-03-28, o godz. 10:59:43
Rick Frankel <rick@rickster.com> napisał(a):

> On 2014-03-28 10:01, Sebastien Vauban wrote:
> > Rick Frankel wrote:
> > BTW, i used "[&nbsp;]" for the unchecked box (we use the same for
> > checked and trans)... I think i'll change the unchecked box to
> > &#x2610; to match the checked box (same as sachua).
> > 
> > Isn't it error-prone and very misleading to have 3 different states
> > in the Org files, and just 2 different in the HTML exports?
> 
> There *are* three different states in the exported file -- the
> "transient" mode is for partially completed rollups:
> 
> #+BEGIN_SRC org
> ,* rollup
> - [-] All done
> - [X] one
> - [ ] two
> #+END_SRC
> 
> Generates (abbreviated and indented):
> 
> #+BEGIN_SRC html
> <ul class="org-ul">
> <li><code>[-]</code> All done
> <ul class="org-ul">
> <li><code>[X]</code> one
> </li>
> <li><code>[&#xa0;]</code> two
> </li>
> </ul>
> </li>
> </ul>
> #+END_SRC

Wouldn't it be better to have (maybe in addition) three distinct
classes for the <li> elements with checkboxes in various states?  This
would make styling them with CSS possible.

> rick

Best,

-- 
Marcin Borkowski
http://octd.wmi.amu.edu.pl/en/Marcin_Borkowski
Adam Mickiewicz University

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Rick Frankel]

On 2014-03-29 10:12, Marcin Borkowski wrote:
> Dnia 2014-03-28, o godz. 10:59:43
> Rick Frankel <rick@rickster.com> napisał(a):
> 
> On 2014-03-28 10:01, Sebastien Vauban wrote:
> > Rick Frankel wrote:
> > BTW, i used "[&nbsp;]" for the unchecked box (we use the same for
> > checked and trans)... I think i'll change the unchecked box to
> > &#x2610; to match the checked box (same as sachua).
> >
> Wouldn't it be better to have (maybe in addition) three distinct
> classes for the <li> elements with checkboxes in various states?  This
> would make styling them with CSS possible.

Nice idea. I'll look at adding classes to each (checked, or transient)
=li=. I think that the use of classes is minimal due to the orginal
stand-alone (inline css) nature of the html exporter. I certainly
agree that more modern html output is desireable, but it's a big
project...

rick

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Rick Frankel]

On Sat, Mar 29, 2014 at 03:12:14PM +0100, Marcin Borkowski wrote:
> Dnia 2014-03-28, o godz. 10:59:43
> Rick Frankel <rick@rickster.com> napisał(a):
> 
> > On 2014-03-28 10:01, Sebastien Vauban wrote:
> > > Rick Frankel wrote:
> > > BTW, i used "[&nbsp;]" for the unchecked box (we use the same for
> > > checked and trans)... I think i'll change the unchecked box to
> > > &#x2610; to match the checked box (same as sachua).
> > > 
> > > Isn't it error-prone and very misleading to have 3 different states
> > > in the Org files, and just 2 different in the HTML exports?
> > 
> Wouldn't it be better to have (maybe in addition) three distinct
> classes for the <li> elements with checkboxes in various states?  This
> would make styling them with CSS possible.

The =<li>= elements for checklists now have the class `on', `off' or
`trans' depending on the state of the checkbox.

Thanx for the suggestion.

rick

Re: Export Org checkboxes in ox-html using UTF-8 symbols

[Nicolas Goaziou]

Hello,

Rick Frankel <rick@rickster.com> writes:

> The =<li>= elements for checklists now have the class `on', `off' or
> `trans' depending on the state of the checkbox.

It seems that this patch broke the test suite. Would you mind looking
into it?


Regards,

-- 
Nicolas Goaziou