[O] Need info about code block header arguments in (HTML) export

2014-08-11 Thread Avdi Grimm
Hi there, Org experts!

I write books in org-mode, and one of the features I've really started to
need is to be able to automatically include filename information when
exporting source code listings. That is, given some Org source like this:

#+BEGIN_SRC ruby :tangle foo/bar.rb
  puts hello, world
#+END_SRC

...the final HTML might look something like this:

div class=org-src-container
div class=src-pathfoo/bar.rb/div

pre class=src src-rubyputs span class=org-stringHello,
world/span
/pre
/div

However, I already do a lot of post-processing on the exported HTML, so I'm
thinking that a simpler, more general solution would be sufficient:

div class=org-src-container data-org-header-args=ruby :tangle
foo/bar.rb

pre class=src src-rubyputs span class=org-stringHello,
world/span
/pre
/div

As you can see, in this version the header arguments are inserted,
unchanged, into a new data-org-header-args attribute. This would give me
enough information to munge the final HTML into the form I need.

So my question is: can anyone give me pointers on how to accomplish this?
Thanks!
-- 
Avdi Grimm
http://avdi.org


[O] HTML Export inserting weird characters

2013-01-01 Thread Avdi Grimm
HTML export hasn't been working right for me for a while.

Given a minimal org-mode file with some Ruby code in it, the code section
in the exported HTML has a bunch of garbage characters added to each line,
like '#57344;#57345;#57345;'.

I've posted source and generated HTML here: https://gist.github.com/4432744

M-x emacs-version: GNU Emacs 24.2.1 (x86_64-pc-linux-gnu, GTK+ Version
2.24.13) of 2012-11-06 on lakoocha, modified by Debian

M-x org-version: Org-mode version 7.9.2 (release_7.9.2-909-gb5f93f @
/home/avdi/.emacs24.d/el-get/org-mode/lisp/)

Cheers,

-- 
Avdi Grimm
http://avdi.org

I only check email twice a day. to reach me sooner, go to
http://awayfind.com/avdi


[O] Setting tangle defaults for a file?

2012-10-08 Thread Avdi Grimm
When I try to set tangling defaults for an org file, like so:

#+BABEL: :tangle yes :comments org

...it has no effect. Any particular reason for this?


Re: [O] Beamer onlyenv

