public inbox for [email protected]  
help / color / mirror / Atom feed
From: Susan Douglas <[email protected]>
To: [email protected]
Cc: Akshay Joshi <[email protected]>
Cc: Ashesh Vashi <[email protected]>
Cc: Dave Page <[email protected]>
Subject: Patch for External formatting utility description
Date: Fri, 18 Dec 2015 13:41:30 -0500
Message-ID: <[email protected]> (raw)
List-Unsubscribe:  <mailto:[email protected]?body=unsub%20pgadmin-hackers>

Hi All,

I’ve attached a patch that adds a description of the External formatting utility field to the options-query_tool.rst file, and a new set of screenshots for the options dialog.

Thanks!

— Susan






-- 
Sent via pgadmin-hackers mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgadmin-hackers


Attachments:

  [application/octet-stream] external_formatting.patch (1.4K, 2-external_formatting.patch)
  download | inline diff:
diff --git a/docs/en_US/options-query_tool.rst b/docs/en_US/options-query_tool.rst
index bb3f0af..1e0d20b 100644
--- a/docs/en_US/options-query_tool.rst
+++ b/docs/en_US/options-query_tool.rst
@@ -27,6 +27,17 @@ Use the fields on the *Query editor* dialog to specify workspace preferences for
 
 * **Keywords in uppercase** - Check the box next to *Keywords in uppercase* to instruct the Query tool to convert any keywords entered to an uppercase font.
 
+* **External formatting utility** - Use the *External formatting utility* field to provide the name of a formatting tool that can be used to make queries more readable.  Use of a tool that provides support for UTF-8 multi-byte characters is not required, but is preferable.    The utility must:
+
+  * Accept a STDIN stream and write the result set to STDOUT
+  * Provide a result in less than 3 seconds
+  * Exit with a code 0 on success
+
+  To use an external formatting tool in the Query Editor:
+
+  * Provide the name of the formatting tool in the *External formatting utility* field of the *Options* dialogue.
+  * In the Query Editor, select a block of text for formatting, and Press Ctrl+Shift+f, or navigate through the *Edit* menu to the *Format* menu, and select *External Format*.
+
 .. image:: images/options-colours.png
 
 Use the fields displayed on the *Colours* dialog to select colours for items displayed in the Query tool:


  [application/zip] options_screenshots.zip (501.0K, 4-options_screenshots.zip)
  download

view thread (2+ messages)  latest in thread

reply

Reply instructions:

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

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Patch for External formatting utility description
  In-Reply-To: <[email protected]>

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

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox