emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Rainer M Krug <Rainer@krugs.de>
To: emacs-orgmode@gnu.org
Subject: Re: [RFC] Org linting library
Date: Sat, 23 May 2015 14:00:29 +0200	[thread overview]
Message-ID: <m2382ncxlu.fsf@krugs.de> (raw)
In-Reply-To: <877fs02zxc.fsf@nicolasgoaziou.fr> (Nicolas Goaziou's message of "Fri, 22 May 2015 21:08:15 +0200")

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

Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Rainer M Krug <Rainer@krugs.de> writes:
>
>> 1) not identifying header argument with +
>> ,----
>> | #+PROPERTY: header-args+ :tangle no
>> `----
>>
>> results in
>>
>> ,----
>> | 87 high  Unknown header argument ""
>> `----
>
> This should be fixed.

Thanks.

>
>> 2) not knowing header argument "file-ext" from R
>> ,----
>> | #+begin_src R  :exports results :file-ext pdf :results graphics :width 8 :height 8
>> | plotSensMainEffAll(files)
>> | #+end_src
>> `----
>>
>> results in
>>
>> ,----
>> |   1691 high  Unknown header argument "file-ext"
>> `----
>
> Fixed too.

Perfect - thanks.

>
>> 3) I am not to sure about this one, but in LaTeX labels of figures are
>> with the colon. Initially, I had #+LABEL: instead of #+NAME: but changed
>> it as one should use #+NAME instead of #+LABEL, but now I get the following:
>>
>> ,----
>> | #+CAPTION: The caption
>> | #+NAME: fig:sensDefault
>> | #+RESULTS: fig_sensDefault
>> | [[file:./output/fig_sensDefault.pdf]]
>> `----
>>
>> results in
>>
>> ,----
>> |   1686 high  Name "fig:sensDefault" contains a colon; Babel cannot use it as input
>> `----
>>
>> I agree with the fact that Babel can not use it as input, but I do not
>> want to use it as input, only as a label in LaTeX for the figure?
>
> Then you can ignore safely this report.

Concerning ignoring: it would be nice to dynamically exclude certain
types of messages - i.e. hiding them from the results of the
linting. I don't think this is possible at
the moment?

I have literally about 100 names with a colon - so these messages are
overshadowing the really important ones.