2012-09-07 Thread Avdi Grimm
On Tue, Sep 4, 2012 at 3:35 AM, Nicolas Goaziou n.goaz...@gmail.com wrote:

 Using new back-end (and probably the old one, /mutatis mutandis/), you
 can use something like:

   (add-to-list 'org-e-beamer-environments-extra
'(onlyenv O \\begin{onlyenv}%a \\end{onlyenv}))

 You can then add an headline above your information and set its
 properties BEAMER_env and BEAMER_act to, respectively, onlyenv and
 2-. You can set easily the first one with C-c C-b when
 `org-e-beamer-mode' is active.


That's awesome, I will try this.



 I am thinking about providing this feature with ignoreheading
 environments. I.e.,


Sounds interesting but I'm not totally clear on what ignoreheading
environments are for.

Thanks!


[O] Beamer onlyenv

2012-08-26 Thread Avdi Grimm
I have a lot of slides where I want to incrementally show arbitrary
information or code that is *not* part of a bullet list. I've been doing it
like this:

#+BEAMER: \begin{onlyenv}2-
...some content...
#+BEAMER: \end{onlyenv}

I haven't been able to find any comprehensive org-beamer docs, and I've
been wondering: is there a nicer way to do this using org's beamer support?

I know about the shorthand syntax for bullet lists:

** 1- Point 1
** 2- Point 2
** 3- etc...

But again, this is for content outside of lists.

Thanks,

--
Avdi


Re: [O] Org mode export to Groff MM. Feature Freeze

2012-07-16 Thread Avdi Grimm
Does this mean that creating manpages from org source is now a possibility?

On Mon, Jul 16, 2012 at 12:38 PM, Luis Anaya papoan...@hotmail.com wrote:

 Hi:

 I wanted to let you know that the development for the org-export
 exporter to groff is in feature freeze. Everything that I thought up
 that was useful has been coded. There might be other useful things to
 do, but right now... my brain is mush.

 Efforts will be spent on clean-up, stability and documentation.

 Recent items added have been :
   * Fixed issue with planner output.
   * Added optios for hyphenation and right justification control.
   * Bug fixes

 Regards

 --
 Luis R. Anaya
 papo anaya aroba hot mail punto com
 Do not use 100 words if you can say it in 10 - Yamamoto Tsunetomo




Re: [O] New Link Syntax: Adding ATTRIBUTES (Was: org-e-html: Including ATTR_HTML)

2012-06-15 Thread Avdi Grimm
On Thu, Jun 14, 2012 at 8:53 PM, William Crandall bc3141...@gmail.comwrote:

 ATTRIBUTES would consisting of name:value pairs, perhaps
 giving names export-type prefixes, such as HTML_STYLE and
 HTML_TITLE, or LATEX_PDFBORDER and LATEX_URLCOLOR.

 HTML ATTRIBUTES would map to HTML 'attributes':

 http://www.w3.org/TR/html5/section-index.html#attributes-1

 LATEX ATTRIBUTES would map to Latex \hypersetup 'options':

 http://en.wikibooks.org/wiki/LaTeX/Hyperlinks#.5Chyperref
 (Subsection: Customization)


 --

 This would be a significant change, but it would make LINKS
 first class objects, and allow Org mode users to directly
 apply rich families of link attributes/options.


I really like this idea!

--
Avdi


Re: [O] [dev] About a beamer back-end

2012-06-15 Thread Avdi Grimm
On Fri, Jun 15, 2012 at 12:41 PM, suvayu ali fatkasuvayu+li...@gmail.com
 wrote:

 With this syntax it would be very easy to write both really long (40-50
 frames) as well as quick and short presentations.


I've only been using Org and Beamer for a little while, but if I understand
it correctly this sounds preferable.

I haven't memorized my Beamer syntax yet, but something basic that I do a
lot and I've found to be awkward in Org-Beamer is having a series of slides
where the main title stays the same but with different content for each.
I'd like to be able to write that as a section and a series of subsections.

Then again, perhaps this is already possible and I just don't know how.

--
Avdi


Re: [O] Embed images in formats best suited for HTML and LaTeX export and inline viewing

2012-06-06 Thread Avdi Grimm
I'm interested in this as well. At present I plan on handling it externally
to org-mode with some preprocessing before final org-export; but it would
be cool to have it be a built-in feature. Obviously it can be accomplished
manually with #+LaTeX: and #+HTML: sections, but some syntax sugar for it
would be great.

On Wed, May 30, 2012 at 9:26 AM, Brett Viren b...@bnl.gov wrote:

 Hi,

 How can I tell org-mode to use different file formats for an image for
 different purposes?

 What I really want is a scalable format to embed line art type images
 (plots) into org-mode documents so that they can display inline and in
 both HTML and LaTeX exports.  SVG seems good for the first two but LaTeX
 doesn't accept it.  Likewise, LaTeX wants PDF but inline and HTML export
 do not.

 Anyway to eat my cake?

 Thanks,
 -Brett.



Re: [O] Feature request for noweb mode that strips references on export

2012-03-15 Thread Avdi Grimm
On Wed, Feb 1, 2012 at 10:21 AM, Eric Schulte eric.schu...@gmx.com wrote:
 I've just added tested and documented such a strip-export argument to
 :noweb.  Please let me know if it doesn't work as you expected.

I just wanted to let you know I finally tried this out and it works
beautifully. Thank you!

-- 
Avdi Grimm
http://avdi.org



[O] Export to multiple HTML files?

2012-02-27 Thread Avdi Grimm
Is there a way to export a single Org file to a bunch of HTML files,
one for each heading of a given level? E.g. the way the Org manual is
presented at http://orgmode.org/manual ? (yes, I realize that's Info
not org-mode)I thought I remembered that being possible, but now I
can't find it.

Thanks!

-- 
Avdi Grimm
http://avdi.org



Re: [O] Feature request for noweb mode that strips references on export

2012-01-31 Thread Avdi Grimm
On Tue, Jan 31, 2012 at 2:56 AM, Sebastien Vauban
wxhgmqzgw...@spammotel.com wrote:
 Just for the sake of completeness, there is already a fourth option:

Ah! Looks like I had an older version. Thanks for prompting me to update!

I guess what I'm looking for would be called :noweb export-strip or
something like that.

-- 
Avdi Grimm
http://avdi.org



Re: [O] Feature request for noweb mode that strips references on export

2012-01-31 Thread Avdi Grimm
P.S. It's been a while since I've been on this ML, so if there's a
right way to do a feature request please let me know and I'll do it
:-)

On Tue, Jan 31, 2012 at 12:38 PM, Avdi Grimm gro...@inbox.avdi.org wrote:
 On Tue, Jan 31, 2012 at 2:56 AM, Sebastien Vauban
 wxhgmqzgw...@spammotel.com wrote:
 Just for the sake of completeness, there is already a fourth option:

 Ah! Looks like I had an older version. Thanks for prompting me to update!

 I guess what I'm looking for would be called :noweb export-strip or
 something like that.

 --
 Avdi Grimm
 http://avdi.org



-- 
Avdi Grimm
http://avdi.org



[O] Feature request for noweb mode that strips references on export

2012-01-30 Thread Avdi Grimm
Presently there are three noweb modes: yes, no, and tangle. I would
like a fourth, which would behave as follows:

On tangle: normal noweb expansion is performed.
On evaluation: normal noweb expansion is performed.
On export: noweb references are STRIPPED. Not just ignored, but the
lines containing the references are removed before export.

The use case is this: I find myself writing articles where I have a
series of code examples like this:

#+begin_src ruby
  boilerplate
  2 + 2 # =
#+end_src

The boilerplate is required to make the sample work, but I don't want
to have the boilerplate code show up in the finished article, because
it would be repeated for every example. I also don't want the noweb
reference to show up in the finished article, because it will confuse
readers and syntax highlighters.

Is this possible now, and/or a feature that could be easily added?

Thanks,

-- 
Avdi Grimm
http://avdi.org



[O] Conditional Inclusion

2011-07-04 Thread Avdi Grimm
I'm trying to produce two slightly different PDF versions from the
same document.

I want to be able to conditionally include a few LaTeX_HEADER lines
when I publish an Org file. I need to do it in a way I can control
from the command line when I run the export in batch mode. So I need
to either enable the lines with some eval-ed lisp on the emacs command
line, or with an environment variable.

Thoughts on the best way to go about this?

-- 
Avdi Grimm
http://avdi.org



[O] Adding xmpfilter as a results type

2011-06-09 Thread Avdi Grimm
Something I've been thinking about lately...

If you have used Ruby you might be familiar with the 'xmpfilter'
command which comes in the 'rcodetools' package. It's a filter that
annotates a source file with the results of expressions, so:

1 + 1 # =

When run through xmpfilter would become:

1 + 1 # = 2

There's already an rcodetools.el which makes it pretty easy to run
xmpfilter over the current region, or a whole buffer of Ruby code. But
it would be sweet if this could become an alternate :results type for
Ruby source listings, so I could just hit C-c C-c and get the
xmpfilter version of the code.

Any thoughts on how to make this work?

-- 
Avdi Grimm
http://avdi.org



Re: [O] Literate Programming - Continue a Source Block?

2011-06-09 Thread Avdi Grimm
On Wed, Jun 8, 2011 at 5:20 PM, Neeum Zawan mailingli...@nawaz.org wrote:
 n this case, yes. In a real programming project, it could be a number
 of them. For example, I may have a code block dedicated to
 imports/includes which I want to be on the top of the file - and I may
 have to append to that when adding a new feature.

Ooh! Ooh! Me too!

I was just wanting this the other day. I wanted to be able to do:

#+srcname: requires
#+begin_src ruby
  require 'library_a'
#+end_src

 ...

#+srcname: requires
#+begin_src ruby
  require 'library_b'
#+end_src

And then tie it all together with:

#+begin_src ruby :tangle foo.rb
  requires
#+end

But no such luck. requires just picked up the most recent block
with that srcname, IIRC.

-- 
Avdi Grimm
http://avdi.org



Re: [O] HTML Syntax Highlighting Questions

2011-06-08 Thread Avdi Grimm
On Sun, May 29, 2011 at 8:50 PM, Avdi Grimm a...@avdi.org wrote:
 How do I control syntax highlighting in HTML export?  Specifically, how can I:

 A. Disable syntax highlighting entirely
 B. Switch from inline colors to semantic tagging that I can style with
 a stylesheet? I could swear that I've seen instructions about this
 somewhere in the past.

Aha! I revisited this question, and I found the relevant setting:
org-export-htmlize-output-type

From the docs:

   Output type to be used by htmlize when formatting code snippets.
   Choices are `css', to export the CSS selectors only, or `inline-css', to
   export the CSS attribute values inline in the HTML.  We use as default
   `inline-css', in order to make the resulting HTML self-containing.

   However, this will fail when using Emacs in batch mode for export, because
   then no rich font definitions are in place.  It will also not be good if
   people with different Emacs setup contribute HTML files to a website,
   because the fonts will represent the individual setups.  In these cases,
   it is much better to let Org/Htmlize assign classes only, and to use
   a style file to define the look of these classes.
   To get a start for your css file, start Emacs session and make sure that
   all the faces you are interested in are defined, for example by loading files
   in all modes you want.  Then, use the command
   M-x org-export-htmlize-generate-css to extract class definitions.

-- 
Avdi Grimm
http://avdi.org



[O] HTML Syntax Highlighting Questions

2011-05-29 Thread Avdi Grimm
I feel like this is a stupid question, but I'm having trouble finding
the info I need.

How do I control syntax highlighting in HTML export?  Specifically, how can I:

A. Disable syntax highlighting entirely
B. Switch from inline colors to semantic tagging that I can style with
a stylesheet? I could swear that I've seen instructions about this
somewhere in the past.

Bonus question: why would HTML syntax highlighting come out monochrome
(as seen here: http://avdi.org/devblog/wp-content/uploads/2011/05/html.png)
when the export is done in batch mode from the command line? And, more
importantly, how can I fix it to generate full-color highlighting in
batch mode?

Thanks,

-- 
Avdi Grimm
http://avdi.org



Re: [O] HTML Syntax Highlighting Questions

2011-05-29 Thread Avdi Grimm
On Sun, May 29, 2011 at 9:32 PM, Jambunathan K kjambunat...@gmail.com wrote:
 Let me guess - It is either htmlize not being in your load path during
 the batch run or font lock being not being explicity turned on during
 the batch run or font-locking simply not making sense during batch
 mode. Ultimately htmlize or for that matter htmlfontify seem to depend
 on the fontification done by the fontification engine.

Hm. Bonus question, then: source code highlighting via Pygments works
great with LaTeX export and the minted package. How hard would it be
to use Pygments instead of htmlize/htmlfontify for HTML-exported
syntax highlighting?

...and who do I need to buy beer for to make this happen, since I
don't have time to do it myself?

-- 
Avdi Grimm
http://avdi.org



[O] Epub and Mobi Export

2011-05-10 Thread Avdi Grimm
Well, I got my eBook finished and released. Thanks VERY much to
everyone who helped me with LaTeX export questions.

Now I have a lot of people asking me for Epub and Mobi formats. I
thought that before I launched into producing mobile formats from my
Org-Mode, I'd see if anyone else has any experience producing these
formats.

So: has anyone produced Epub or Mobi from Org-Mode source? Any
thoughts on the best way to do it?

Thanks,

-- 
Avdi Grimm
http://avdi.org



Re: [O] Dumbquotes in exported source listings

2011-05-01 Thread Avdi Grimm
On Sat, Apr 30, 2011 at 11:13 PM, Ben Finney  Those aren't even
“smart quotes” (the term usually applied to the quote
 characters from Microsoft's standards-violating character set). Those
 are what might be called “TeX quotes” (though the convention pre-dates
 even TeX), since TeX uses ‘`’ for an opening single quote and ‘``’ for
 an opening double quote.

I'll reiterate: this is in literal code-listing sections, not English
text sections. The listings in the plain org file ARE the correct
single-quote character. Something in the pipeline is cleverly
converting them to TeX-quotes, and I don't know what.

-- 
Avdi Grimm
http://avdi.org



[O] Dumbquotes in exported source listings

2011-04-30 Thread Avdi Grimm
So I'm writing an eBook with lots of source code listings, using
org-mode-LaTeX-PDF with the minted package providing source code
highlighting. For the most part I'm really, really happy with the
toolchain; thank you to those that pointed me in the direction of
minted.

One issue: my beta reviewers have noted that when copy-and-pasting
source code listings that contain single-quoted strings, they are
getting smart quotes--i.e. the first quote is a backquote, the
second quote is a single quote. This breaks the pasted code.

I'm sure I could track the problem down myself eventually, but I
thought someone here might know which part of the toolchain to look at
first for this quote-munging behavior.

Thanks!

--
Avdi Grimm
http://avdi.org



Re: [O] Missing Introduction and About sections in LaTeX export

2011-04-28 Thread Avdi Grimm
On Wed, Apr 27, 2011 at 5:41 PM, Nick Dokos nicholas.do...@hp.com wrote:
 Just star them by hand in the tex file after exporting for the last
 time: it'll take two seconds. You may be able to do it from Org by
 writing a custom function (C-h v org-export-latex-classes RET for
 details) but I suspect that the effort is just not worth it.


Ugh. This is a (somewhat) living document; manually tweaking the .tex
after export isn't really an option.

I was hoping there was a tag or property that I could set on a section
indicating it is frontmatter/backmatter.

-- 
Avdi Grimm
http://avdi.org



[O] org-export-latex-verbatim-wrap has no effect on Babel results

2011-04-28 Thread Avdi Grimm
I have customized my org-export-latex-verbatim-wrap to create a shaded
box for verbatim text. However, when I have Babel source code blocks
which export results, the results are always rendered with plain
\begin{verbatim}...\end{verbatim}.

I've been grepping through the code, but I can't figure out where
#+results: blocks are formatted into LaTeX.

Help?

-- 
Avdi Grimm
http://avdi.org



[O] Missing Introduction and About sections in LaTeX export

2011-04-27 Thread Avdi Grimm
I have an Org document I'm exporting to PDF through LaTeX using the
report class.

The two first top-level sections in the document, titled About and
Introduction, are completely missing from the generated .tex and
PDF. The exported files start on the third section.

Coincidentally(?) those are the front matter sections which I don't
want included in the contents. However, I have done nothing to mark
them as such. They have no classes or properties. As far as I can tell
there is nothing making them different from other sections.

Any ideas why they might be elided by the LaTeX exporter in Org 7.5?

Follow-up: assuming I can get them to export at all, how can I mark
*just* those two headings to be exported using the starred form so
that they are not included in the chapter numbering?

Thanks,

-- 
Avdi Grimm
http://avdi.org



Re: [O] Missing Introduction and About sections in LaTeX export

2011-04-27 Thread Avdi Grimm
Update: my initial problem with missing sections has gone away as
mysteriously as it came. Still looking for a way to use the starred
form for LaTeX export of certain headlines.

-- 
Avdi Grimm
http://avdi.org



[Orgmode] Git Changelogs

2011-02-17 Thread Avdi Grimm
Is there an easy way to have a version-controlled Org file suck in its
own changelog and present it as a list of entries?

-- 
Avdi Grimm
http://avdi.org

___
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


[Orgmode] Problems with source code listings in PDF

2011-02-08 Thread Avdi Grimm
I'm working on creating a PDF eBook with Org-Mode, and I'm running
into some difficulty getting them to come out looking decent.

I've followed the directions I found in the list archives for
outputting colorized source code listings. I set
org-export-latex-listings to t, and customized
org-export-latex-packages-alist according to the directions in the
org-export-latex-listings docs.

I'm seeing a few problems with the output:

1. There is no color; only bolded keywords.
2. Listings are formatted in a not-very-well-rendered font with serifs
that just doesn't look good at all.
3. In begin_example sections, spaces are replaced with odd little
curved underscores.

I've attached some examples to show what I mean.

I'm running Org-Mode 7.4 on Ubuntu 10.10 with Emacs 23.1.50.1.

Has anyone had any luck formatting source code and example listings in
PDF output? What I'd really like to get is output identical to the
listings exported to HTML.

Thanks!

--
Avdi Grimm
attachment: example.pngattachment: listing.png___
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


[Orgmode] Emailing my org file

2010-08-18 Thread Avdi Grimm
I really like the idea of having a single queue of random notes to
sort through. And I really want that singe queue to be the * Notes
section at the end of my plan.org file.

Here's the thing: sometimes I don't have my org file and my
handy-dandy remember.el macros handy. Like when I'm away from my PC.
This is when I usually wind up emailing myself. Or (more recently)
calling my Jott account which then emails me.

In a perfect world I could somehow send emails into my Org file
instead. My question: has anyone come up with a configuration where
they are able to import emails sent to a specific address into Org
bullets en masse?

Thanks,

-- 
Avdi

ShipRise LLC: http://shiprise.net
Wide Teams: http://wideteams.com
Developer Blog: http://avdi.org/devblog/
York Coworking: http://www.meetup.com/york-coworking/
Twitter: http://twitter.com/avdi
The Lazy Faire: http://thelazyfaire.org

___
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] Re: How you can help

