From mboxrd@z Thu Jan 1 00:00:00 1970 From: John Kitchin Subject: Re: Marking/highlighting text temporarily Date: Mon, 27 Apr 2015 06:27:42 -0400 Message-ID: References: <87a8xyrn39.fsf@pinto.chemeng.ucl.ac.uk> <87bnieufde.fsf@mbork.pl> <87zj5xewsp.fsf@pinto.chemeng.ucl.ac.uk> <87iockmyxy.fsf@ericabrahamsen.net> <87bnicshhc.fsf@ericabrahamsen.net> <87wq0yw12b.fsf@ericabrahamsen.net> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=001a11c22be43014690514b232c3 Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:44337) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YmgGP-0003bJ-J2 for emacs-orgmode@gnu.org; Mon, 27 Apr 2015 06:27:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YmgGN-0008P6-NA for emacs-orgmode@gnu.org; Mon, 27 Apr 2015 06:27:45 -0400 Received: from mail-pd0-x22b.google.com ([2607:f8b0:400e:c02::22b]:35349) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YmgGN-0008OY-BH for emacs-orgmode@gnu.org; Mon, 27 Apr 2015 06:27:43 -0400 Received: by pdbqd1 with SMTP id qd1so124023516pdb.2 for ; Mon, 27 Apr 2015 03:27:42 -0700 (PDT) In-Reply-To: <87wq0yw12b.fsf@ericabrahamsen.net> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Eric Abrahamsen Cc: "emacs-orgmode@gnu.org" --001a11c22be43014690514b232c3 Content-Type: text/plain; charset=UTF-8 This might be a case where having a link type that supports attributes would come in handy. Then you could use these like PDF comments. In the list of PDF comments in Adobe Acrobat for example, there is a checkbox you can use to check them off when you are done with one. Of course, you have to store that state somewhere! I think the pdf comment also stores the author, and maybe other information too like the date and time it was created. John ----------------------------------- Professor John Kitchin Doherty Hall A207F Department of Chemical Engineering Carnegie Mellon University Pittsburgh, PA 15213 412-268-7803 @johnkitchin http://kitchingroup.cheme.cmu.edu On Mon, Apr 27, 2015 at 2:13 AM, Eric Abrahamsen wrote: > John Kitchin writes: > > > Very nice start! > > > > - make comment links a different color/face > > (e.g. https://github.com/jkitchin/org-ref/blob/master/org-ref.el#L360) > > Ah, nice -- too bad there's no built-in way to specify a face for link > types. This looks like it will do nicely, though! > > > otherwise, I think item 4 is the most important one on the todo list. We > > are writing lots of papers this year, so this will be a really helpful > tool! > > Cool, I'll start with that, then. > > I also thought of a command that would take what's in the tabulated list > buffer and convert it into an Org-mode buffer, with the text/comment > pairs in a two-column table. Then the user could export that buffer into > some other format and share a "comments sheet" with other people. > > A bit at a time... > > Eric > > > Eric Abrahamsen writes: > > > >> Eric Abrahamsen writes: > >> > >>> Vikas Rawal writes: > >>> > >>>> On 25-Apr-2015, at 6:22 am, John Kitchin > > >>>> wrote: > >>>> > >>>> Inspired by this conversation, I hacked up this functional comment > >>>> link: > >>>> > >>>> > http://kitchingroup.cheme.cmu.edu/blog/2015/04/24/Commenting-in-org-files/ > >>>> > >>>> > >>>> It has a custom link type that exports in html and latex, and when > >>>> you click on it, it asks if you want to delete the comment. > >>>> > >>>> Nice. One small issue is that when I highlight a text and add comment > >>>> to it, and then delete the comment, one space following the last word > >>>> is removed. > >>>> > >>>> Also, it would be good to make the comment stand out in LaTeX (and > >>>> other) exports, preferably by pushing it to the margin (so it does not > >>>> move everything else). > >>> > >>> Hang on a bit, I'm wasting my afternoon expanding this... > >> > >> Okay, this is as far as I got today. I changed some behavior from John's > >> implementation: when following the links, it seemed like displaying the > >> comment text would be more useful than deleting it -- I think many of us > >> have "delete-org-link" functions lying around. I also couldn't get the > >> add-comment thing to work, as it complained when there was no region, so > >> I changed how that works. > >> > >> Lastly, I spent most of my time learning how tabular list mode works, > >> and haven't actually tested the export. Will save that for tomorrow. > >> Otherwise, here's the introduction from the Commentary. Comments and > >> suggestions very welcome! > >> > >> > >> > >> Provides a new link type for Org that allows you to create comments > >> on arbitrary chunks of text. The link prefix is "comment:". > >> > >> Add comments with `org-comment-add-comment'. Following the link > >> will display the text of the comment in a pop-up buffer. The > >> buffer is in special-mode, hit "q" to dismiss it. > >> > >> Call `org-comment-display-comments' to see all comments in a buffer. > >> > >> See the `org-comment-[backend]-export-style' options for ways to > >> format comments in export. > >> > >> TODO: > >> > >> 1. Better export customization options. > >> 2. What does the ODT comment XML look like? > >> 3. More functions in the display comment buffer: copy as > >> kill... what else? > >> 4. More functions in the comments list buffer, to display, pop to, > >> delete, and edit comment text. > >> 5. Is it possible to have multi-line filled tabular list items? > >> Long comments are not very useful if you can't see the whole thing. > >> 5. Allow multiple comment list buffers attached to different Org > >> buffers. > >> 6. Maybe a minor mode for ease of manipulating comments? > > > > -- > > Professor John Kitchin > > Doherty Hall A207F > > Department of Chemical Engineering > > Carnegie Mellon University > > Pittsburgh, PA 15213 > > 412-268-7803 > > @johnkitchin > > http://kitchingroup.cheme.cmu.edu > > > --001a11c22be43014690514b232c3 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable
This might be a case where having a link type that support= s attributes would come in handy. Then you could use these like PDF comment= s. In the list of PDF comments in Adobe Acrobat for example, there is a che= ckbox you can use to check them off when you are done with one. Of course, = you have to store that state somewhere! I think the pdf comment also stores= the author, and maybe other information too like the date and time it was = created.

