GNOME.org
 

[gnome-text-editor: 1/2] help: first basic chapters


commit 8f392d050c3510f02f5542c378dfb7973ed292c8
Author: Günther Wagner <info gunibert de>
Date:   Sat Jul 31 16:04:55 2021 +0200

    help: first basic chapters

 help/C/basics-create-new-file.page  | 34 +++++++++++++++++
 help/C/basics-draft-folder.page     | 32 ++++++++++++++++
 help/C/basics-open-file.page        |  8 ++--
 help/C/edit-search-and-replace.page | 74 +++++++++++++++++++++++++++++++++++++
 help/C/index.page                   |  7 +++-
 help/meson.build                    |  3 ++
 6 files changed, 153 insertions(+), 5 deletions(-)
---
diff --git a/help/C/basics-create-new-file.page b/help/C/basics-create-new-file.page
new file mode 100644
index 0000000..87f47c8
--- /dev/null
+++ b/help/C/basics-create-new-file.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task" version="1.1"
+      id="basics-create-new-file">
+  <info>
+    <!--
+        Recommended statuses: stub incomplete draft outdated review candidate final
+    -->
+    <revision version="40" date="2021-07-22" status="draft"/>
+
+    <credit type="author copyright">
+      <name>Günther Wagner</name>
+      <email>info gunibert de</email>
+      <years>2021</years>
+    </credit>
+
+    <link type="guide" xref="index#basics"/>
+    <link type="seealso" xref="basics-draft-folder"/>
+
+    <keywords>new file, create file</keywords>
+  </info>
+
+  <title>Create a new file</title>
+
+  <p>In GNOME Text Editor a new file can be created in several ways:</p>
+
+  <list>
+    <item><p>Use the <gui>New tab</gui> button.</p></item>
+    <item><p>Press <keyseq><key>Ctrl</key><key>N</key></keyseq></p></item>
+  </list>
+
+  <p>A new document is by default in a state called <gui>Draft</gui>. The meaning of this is
+  that the document is automatically saved in the draft folder of GNOME Text Editor.</p>
+
+</page>
diff --git a/help/C/basics-draft-folder.page b/help/C/basics-draft-folder.page
new file mode 100644
index 0000000..1a41a7f
--- /dev/null
+++ b/help/C/basics-draft-folder.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="concept" version="1.1"
+      id="basics-draft-folder">
+  <info>
+    <!--
+        Recommended statuses: stub incomplete draft outdated review candidate final
+    -->
+    <revision version="40" date="2021-07-22" status="draft"/>
+
+    <credit type="author copyright">
+      <name>Günther Wagner</name>
+      <email>info gunibert de</email>
+      <years>2021</years>
+    </credit>
+
+    <link type="guide" xref="index#basics"/>
+
+    <desc>Explaination of the drafts folder.</desc>
+
+    <keywords>draft, folder</keywords>
+  </info>
+
+  <title>Draft folder</title>
+
+  <p>GNOME Text Editor will automatically save every unsaved file. This folder
+  is located in the application data directory (~/.local/share/gnome-text-editor or
+  in the respective flatpak folder). You should normally not care about that folder
+  as every draft file is always accessible via the <gui>Open</gui> menu.</p>
+
+  <p>You can identify a draft in the title of GNOME Text Editor. There is a subtitle
+  'Draft' if your current document is not saved and will reside in the draft folder.</p>
+</page>
diff --git a/help/C/basics-open-file.page b/help/C/basics-open-file.page
index 8eac9fc..3cbe2c8 100644
--- a/help/C/basics-open-file.page
+++ b/help/C/basics-open-file.page
@@ -7,10 +7,10 @@
   </info>
 
   <title>
-    Open a file in GNOME Text Editor
+    Open a file
   </title>
 
-  <p>To open a file in GNOME Text Editor use <gui>Open</gui> in the Headerbar
+  <p>To open a file in GNOME Text Editor use <gui style="button">Open</gui> in the Headerbar
   and <gui>Browse Files...</gui> or the shortcut <keyseq><key>Ctrl</key><key>O</key></keyseq>.
   </p>
 
@@ -19,10 +19,10 @@
 
   <p>Closing the dialog without opening a file can be achieved by clicking <gui>Cancel</gui>.</p>
 
-  <section>
+  <section id="by_name">
     <title>Open by name</title>
 
-    <p>You can search in the <gui>Open Popup</gui> or press <keyseq><key>Ctrl</key><key>K</key></keyseq> to 
search for recently edited files.</p>
+    <p>You can search in the <gui>Open</gui> Popup or press <keyseq><key>Ctrl</key><key>K</key></keyseq> to 
search for recently edited files.</p>
 
     <media type="image" src="media/search-recent.png"/>
   </section>