2008-10-24 Thread Avdi Grimm
On Fri, Oct 24, 2008 at 12:27 PM, Manish [EMAIL PROTECTED] wrote:
 Let me take a step back and think aloud why we need a bug-tracking and
 testing system (if only to clarify my understanding) and who/when does
 it help.  Following scenarios come to mind (and how they can be
 handled best (again only my limited understanding)):

First of all, bug tracking are completely separate beasts, and should
be considered separately.  You can have either one without the other.

Second:  I don't care as much about bug tracking, except for the
following case: if there is a bug tracker and I'm feeling bored and
want to contribute a little, I'll check it for something that I think
I can fix.  If there is no such list, I won't do this, and I'll
contribute less.  I do *not* follow the mailing list closely enough to
pick up bugs from there except by sheer chance, and this is not going
to change.  I really don't care where or how the list is kept, so long
as there is a list.

Third, regarding testing.  I'm a coder, I know some ELisp, I *love*
org-mode, and I would like to contribute.  That said, I am completely
uninterested in doing manual QA for Org.  I am not going to go
clicking around just to look for broken behavior.  I have neither the
time nor the interest.  However, if there is an automated test suite I
can promise you that a) I will run it before submitting any change I
make; and b) I will add new tests to cover any functionality I add.

However, you should take all of this with a grain of salt because I
haven't submitted any code at all yet.

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] How you can help