John

---= --------------------------------
Professor John Kitchin=C2=A0
Doherty= Hall A207F
Department of Chemical Engineering
Carnegie Mellon Univer= sity
Pittsburgh, PA 15213
412-268-7803

On Mon, Apr 27, 2015 at 2:13 AM, Eric Abraha= msen <eric@ericabrahamsen.net> wrote:
John Kitchin <jkitchin@andrew.cmu.edu> writes:

> Very nice start!
>
> - make comment links a different color/face
> (e.g. https://github.com/jkitchin/org-ref/blob/mast= er/org-ref.el#L360)

Ah, nice -- too bad there's no built-in way to specify a face fo= r link
types. This looks like it will do nicely, though!

> otherwise, I think item 4 is the most important one on the todo list. = We
> are writing lots of papers this year, so this will be a really helpful= tool!

Cool, I'll start with that, then.

I also thought of a command that would take what's in the tabulated lis= t
buffer and convert it into an Org-mode buffer, with the text/comment
pairs in a two-column table. Then the user could export that buffer into some other format and share a "comments sheet" with other people.=

A bit at a time...

Eric

> Eric Abrahamsen writes:
>
>> Eric Abrahamsen <eri= c@ericabrahamsen.net> writes:
>>
>>> Vikas Rawal <vikaslists@agrarianresearch.org> writes:
>>>
>>>>=C2=A0 =C2=A0 =C2=A0On 25-Apr-2015, at 6:22 am, John Kitchi= n <jkitchin@andrew.cmu.edu>
>>>>=C2=A0 =C2=A0 =C2=A0wrote:
>>>>
>>>>=C2=A0 =C2=A0 =C2=A0Inspired by this conversation, I hacked= up this functional comment
>>>>=C2=A0 =C2=A0 =C2=A0link:
>>>>
>>>>=C2=A0 =C2=A0 =C2=A0http://ki= tchingroup.cheme.cmu.edu/blog/2015/04/24/Commenting-in-org-files/
>>>>
>>>>
>>>>=C2=A0 =C2=A0 =C2=A0It has a custom link type that exports = in html and latex, and when
>>>>=C2=A0 =C2=A0 =C2=A0you click on it, it asks if you want to= delete the comment.
>>>>
>>>> Nice. One small issue is that when I highlight a text and = add comment
>>>> to it, and then delete the comment, one space following th= e last word
>>>> is removed.
>>>>
>>>> Also, it would be good to make the comment stand out in La= TeX (and
>>>> other) exports, preferably by pushing it to the margin (so= it does not
>>>> move everything else).
>>>
>>> Hang on a bit, I'm wasting my afternoon expanding this...<= br> >>
>> Okay, this is as far as I got today. I changed some behavior from = John's
>> implementation: when following the links, it seemed like displayin= g the
>> comment text would be more useful than deleting it -- I think many= of us
>> have "delete-org-link" functions lying around. I also co= uldn't get the
>> add-comment thing to work, as it complained when there was no regi= on, so
>> I changed how that works.
>>
>> Lastly, I spent most of my time learning how tabular list mode wor= ks,
>> and haven't actually tested the export. Will save that for tom= orrow.
>> Otherwise, here's the introduction from the Commentary. Commen= ts and
>> suggestions very welcome!
>>
>>
>>
>> Provides a new link type for Org that allows you to create comment= s
>> on arbitrary chunks of text.=C2=A0 The link prefix is "commen= t:".
>>
>> Add comments with `org-comment-add-comment'.=C2=A0 Following t= he link
>> will display the text of the comment in a pop-up buffer.=C2=A0 The=
>> buffer is in special-mode, hit "q" to dismiss it.
>>
>> Call `org-comment-display-comments' to see all comments in a b= uffer.
>>
>> See the `org-comment-[backend]-export-style' options for ways = to
>> format comments in export.
>>
>> TODO:
>>
>> 1. Better export customization options.
>> 2. What does the ODT comment XML look like?
>> 3. More functions in the display comment buffer: copy as
>> kill... what else?
>> 4. More functions in the comments list buffer, to display, pop to,=
>> delete, and edit comment text.
>> 5. Is it possible to have multi-line filled tabular list items? >> Long comments are not very useful if you can't see the whole t= hing.
>> 5. Allow multiple comment list buffers attached to different Org >> buffers.
>> 6. Maybe a minor mode for ease of manipulating comments?
>
> --
> Professor John Kitchin
> Doherty Hall A207F
> Department of Chemical Engineering
> Carnegie Mellon University
> Pittsburgh, PA 15213
> 412-268-7803 > @johnkitchin
> http:/= /kitchingroup.cheme.cmu.edu



--001a11c22be43014690514b232c3--