bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#32722: [O] bug#32722: bug#32722: bug#32722: bug#32722: 26.1; Org-pub


From: Kyle Meyer
Subject: bug#32722: [O] bug#32722: bug#32722: bug#32722: bug#32722: 26.1; Org-publish depend on non-free platform ?
Date: Sat, 29 Sep 2018 19:35:25 -0400

Eli Zaretskii <address@hidden> writes:

>> From: Nicolas Goaziou <address@hidden>
>> Cc: address@hidden,  address@hidden,  address@hidden,  address@hidden,  
>> address@hidden,  address@hidden, Rasmus <address@hidden>
>> Date: Sat, 29 Sep 2018 20:33:35 +0200
>> 
>> > Thank you.  Can we have this change on the ermacs-26 branch of Emacs,
>> > please?
>> 
>> I don't have access to the Emacs repository. 
>> 
>> You can either give me write access there, or I can send you the Texinfo
>> @node contents, or someone with write access could do it for us. I'm
>> Cc'ing Rasmus for the last option.
>
> I could install a patch that you produced from the Org repository's
> appropriate branch.
>
> Thanks.

I've tried to combine these org-manual.org changes into a patch for
org.texi.  This patch should apply on the emacs-26 branch.

-- >8 --
Subject: [PATCH] org.texi: Rewrite Org Mobile section

* doc/misc/org.texi (Org Mobile): Rewrite from "MobileOrg" section.
Remove all references to non-free software.  Move into
"Miscellaneous".

This reflects Nicolas Goaziou's changes from Org's b929e5d77,
46b49ab57, and 3f826b9f7.
---
 doc/misc/org.texi | 293 ++++++++++++++++++++++++----------------------
 1 file changed, 152 insertions(+), 141 deletions(-)

diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index 60647e65e8..873ce4d2cd 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -325,7 +325,6 @@ Top
 * Working with source code::    Export, evaluate, and tangle code blocks
 * Miscellaneous::               All the rest which did not fit elsewhere
 * Hacking::                     How to hack your way around
-* MobileOrg::                   Viewing and capture on a mobile device
 * History and acknowledgments::  How Org came into being
 * GNU Free Documentation License::  The license for this documentation.
 * Main Index::                  An index of Org's concepts and features
@@ -760,12 +759,19 @@ Top
 * TTY keys::                    Using Org on a tty
 * Interaction::                 With other Emacs packages
 * org-crypt::                   Encrypting Org files
+* Org Mobile::                  Viewing and capture on a mobile device
 
 Interaction with other packages
 
 * Cooperation::                 Packages Org cooperates with
 * Conflicts::                   Packages that lead to conflicts
 
+Org Mobile
+
+* Setting up the staging area::  For the mobile device
+* Pushing to the mobile application::  Uploading Org files and agendas
+* Pulling from the mobile application::  Integrating captured and flagged items
+
 Hacking
 
 * Hooks::                       How to reach into Org's internals
@@ -788,12 +794,6 @@ Top
 * Translator functions::        Copy and modify
 * Radio lists::                 Sending and receiving lists
 
-MobileOrg
-
-* Setting up the staging area::  For the mobile device
-* Pushing to MobileOrg::        Uploading Org files and agendas
-* Pulling from MobileOrg::      Integrating captured and flagged items
-
 @end detailmenu
 @end menu
 
@@ -17253,6 +17253,7 @@ Miscellaneous
 * TTY keys::                    Using Org on a tty
 * Interaction::                 With other Emacs packages
 * org-crypt::                   Encrypting Org files
+* Org Mobile::                  Viewing and capture on a mobile device
 @end menu
 
 
@@ -18187,6 +18188,150 @@ org-crypt
 Excluding the crypt tag from inheritance prevents encrypting previously
 encrypted text.
 