2008-10-24 Thread Avdi Grimm
On Fri, Oct 24, 2008 at 2:33 PM, Ben Alexander [EMAIL PROTECTED] wrote:
 Ok, here's your chance.  This is something that has bothered me for quite
 some time, but I've never been able to reliably reproduce the problem.  And
 it's such a small issue.

Thanks!  I'll try to take a look tonight or this weekend.

 So the value of a testing framework is that this: if I'm going to announce
 to the world that I can't get something to work, (like the tab key), I'm
 going to make darn sure it's a real problem.  I'm going to spend the time to
 create a small sample file, that reliable creates the problem, and I'm going
 to try a few different scenarios.   But if I start to get lost or confused
 about which settings I've fiddled with or what is supposed to happen, I'll
 wander away from the problem and I won't submit the bug.  We all lose in
 that scenario.  But if the testing framework exists, and it is lightweight
 enough for novice emacs users (advanced enough to use M-x but not advanced
 enough to read lisp) then maybe I would have used it for this example.

For the record, I normally would never expect the user to submit
tests.  A description of the problem and some sample data is all I
expect.  Writing the a test to reproduce the behavior is the
programmer's responsibility as far as I'm concerned.

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] How you can help

2008-10-23 Thread Avdi Grimm
I've been considering buckling down and doing some more ELisp coding,
which would mean org-mode coding because I've become ridiculously
dependent on org-mode.  If I do, I would only do it in a test-first
way, because that's the only way I'll write code anymore; so it would
definitely be good to know that unit tests will be be accepted into
the codebase.  Personally, if I did this I think I would like to use
Emacs Lisp Expectations:

http://www.emacswiki.org/cgi-bin/emacs/EmacsLispExpectations

I'm a big fan of Jay Field's work, I like the way the original
Expectations for Ruby is structured, and I like the looks of the EL
Expectations API.  I'm open to other libraries though - so long as
SOME unit-testing standard it accepted.

--
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] How you can help

2008-10-23 Thread Avdi Grimm
A few points, from someone with a decent amount of testing background:

* As someone who has contributed to OS projects, the lack of a
pre-existing set of regression tests in org-mode is actually *the*
most significant blocker to my getting involved in org-mode
development.  I do all of my coding - both professional and personal -
in the context of tests, and not having the existing framework means
that before I can start working on new features I first need to spend
time yak-shaving on testing infrastructure.

*  I think there's a lot of over-thinking going on here.  Here's the
test-first coding discipline in a nutshell:
   1. Identify a problem/missing feature.
   2. Write a test (possibly using a unit-testing framework to help)
which will pass when the bug has been fixed or feature added. This can
be as simple as calling a function and validating its return value.
   3.  Run the test.  Verify it FAILS.
   4. Write code to make the test PASS.
   5. Refactor, if you introduced any code duplication in step 4.
   6. Run all the tests, to make sure you didn't break anything else.
   7. Commit.

If someone would be so kind as to identify a small bug or feature, I
would be happy to demonstrate this workflow in the form of code, time
permitting.

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] How you can help