diff --git a/help/C/edit-search-and-replace.page b/help/C/edit-search-and-replace.page
new file mode 100644
index 0000000..423ee90
--- /dev/null
+++ b/help/C/edit-search-and-replace.page
@@ -0,0 +1,74 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task" version="1.1"
+      id="edit-search-and-replace">
+  <info>
+    <!--
+        Recommended statuses: stub incomplete draft outdated review candidate final
+    -->
+    <revision version="VERSION.NUMBER" date="2021-07-31" status="draft"/>
+
+    <credit type="author copyright">
+      <name>Günther Wagner</name>
+      <email>info gunibert de</email>
+      <years>2021</years>
+    </credit>
+
+    <link type="guide" xref="index#edit"/>
+
+    <!--
+        TODO: Remove comments when status will be final
+        Think about whether other pages should be in the seealso list.
+        The target page will automatically get a seealso link back.
+    <link type="seealso" xref="someotherid"/>
+    -->
+
+    <!--
+        Think about whether external resources should be in the seealso
+        list. These require a title.
+    <link type="seealso" href="http://someurl";>
+      <title>Link title</title>
+    </link>
+    -->
+
+    <desc>Search and replace text</desc>
+
+    <keywords>search, replace</keywords>
+  </info>
+
+  <title>Search and Replace</title>
+
+  <p>GNOME text editor allows you to quickly search in big text files for a specific
+  text parts. Oftentimes these text parts need to be replaced also.</p>
+
+  <list>
+    <title>Search for text</title>
+    <item><p>Activate the search panel via <guiseq><gui>Hamburger 
Menu</gui><gui>Find/Replace...</gui></guiseq> or activate it via 
<keyseq><key>Ctrl</key><key>F</key></keyseq>.</p></item>
+    <item><p>Add your search term into the entry field.</p></item>
+    <item><p>The search is performed as you type. You can now iterate the search result with <key>↑</key> or 
<key>↓</key> or with the buttons beside the entry.</p></item>
+    <item><p>Pressing <key>Enter</key> will move the cursor to the currently highlighted search 
result.</p></item>
+    <item><p>Pressing <key>Escape</key> will discard the search panel and the search result.</p></item>
+  </list>
+
+  <list>
+    <title>Search tips &amp; tricks</title>
+    <item><p>In order to quickly search for a word highlight the word and press 
<keyseq><key>Ctrl</key><key>F</key></keyseq>. The word will be automatically entered into the search 
entry.</p></item>
+    <item><p>The search can be refined with additional options in the <gui>gear</gui> menu.</p>
+      <list>
+        <item><p>Only match the whole word</p></item>
+        <item><p>Using regular expressions as search term</p></item>
+        <item><p>Respecting case sensitivity of the search term</p></item>
+      </list>
+    </item>
+  </list>
+
+  <list>
+    <title>Replace text</title>
+    <item><p>Activate the search panel via <guiseq><gui>Hamburger 
Menu</gui><gui>Find/Replace...</gui></guiseq> or activate it via 
<keyseq><key>Ctrl</key><key>H</key></keyseq>.</p></item>
+    <item><p>In case you opened the search panel via the <gui>Hamburger Menu</gui> you have to click the 
button for activating the replace functionality.</p></item>
+    <item><p>Add your search term which should be replaced into the entry field.</p></item>
+    <item><p>Add your replace term into the second entry field.</p></item>
+    <item><p>The search is performed as you type. You can now iterate the search result with <key>↑</key> or 
<key>↓</key> or with the buttons beside the entry.</p></item>
+    <item><p>It is now possible to only replace the current search result element via <gui>Replace</gui> or 
you can replace all occurrences via <gui>Replace All</gui>.</p></item>
+  </list>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 27b426e..ed495a3 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -33,7 +33,12 @@
 
   <section id="basics">
     <title>Basics</title>
-    <links type="topic"/>
+    <links type="topic" style="2column"/>
+  </section>
+
+  <section id="edit">
+    <title>Edit files</title>
+    <links type="topic" style="2column"/>
   </section>
 
 </page>
diff --git a/help/meson.build b/help/meson.build
index 5318add..a636104 100644
--- a/help/meson.build
+++ b/help/meson.build
@@ -1,6 +1,9 @@
 pages = [
   'index.page',
   'basics-open-file.page',
+  'basics-create-new-file.page',
+  'basics-draft-folder.page',
+  'edit-search-and-replace.page',
   'legal.xml',
 ]
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]