address@hidden Org Mobile
address@hidden Org Mobile
+
address@hidden smartphone
+
+Org Mobile is a protocol for synchronizing Org files between Emacs and
+other applications, e.g., on mobile devices.  It enables offline-views
+and capture support for an Org mode system that is rooted on a ``real''
+computer.  The external application can also record changes to
+existing entries.
+
+This appendix describes Org's support for agenda view formats
+compatible with Org Mobile.  It also describes synchronizing changes,
+such as to notes, between the mobile application and the computer.
+
+To change tags and TODO states in the mobile application, first
+customize the variables @code{org-todo-keywords} and @code{org-tag-alist}.
+These should cover all the important tags and TODO keywords, even if
+Org files use only some of them.  Though the mobile application is
+expected to support in-buffer settings, it is required to understand
+TODO states @emph{sets} (see @ref{Per-file keywords}) and
address@hidden exclusive} tags (see @ref{Setting tags}) only for those set in
+these variables.
+
address@hidden
+* Setting up the staging area::  For the mobile device
+* Pushing to the mobile application::  Uploading Org files and agendas
+* Pulling from the mobile application::  Integrating captured and flagged items
address@hidden menu
+
address@hidden Setting up the staging area
address@hidden Setting up the staging area
+
address@hidden org-mobile-directory
+The mobile application needs access to a file directory on
+a address@hidden a server to host files, consider using a WebDAV server,
+such as @uref{https://nextcloud.com, Nextcloud}.  Additional help is at this 
@uref{https://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.} to 
interact with Emacs.  Pass its location through
+the @code{org-mobile-directory} variable.  If you can mount that directory
+locally just set the variable to point to that directory:
+
address@hidden
+(setq org-mobile-directory "~/orgmobile/")
address@hidden lisp
+
address@hidden
+Alternatively, by using TRAMP (see @ref{Top,TRAMP User Manual,,tramp,}),
address@hidden may point to a remote directory accessible
+through, for example, SSH and SCP:
+
address@hidden
+(setq org-mobile-directory "/scpc:user@@remote.host:org/webdav/")
address@hidden lisp
+
address@hidden org-mobile-encryption
+With a public server, consider encrypting the files.  Org also
+requires OpenSSL installed on the local computer.  To turn on
+encryption, set the same password in the mobile application and in
+Emacs.  Set the password in the variable
address@hidden@footnote{If Emacs is configured for safe storing of passwords, 
then
+configure the variable @code{org-mobile-encryption-password}; please read
+the docstring of that variable.}.  Note that even after the mobile
+application encrypts the file contents, the file name remains visible
+on the file systems of the local computer, the server, and the mobile
+device.
+
address@hidden Pushing to the mobile application
address@hidden Pushing to the mobile application
+
address@hidden org-mobile-push
address@hidden org-mobile-files
+The command @code{org-mobile-push} copies files listed in
address@hidden into the staging area.  Files include agenda files
+(as listed in @code{org-agenda-files}).  Customize @code{org-mobile-files} to
+add other files.  File names are staged with paths relative to
address@hidden, so all files should be inside this address@hidden links in 
@code{org-directory} need to have the same name
+as their targets.}.
+
+Push creates a special Org file @samp{agendas.org} with custom agenda views
+defined by the address@hidden creating the agendas, Org mode forces ID 
properties on
+all referenced entries, so that these entries can be uniquely
+identified if Org Mobile flags them for further action.  To avoid
+setting properties configure the variable
address@hidden to @code{nil}.  Org mode then relies
+on outline paths, assuming they are unique.}.
+
+Finally, Org writes the file @samp{index.org}, containing links to other
+files.  The mobile application reads this file first from the server
+to determine what other files to download for agendas.  For faster
+downloads, it is expected to only read files whose address@hidden are stored 
automatically in the file
address@hidden
+have changed.
+
address@hidden Pulling from the mobile application
address@hidden Pulling from the mobile application
+
address@hidden org-mobile-pull
+The command @code{org-mobile-pull} synchronizes changes with the server.
+More specifically, it first pulls the Org files for viewing.  It then
+appends captured entries and pointers to flagged or changed entries to
+the file @samp{mobileorg.org} on the server.  Org ultimately integrates its
+data in an inbox file format, through the following steps:
+
address@hidden
address@hidden
address@hidden org-mobile-inbox-for-pull
+Org moves all entries found in @address@hidden file will be empty after this 
operation.} and appends
+them to the file pointed to by the variable
address@hidden  It should reside neither in the
+staging area nor on the server.  Each captured entry and each
+editing event is a top-level entry in the inbox file.
+
address@hidden
address@hidden @samp{FLAGGED}, tag
+After moving the entries, Org processes changes to the shared
+files.  Some of them are applied directly and without user
+interaction.  Examples include changes to tags, TODO state,
+headline and body text.  Entries requiring further action are
+tagged as @samp{FLAGGED}.  Org marks entries with problems with an error
+message in the inbox.  They have to be resolved manually.
+
address@hidden
+Org generates an agenda view for flagged entries for user
+intervention to clean up.  For notes stored in flagged entries, Org
+displays them in the echo area when point is on the corresponding
+agenda item.
+
address@hidden @asis
address@hidden @kbd{?}
+Pressing @kbd{?} displays the entire flagged note in
+another window.  Org also pushes it to the kill ring.  To
+store flagged note as a normal note, use @kbd{? z C-y C-c C-c}.  Pressing 
@kbd{?} twice does these things: first
+it removes the @samp{FLAGGED} tag; second, it removes the flagged
+note from the property drawer; third, it signals that manual
+editing of the flagged entry is now finished.
address@hidden table
address@hidden enumerate
+
address@hidden ? @r{(Agenda dispatcher)}
+From the agenda dispatcher, @kbd{?} returns to the view to finish
+processing flagged entries.  Note that these entries may not be the
+most recent since the mobile application searches files that were last
+pulled.  To get an updated agenda view with changes since the last
+pull, pull again.
+
 @node Hacking
 @appendix Hacking
 @cindex hacking