2008-10-23 Thread Avdi Grimm
On Thu, Oct 23, 2008 at 1:33 PM, Sebastian Rose [EMAIL PROTECTED] wrote:
 Hm - how about:

 1. A not yet existent elisp file test-worg.el, that defines a function
 hello-worg, and a variable lang, and simply puts Hello Worginto the
 minibuffer (if (string= lang en)) and Hallo Worg (if (string= lang
 de)) ?

I'd prefer something that would be of concrete value to someone in
using org-mode - made-up scenarios tend to lead to unrealistic tests.

 Did you work with unit-testing frameworks for elisp already?
 Which one?

I have not.  I've done test-driven development in Java, C#, Ruby, and
C++(!) though, and if I can do it in C++ I think I can get up to speed
in any language pretty quickly ;-)

 Recommendations?

As I said in another comment, I'm liking the look of Emacs Lisp
Expectations a *lot*.  Partly because I think Jay Fields is bang on
the money for how maintain good habits in your tests, and partly
because it has a mocking framework to go with it.  Testing without a
mocking framework is less fun than testing with.  However, I haven't
actually used it yet, so I can't responsibly recommend it.  Let's just
say that the discovery of it recently was the thing that got me
excited about doing some serious ELisp development.

 Could say something about the effort to get started with such a
 framework?

I think if you have some *running* examples to crib from it shouldn't
take someone who is already ELisp-savvy more than a few hours to get
the hang of it.


 Can we add it without changing Org's code? If understand 2. correctly - yes?

In a dynamic language like ELisp, any testing framework that requires
you to change the code just to get it under test isn't worth using.
No, you should not have to change org-mode's code to get started with
tests.

That said, developing in concert with a test suite will definitely
tend to influence how you write the code.  Generally speaking,
developing with tests encourages smaller functions which do one thing
and one thing alone and don't have a lot of non-obvious inputs and
outputs.  Since this is usually the direction you *want* your code to
go in anyway, it's a virtuous cycle.

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] Regression testing for org-mode

2008-10-23 Thread Avdi Grimm
On Thu, Oct 23, 2008 at 7:57 PM, Eric Schulte [EMAIL PROTECTED] wrote:

 I'm pessimistic that the colossal amount of work involved in wrapping
 all of org-modes extensive and varied functionality into a test
 framework can/should actually be completed.  Would it be sufficient to
 simply begin dealing with bug reports in a test-first manner?

Absolutely.  I do NOT recommend making an effort to get test coverage
over existing code just for the sake of coverage - in my experience
this usually leads a lot of work for brittle and not terribly useful
tests.  Put tests only around the areas you are about to change.  Over
time the coverage will grow.

 Also, should we start tracking bug reports somewhere (worg), so that
 they can be claimed, tested against, and repaired?

Not a bad idea.  Normally I'd recommend just going with an established
bug tracker like Trac or Lighthouse, but since Org is so great for
managing tasks it seems only right that the developers should eat
their own dogfood by using Org to track tickets :-)

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


[Orgmode] Weekday repeaters, and filtering scheduled tasks.

2008-06-26 Thread Avdi Grimm
I couldn't find a list of repeaters.  Is there by any chance a weekday
repeater that will skip Sat-Sun?

Also, how would I set up an agenda view to show:

 - All UNSCHEDULED tasks with the NEXT keyword.
 - All scheduled tasks with the NEXT keyword which are DUE or OVERDUE
 - NO tasks which are scheduled for future dates.

Thanks!

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] Weekday repeaters, and filtering scheduled tasks.

2008-06-26 Thread Avdi Grimm
On Thu, Jun 26, 2008 at 10:55 PM, Manish [EMAIL PROTECTED] wrote:
 I do not understand this one.

I'm looking for the combination of *all* of those conditions in one
agenda view.  In other words, I want to see all the NEXT items which
are either unscheduled or due today; but I don't want to see any items
which are scheduled in the future.

-- 
Avdi

Home: http://avdi.org
Developer Blog: http://avdi.org/devblog/
Twitter: http://twitter.com/avdi
Journal: http://avdi.livejournal.com


___
Emacs-orgmode mailing list
Remember: use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode