emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Jambunathan K <kjambunathan@gmail.com>
To: Christian Egli <christian.egli@sbs.ch>
Cc: emacs-orgmode@gnu.org
Subject: Re: [Patch] For the Manual: using org-crypt
Date: Wed, 23 Mar 2011 21:33:05 +0530	[thread overview]
Message-ID: <81d3lhhlja.fsf@gmail.com> (raw)
In-Reply-To: <87hbatdf77.fsf@sbs.ch> (Christian Egli's message of "Wed, 23 Mar 2011 16:33:32 +0100")


Thanks Christian. Some minor improvements. The intention is not to
nitpick but to build on top of what you have provided and help the
reviewer.

> +org-crypt will encrypt the text of an entry, but not the headline, or
> +properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt
> +files. 

--8<---------------cut here---------------start------------->8---
> EasyPG is part of recent Emacs releases (at least Emacs 23). It is
> +available as a separate package for earlier versions of Emacs. If your
> +version of Emacs already has EasyPG do not install the package manager's
> +version. Doing so will lead to unpredictable results.
--8<---------------cut here---------------end--------------->8---

This information could be captured elsewhere and be left out of the
manual. (This parts reads like a tutorial entry)

> +
> +To use org-crypt you will need to have something like the following in your
> +@file{.emacs}:

`Recommendation', `suggestion' would be a better word. Word `something'
is ambiguous.

--8<---------------cut here---------------start------------->8---
> +If you want to use Public Key Encryption, you will need to generate a
> +suitable pubic/private key pair using @command{gnupg}.
--8<---------------cut here---------------end--------------->8---

This portion better be left out of the Org manual.

--8<---------------cut here---------------start------------->8---
> +Now any text below a headline that has a @samp{:crypt:} tag will be
> +automatically be encrypted when the file is saved. 
--8<---------------cut here---------------end--------------->8---

Above portion qualifies to be part of introductory text.


--8<---------------cut here---------------start------------->8---
> +Preventing tag inheritance stops you having encrypted text inside encrypted
> +text.
--8<---------------cut here---------------end--------------->8---

Above segment seems a bit out of context ... May be some supplementary
information has to go with it or is it just an implementation artefact
that the user need not bother about. Or is this part of the user
configuration?

> +To decrypt the text just call @kbd{M-x org-decrypt-entry} and the encrypted
> +text where the point is will be replaced with the plain text. 

The first part is complete in itself. The latter can be removed.

--8<---------------cut here---------------start------------->8---
> If you use this +feature a lot, you will probably want to bind
> @kbd{M-x org-decrypt-entry} to +a key.
--8<---------------cut here---------------end--------------->8---

Shouldn't part of the manual?

Jambunathan K.


-- 

  reply	other threads:[~2011-03-23 16:03 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-03-18  8:58 Ian Barton
2011-03-23 10:00 ` Julien Danjou
2011-03-23 15:33   ` Christian Egli
2011-03-23 16:03     ` Jambunathan K [this message]
2011-05-24 13:15       ` Carsten Dominik
2011-05-27  9:15         ` Christian Egli
2011-05-27 10:38           ` Ian Barton
     [not found]             ` <EC782DA7-22B0-4B54-950D-CA00F00DAF8C@gmail.com>
2011-05-30 18:23               ` Ian Barton
2011-05-31 11:40                 ` Carsten Dominik

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=81d3lhhlja.fsf@gmail.com \
    --to=kjambunathan@gmail.com \
    --cc=christian.egli@sbs.ch \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: [Patch] For the Manual: using org-crypt' \
    /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

Code repositories for project(s) associated with this 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).