After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 698834 - tab groups are undocumented
tab groups are undocumented
Status: RESOLVED FIXED
Product: gedit
Classification: Applications
Component: docs
git master
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Gedit maintainers
Depends on:
Blocks:
 
 
Reported: 2013-04-25 12:13 UTC by Adam Dingle
Modified: 2013-10-25 14:44 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Tab groups feature documented (7.94 KB, patch)
2013-06-19 19:12 UTC, Radina Matic
committed Details | Review
Fix mistakes and style on tab group documentation (5.44 KB, patch)
2013-10-09 09:38 UTC, Aleksandra Hankus - Ola
needs-work Details | Review
tab groups (2.06 KB, patch)
2013-10-25 14:34 UTC, Aleksandra Hankus - Ola
committed Details | Review

Description Adam Dingle 2013-04-25 12:13:27 UTC
Tab groups are a cool feature of gedit, but are not mentioned in gedit's help pages.  They should certainly be mentioned on the page "Move and re-order tabs", at least.
Comment 1 Ignacio Casal Quinteiro (nacho) 2013-04-25 12:29:15 UTC
Tell to designers that want them gone :( Although I already said that I will not kill them
Comment 2 Adam Dingle 2013-04-25 12:30:34 UTC
If they go away I will fork gedit.  :) Thank you for standing firm.
Comment 3 Radina Matic 2013-06-19 19:12:09 UTC
Created attachment 247282 [details] [review]
Tab groups feature documented
Comment 4 Radina Matic 2013-06-19 19:12:59 UTC
Agreed that it is a neat feature... :) 
I don't use separate gedit windows anymore since I discovered it! 

Feature documented as a new Mallard page "Organize files in grouped tabs". Updated the Shortcuts page and added links to related topics.
Comment 5 Damian Duffy 2013-07-17 18:54:43 UTC
Review of attachment 247282 [details] [review]:

Documentation looks good to me.  Well done :)
Comment 6 Kat 2013-07-17 19:07:50 UTC
Review of attachment 247282 [details] [review]:

Please watch your indentation and reflowing :)

::: help/C/gedit-shortcut-keys.page
@@ +95,3 @@
         </tr>
+        <tr>
+          <td><p>New Tab Group</p></td>

Is this a <gui>? If yes, <gui> it up. If not, use sentence capitalisation.

@@ +97,3 @@
+          <td><p>New Tab Group</p></td>
+          <td><p><keyseq><key>Ctrl</key><key>Alt</key><key>
+	  N</key></keyseq></p></td>

Don't break the line between a tag and the content, this adds random spaces into the strings.

@@ +100,3 @@
+        </tr>
+        <tr>
+        <td><p>Previous Tab Group</p></td>

Indentation.

@@ +104,3 @@
+        </tr>
+        <tr>
+        <td><p>Next Tab Group</p></td>

Indentation.

::: help/C/gedit-tab-groups.page
@@ +17,3 @@
+    
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+  </info>

Missing <desc>.

@@ +19,3 @@
+  </info>
+
+  <title>Organize files in grouped tabs</title>

Organise *into*.

@@ +20,3 @@
+
+  <title>Organize files in grouped tabs</title>
+  <p>If you are working with multiple tabs in <app>gedit</app> you can group them, making it easier to keep your opened files organized. Adding a new tab group will divide the <app>gedit</app> window in two panes, open a new "Untitled Document" in the new pane, and make it active. You can open files into that tab group and move tabs from one tab group to another.</p>

Reflow.

"If you are working with multiple tabs in <app>gedit</app>, you can group them, making it easier to keep your opened files organized."
…or even better "If you are working with multiple tabs in <app>gedit</app>, you can group them to make it easier to organise opened files."

@@ +40,3 @@
+  </section>
+
+  <section id="moving-through-tab-groups">

IDs should be kept short.

@@ +42,3 @@
+  <section id="moving-through-tab-groups">
+    <title>Move through tab groups</title>
+    <p>To move forward (on the next) tab group:</p>

"To move to the next tab group"

@@ +45,3 @@
+
+    <list>
+  <item><p>Go to <guiseq><gui>Documents</gui><gui>Next Tab Group</gui></guiseq> in the main menu.</p></item>

Select, not "go to".

@@ +47,3 @@
+  <item><p>Go to <guiseq><gui>Documents</gui><gui>Next Tab Group</gui></guiseq> in the main menu.</p></item>
+  <item><p>Use the <keyseq><key>Shift</key><key>Ctrl</key><key>Alt</key><key>Page down</key></keyseq> shortcut.</p></item>
+</list>

Indentation

@@ +53,3 @@
+
+    <list>
+  <item><p>Go to <guiseq><gui>Documents</gui><gui>Previous Tab Group</gui></guiseq> in the main menu.</p></item>

Select, not "go to".

@@ +55,3 @@
+  <item><p>Go to <guiseq><gui>Documents</gui><gui>Previous Tab Group</gui></guiseq> in the main menu.</p></item>
+  <item><p>Use the <keyseq><key>Shift</key><key>Ctrl</key><key>Alt</key><key>Page up</key></keyseq> shortcut.</p></item>
+</list>

Indentation.

@@ +66,3 @@
+    <steps>
+      <item>
+        <p>Click and hold the mouse button on the tab.</p>

Which mouse button? What if I'm using a touch screen without mouse? Just "Click on the tab and drag it to another tab group". We also sometimes use "press" instead of "click", but that doesn't work well for mice.

@@ +81,3 @@
+
+    <p>See the <link xref="gedit-shortcut-keys">tab-related shortcut
+    keys</link> table to make it easier to manage your tab groups.</p>

This should be in a seealso link at the top of the page.
Comment 7 Aleksandra Hankus - Ola 2013-10-09 09:38:22 UTC
Created attachment 256791 [details] [review]
Fix mistakes and style on tab group documentation

Kat, I have fixed the issues that you pointed out in your last comment. Please review it.
Comment 8 Kat 2013-10-22 09:26:55 UTC
Comment on attachment 247282 [details] [review]
Tab groups feature documented

Fixed up (new page tidied, whitespace removed and added to Makefile.am), then pushed to master in commit d5644fd09f6fe90e15c2c3d6d15dcac3c57d9550
Comment 9 Kat 2013-10-22 09:31:18 UTC
Review of attachment 256791 [details] [review]:

Please rebase your patch on top of master and reattach it. You should have found that the previous patch (which you patched) did not apply cleanly when you started. In those cases, it is generally helpful if you fixup the earlier patch so that the all patches apply cleanly. Please ask on #docs if you need help: it is good to know what your technical ability is as you are interested in applying for the OPW.

You should find that gedit-tab-groups is technically fine, although the content can be improved (if you want to do this, do it in a separate patch).
Comment 10 Aleksandra Hankus - Ola 2013-10-25 14:34:57 UTC
Created attachment 258128 [details] [review]
tab groups

Kat, this is the previous patch rebased. After your changes this is quite a simple patch. The previous patch fixed the issues that you pointed out in your comment but they seemed already fixed apart from what it appeared after the rebase. Is this what you wanted?
Comment 11 Kat 2013-10-25 14:43:49 UTC
Comment on attachment 258128 [details] [review]
tab groups

Pushed to master in commit a159fe38c8fe0ca804a4de4304f87811bb3c1ae1

Yes, that's exactly what I meant :)