GNOME Bugzilla – Bug 329906
Move "About Scripts" dialog content to documentation
Last modified: 2013-03-24 09:54:26 UTC
"About Scripts" dialog is too long. Most of this material should be moved to the Nautilus docs, and a help button added to the dialog. See also Bug 84463.
The code that is being removed is: - eel_show_info_dialog_with_details - (_("All executable files in this folder will appear in the " - "Scripts menu."), - _("Choosing a script from the menu will run " - "that script with any selected items as input."), - _("All executable files in this folder will appear in the " - "Scripts menu. Choosing a script from the menu will run " - "that script.\n\n" - "When executed from a local folder, scripts will be passed " - "the selected file names. When executed from a remote folder " - "(e.g. a folder showing web or ftp content), scripts will " - "be passed no parameters.\n\n" - "In all cases, the following environment variables will be " - "set by Nautilus, which the scripts may use:\n\n" - "NAUTILUS_SCRIPT_SELECTED_FILE_PATHS: newline-delimited paths for selected files (only if local)\n\n" - "NAUTILUS_SCRIPT_SELECTED_URIS: newline-delimited URIs for selected files\n\n" - "NAUTILUS_SCRIPT_CURRENT_URI: URI for current location\n\n" - "NAUTILUS_SCRIPT_WINDOW_GEOMETRY: position and size of current window\n\n"),
mccann: Why was this moved to gnome-user-docs? Because some functionality will be removed? Or only that long string? What do you expect from the documentation team? Unclear.
There was a dialog that was displayed every time you clicked "Open Scripts Folder". This is not nice. We changed it to always show an infobar that looks like the attached. The rest of the text that used to be shown in the dialog should be moved to the documentation.
Created attachment 221140 [details] screenshot
A possible location for this information: http://library.gnome.org/users/gnome-help/stable/nautilus-behavior.html.en in the "Executable text files" section?
Created attachment 238314 [details] [review] Explains Scripts submenu and how user can execute a script on a file.
Review of attachment 238314 [details] [review]: You should add yourself as an editor for the page. You should fix everything that needs fixing on any lines that you touch. ::: gnome-help/C/nautilus-behavior.page @@ +49,3 @@ + <p>An executable text file is a file that contains a program that you can run + (execute). The <link xref="nautilus-file- + properties-permissions">file permissions</link> must also allow for the file to Don't break links half way through. @@ +50,3 @@ + (execute). The <link xref="nautilus-file- + properties-permissions">file permissions</link> must also allow for the file to + run as a program. The most common are Shell, Python, and Perl scripts. These Remove the serial comma, mark up "Shell", "Python" and "Perl" properly. @@ +51,3 @@ + properties-permissions">file permissions</link> must also allow for the file to + run as a program. The most common are Shell, Python, and Perl scripts. These + have extensions .sh, .py and .pl, respectively.</p> Mark up ".sh", ".py" and ".pl". @@ +55,3 @@ + <p>You can select to <gui>Run executable text files when they are opened</gui>, + <gui>View executable text files when they are opened</gui> or <gui>Ask each + time</gui>. If the last option is selected, a window will appear asking if you The thing that pops up is a dialog, not a window. @@ +56,3 @@ + <gui>View executable text files when they are opened</gui> or <gui>Ask each + time</gui>. If the last option is selected, a window will appear asking if you + wish to run or view the selected text file.</p> When will the dialog appear? Be precise and say that it is when the user tried to open an executable text file. @@ +58,3 @@ + wish to run or view the selected text file.</p> + + <p>Executable text files are also called Scripts. All scripts in <var>~/.local/share/nautilus/scripts</var> folder will appear in the Scripts submenu. A script Scripts is not a proper noun so should not be capitalised. <var> is for variables, the correct markup for paths is <file>. Where is the Scripts submenu? Mark it up as a menu/menuitem. @@ +60,3 @@ + <p>Executable text files are also called Scripts. All scripts in <var>~/.local/share/nautilus/scripts</var> folder will appear in the Scripts submenu. A script + when executed from a local folder, will be passed the selected local file(s) as + parameter(s). To execute a script on a file:</p> Talk about a single script so that you do not need to use the (s) in "file(s)" and "parameter(s)". @@ +72,3 @@ + <p>Right click on the file and select the desired script to execute from the Scripts menu.</p> + </item> +</steps> How does one do this without a right mouse button? @@ +76,3 @@ + <note style="important"> + <p>A script when executed from a remote folder such as a folder showing web + or ftp content, will not be passed any parameters.</p> "A script will not be passed any parameters when executed from a remote folder such as a folder showing web or ftp content."
Kat, I have not written the first few paragraphs. I have only reflowed them which I think has led to believe that I have written those lines (git blame will show that I have touched the lines). Shouldn't have touched them but nevertheless I will rewrite those paragraphs if the need be. I have written content from "Executable text files are also called Scripts".
(In reply to comment #8) > Kat, I have not written the first few paragraphs. I have only reflowed them > which I think has led to believe that I have written those lines (git blame > will show that I have touched the lines). Shouldn't have touched them but > nevertheless I will rewrite those paragraphs if the need be. I know that they're not your work :) That's why I started with: (In reply to comment #7) > Review of attachment 238314 [details] [review]: > > You should fix everything > that needs fixing on any lines that you touch. If you're reflowing lines (or updating a section, as is the case here), then you may as well fix it up instead of leaving it broken.
Aye! working on it :)
Created attachment 238459 [details] [review] Improved "execute" section with better markup structure. Incorporated all changes from review. However, for the review note: "Talk about a single script so that you do not need to use the (s) in "file(s)" and "parameter(s)"." Multiple files can be selected and sent as parameters to the script (the action of executing a script on a file), hence the need to use the (s). Is that OK?
Review of attachment 238459 [details] [review]: It looks like you created a patch to patch your previous patch: please merge these into one using an interactive git rebase and attach that for final review. (In reply to comment #11) > However, for the review note: > > "Talk about a single script so that you do not need to use the (s) in "file(s)" > and "parameter(s)"." > > Multiple files can be selected and sent as parameters to the script (the action > of executing a script on a file), hence the need to use the (s). Is that OK? Something along the lines of "When a script is executed from a local folder, all selected files will be pasted to the script as parameters." does not loose the meaning and is less ambiguous. ::: gnome-help/C/nautilus-behavior.page @@ +54,3 @@ + (execute). The <link xref="nautilus-file-properties-permissions">file + permissions</link> must also allow for the file to run as a program. The most + common are <app>Shell</app>, <app>Python</app> and <app>Perl</app> scripts. Shell, Python and Perl are languages, not application, so use <src> tags. @@ +55,3 @@ + permissions</link> must also allow for the file to run as a program. The most + common are <app>Shell</app>, <app>Python</app> and <app>Perl</app> scripts. + These have extensions <code>.sh</code>, <code>.py</code> and <code>.pl</code>, .sh, .py and .pl are file extensions, not code, so use <file> tags. @@ +68,3 @@ + </item> + <item> + <p><gui>Ask each time</gui>.</p> Remove full stop. @@ +74,1 @@ + <p>If the last option is selected, a dialog will appear asking if you wish to Use "If <gui>Ask each time</gui> is selected, a dialog will pop up asking…" as it is more explicit, leaving less room for confusion. @@ +89,3 @@ </item> <item> + <p>Click on the file to open the context menu and select the desired script Only right click opens the context menu, so be explicit in that the user needs to right click. @@ +90,3 @@ <item> + <p>Click on the file to open the context menu and select the desired script + to execute from the Scripts menu.</p> The menuitem needs to be marked up. @@ +96,3 @@ <note style="important"> + <p>A script will not be passed any parameters when executed from a remote + folder such as a folder showing web or ftp content.</p> Mark up ftp with <src> tags.
Created attachment 238588 [details] [review] Improve execute section with steps and better mallard markups. Update patch.
Created attachment 238594 [details] [review] Improve execute section with steps and mallard markup. Previous patch deleted another section by accident, this patch has been checked and is fine. Sorry!
Review of attachment 238594 [details] [review]: Remove the whitespace please :) ::: gnome-help/C/nautilus-behavior.page @@ +50,2 @@ </section> + Remove whitespace. @@ +102,2 @@ </section> + Remove whitespace.
Created attachment 238656 [details] [review] Improve execute section with steps and mallard markup. Removed whitespace before and after section tags.
Thank you, Kat. Pushed commit 67c78e1d086bb032f6f60ba1644b5fec128dfaa4 to master.