@@ -19151,140 +19296,6 @@ Using the mapping API
 (length (org-map-entries t "/+WAITING" 'agenda))
 @end lisp
 
address@hidden MobileOrg
address@hidden MobileOrg
address@hidden iPhone
address@hidden MobileOrg
-
-MobileOrg is a companion mobile app that runs on iOS and Android devices.
-MobileOrg enables offline-views and capture support for an Org mode system
-that is rooted on a ``real'' computer.  MobileOrg can record changes to
-existing entries.
-
-The @uref{https://github.com/MobileOrg/, iOS implementation} for the
address@hidden/iPod Touch/iPad} series of devices, was started by Richard
-Moreland and is now in the hands Sean Escriva.  Android users should check
-out @uref{http://wiki.github.com/matburt/mobileorg-android/, MobileOrg
-Android} by Matt Jones.  Though the two implementations are not identical,
-they offer similar features.
-
-This appendix describes Org's support for agenda view formats compatible with
-MobileOrg.  It also describes synchronizing changes, such as to notes,
-between MobileOrg and the computer.
-
-To change tags and TODO states in MobileOrg, first customize the variables
address@hidden and @code{org-tag-alist}.  These should cover all
-the important tags and TODO keywords, even if Org files use only some of
-them.  Though MobileOrg has in-buffer settings, it understands TODO states
address@hidden (@pxref{Per-file keywords}) and @emph{mutually exclusive} tags
-(@pxref{Setting tags}) only for those set in these variables.
-
address@hidden
-* Setting up the staging area::  For the mobile device
-* Pushing to MobileOrg::        Uploading Org files and agendas
-* Pulling from MobileOrg::      Integrating captured and flagged items
address@hidden menu
-
address@hidden Setting up the staging area
address@hidden Setting up the staging area
-
-MobileOrg needs access to a file directory on a server to interact with
-Emacs.  With a public server, consider encrypting the files.  MobileOrg
-version 1.5 supports encryption for the iPhone.  Org also requires
address@hidden installed on the local computer.  To turn on encryption, set
-the same password in MobileOrg and in Emacs.  Set the password in the
-variable @address@hidden Emacs is configured for
-safe storing of passwords, then configure the variable,
address@hidden; please read the docstring of that
-variable.}.  Note that even after MobileOrg encrypts the file contents, the
-file names will remain visible on the file systems of the local computer, the
-server, and the mobile device.
-
-For a server to host files, consider options like
address@hidden://dropbox.com,Dropbox.com} address@hidden alternative is to
-use webdav server.  MobileOrg documentation has details of webdav server
-configuration.  Additional help is at
address@hidden://orgmode.org/worg/org-faq.html#mobileorg_webdav, FAQ entry}.}.
-On first connection, MobileOrg creates a directory @file{MobileOrg/} on
-Dropbox.  Pass its location to Emacs through an init file variable as
-follows:
-
address@hidden
-(setq org-mobile-directory "~/Dropbox/MobileOrg")
address@hidden lisp
-
-Org copies files to the above directory for MobileOrg.  Org also uses the
-same directory for sharing notes between Org and MobileOrg.
-
address@hidden Pushing to MobileOrg
address@hidden Pushing to MobileOrg
-
-Org pushes files listed in @code{org-mobile-files} to
address@hidden  Files include agenda files (as listed in
address@hidden).  Customize @code{org-mobile-files} to add other
-files.  File names will be staged with paths relative to
address@hidden, so all files should be inside this
address@hidden links in @code{org-directory} should have the
-same name as their targets.}.
-
-Push creates a special Org file @file{agendas.org} with custom agenda views
-defined by the address@hidden creating the agendas, Org mode will force
-ID properties on all referenced entries, so that these entries can be
-uniquely identified if MobileOrg flags them for further action.  To avoid
-setting properties configure the variable
address@hidden to @code{nil}.  Org mode will then
-rely on outline paths, assuming they are unique.}.
-
-Org writes the file @file{index.org}, containing links to other files.
-MobileOrg reads this file first from the server to determine what other files
-to download for agendas.  For faster downloads, MobileOrg will read only
-those files whose address@hidden are stored automatically in
-the file @file{checksums.dat}.} have changed.
-
address@hidden Pulling from MobileOrg
address@hidden Pulling from MobileOrg
-
-When MobileOrg synchronizes with the server, it pulls the Org files for
-viewing.  It then appends to the file @file{mobileorg.org} on the server the
-captured entries, pointers to flagged and changed entries.  Org integrates
-its data in an inbox file format.
-
address@hidden
address@hidden
-Org moves all entries found in
address@hidden@address@hidden will be empty after this
-operation.} and appends them to the file pointed to by the variable
address@hidden  Each captured entry and each editing event
-is a top-level entry in the inbox file.
address@hidden
-After moving the entries, Org attempts changes to MobileOrg.  Some changes
-are applied directly and without user interaction.  Examples include changes
-to tags, TODO state, headline and body text.  Entries for further action are
-tagged as @code{:FLAGGED:}.  Org marks entries with problems with an error
-message in the inbox.  They have to be resolved manually.
address@hidden
-Org generates an agenda view for flagged entries for user intervention to
-clean up.  For notes stored in flagged entries, MobileOrg displays them in
-the echo area when the cursor is on the corresponding agenda item.
-
address@hidden @kbd
address@hidden ?
address@hidden ?
-Pressing @kbd{?} displays the entire flagged note in another window.  Org
-also pushes it to the kill ring.  To store flagged note as a normal note, use
address@hidden  z C-y C-c C-c}.  Pressing @kbd{?} twice does these things: 
first it
-removes the @code{:FLAGGED:} tag; second, it removes the flagged note from
-the property drawer; third, it signals that manual editing of the flagged
-entry is now finished.
address@hidden table
address@hidden enumerate
-
address@hidden C-c a ?
address@hidden a ?} returns to the agenda view to finish processing flagged
-entries.  Note that these entries may not be the most recent since MobileOrg
-searches files that were last pulled.  To get an updated agenda view with
-changes since the last pull, pull again.
-
 @node History and acknowledgments
 @appendix History and acknowledgments
 @cindex acknowledgments
-- 
2.19.0






reply via email to

[Prev in Thread] Current Thread [Next in Thread]