Re: [O] [Patch] For the Manual: using org-crypt

[Carsten Dominik]

Hi,

Is anyone working on making this a complete patch?

Thanks

- Carsten

On Mar 23, 2011, at 5:03 PM, Jambunathan K wrote:

> 
> 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
>> address@hidden:
> 
> `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.
> 
> 
> -- 
> 

- Carsten