>
>> According to the manual this should work:
>>
>> http://orgmode.org/manual/Images-and-tables.html:
>>
>> ,----
>> |      #+CAPTION: This is the caption for the next figure link (or table)
>> |      #+NAME:   fig:SED-HR4049
>> |      [[./img/a.jpg]]
>> `----
>>
>> So maybe check if this is part of a construct with a CAPTION or if it
>> really is used as an input somewhere?
>
> It is quite complicated to check if it is an input somewhere, e.g., it
> could be used as an input in another document.

True - haven't considered that.

>
>> 4) references where :FILE is a normal PROPERTY: (or isn't it?)
>>
>> ,----
>> | ** Koivusalo2002 - Snow processes in a forest clearing and in a coniferous forest
>> | :PROPERTIES:
>> | :TITLE:    Snow processes in a forest clearing and in a coniferous forest
>> | :BTYPE:    article
>> | :CUSTOM_ID: Koivusalo2002
>> | :AUTHOR:   Koivusalo, H. and Kokkonen, T.
>> | :DOI:      10.1016/S0022-1694(02)00031-8
>> | :FILE:     file:./Literature/Koivusalo_2002.pdf
>> | :ISSN:     00221694
>> | :JOURNAL:  Journal of Hydrology
>> | :KEYWORDS: energy,forest,mathematical models,melt,snow,uxes
>> | :MENDELEY-GROUPS: Energy Balance,bibliography
>> | :MONTH:    may
>> | :NUMBER:   1-4
>> | :PAGES:    145--164
>> | :URL:      http://linkinghub.elsevier.com/retrieve/pii/S0022169402000318
>> | :VOLUME:   262
>> | :YEAR:     2002
>> | :END:
>> | [[file:Literature/Koivusalo2002.pdf]]
>> `----
>>
>> results in
>>
>> ,----
>> |  11221 high  Special property "FILE" found in a properties drawer
>> `----
>
> "FILE" is a special property, i.e., it shouldn't be set in a property
> drawer. See (info "(org) Special properties").

OK - I'll throw it put then.

>
>> I am really happy with org-lint - thanks a lot. This makes working with
>> org files much easier.
>
> Thanks for all the feedback.

Pleasure - I found several undetected problems in my org file by using
the linting library.

Another question: When duplicate names are detected, would it be
possible to specify both (or more) line numbers in the warning? THis
would make finding them much easier.

Cheers,

Rainer

>
>
> Regards,

-- 
Rainer M. Krug, PhD (Conservation Ecology, SUN), MSc (Conservation Biology, UCT), Dipl. Phys. (Germany)

Centre of Excellence for Invasion Biology
Stellenbosch University
South Africa

Tel :       +33 - (0)9 53 10 27 44
Cell:       +33 - (0)6 85 62 59 98
Fax :       +33 - (0)9 58 10 27 44

Fax (D):    +49 - (0)3 21 21 25 22 44

email:      Rainer@krugs.de

Skype:      RMkrug

PGP: 0x0F52F982

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 494 bytes --]

  reply	other threads:[~2015-05-23 12:00 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-19 13:31 [RFC] Org linting library Nicolas Goaziou
2015-04-19 14:23 ` Rasmus
2015-04-19 16:24   ` Nicolas Goaziou
2015-04-19 19:32 ` Marco Wahl
2015-04-20 10:42   ` Nicolas Goaziou
2015-04-20  2:15 ` Charles C. Berry
2015-04-20  9:12   ` Nicolas Goaziou
2015-04-22 19:27 ` Nicolas Goaziou
2015-04-22 19:31   ` Sebastien Vauban
2015-04-22 19:40     ` Nicolas Goaziou
2015-04-23 10:47   ` Eric Abrahamsen
2015-04-23 16:25   ` Sebastien Vauban
2015-04-26 12:50     ` Nicolas Goaziou
2015-04-27 15:22 ` Doug Lewan
2015-05-19 11:54 ` Andreas Leha
2015-05-19 13:39   ` Nicolas Goaziou
2015-05-19 14:54     ` Andreas Leha
2015-05-19 19:09       ` Nicolas Goaziou
2015-05-19 20:02         ` Andreas Leha
2015-05-19 21:03           ` Nicolas Goaziou
2015-05-19 21:10             ` Andreas Leha
2015-05-19 21:26               ` Nicolas Goaziou
2015-05-19 21:35                 ` Andreas Leha
2015-05-19 13:32 ` Rainer M Krug
2015-05-19 13:43   ` Andreas Leha
2015-05-20 15:01     ` Rainer M Krug
2015-05-20 15:08       ` Rainer M Krug
2015-05-20 15:24         ` Rainer M Krug
2015-05-20 20:42           ` Andreas Leha
2015-05-20 21:15             ` Rainer M Krug
2015-05-20 21:46           ` Nicolas Goaziou
2015-05-21  8:40             ` Rainer M Krug
2015-05-21 16:24               ` Nicolas Goaziou
2015-05-21 18:18                 ` Rainer M Krug
2015-05-21 18:23                 ` Rainer M Krug
2015-05-21 18:30                 ` Rainer M Krug
2015-05-21 21:53                   ` Nicolas Goaziou
2015-05-22  8:10                     ` Rainer M Krug
2015-05-22 19:08                       ` Nicolas Goaziou
2015-05-23 12:00                         ` Rainer M Krug [this message]
2015-05-24 15:19                           ` Nicolas Goaziou
2015-05-24 15:52                             ` Rainer M Krug
2015-05-27  9:31                               ` Andreas Leha
2015-05-27 10:49                                 ` Nicolas Goaziou
2015-05-19 13:47   ` Nicolas Goaziou
2015-06-05 10:51 ` Rainer M Krug
2015-06-05 21:40   ` Nicolas Goaziou
2015-06-06 14:44     ` Rainer M Krug
2015-06-06 23:22       ` Nicolas Goaziou
2015-06-08  7:50         ` Rainer M Krug
2015-06-09  7:30           ` Nicolas Goaziou
2015-06-09  7:50             ` Rainer M Krug
2015-06-16 21:54               ` Nicolas Goaziou

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m2382ncxlu.fsf@krugs.de \
    --to=rainer@krugs.de \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).