tdf#128590 Create Auto-Redact help page

Change-Id: I16fc3db85e3d62edd8241136ff53558ba46c44a7 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/118727 Tested-by: Jenkins Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org> Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
author: Rafael Lima <rafael.palma.lima@gmail.com> 2021-07-12 13:33:18 +0200
committer: Olivier Hallot <olivier.hallot@libreoffice.org> 2021-07-12 17:20:22 +0200
commit: e30dc2a0cd25a3c81bfbbcd61283c67ea66e0c32 (patch)
tree: 98fe3d85e28c40c37930b4d82466a3ab441e08c7
parent: f7c998f88c2a4666f5d2a440f1449d763e05b85e (diff)
6 files changed, 69 insertions, 1 deletions
diff --git a/AllLangHelp_shared.mk b/AllLangHelp_shared.mk
index efb7959be8..ef4b88e0b5 100644
--- a/AllLangHelp_shared.mk
+++ b/AllLangHelp_shared.mk
@@ -625,6 +625,7 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,shared,\
     helpcontent2/source/text/shared/guide/activex \
     helpcontent2/source/text/shared/guide/assistive \
     helpcontent2/source/text/shared/guide/autocorr_url \
+    helpcontent2/source/text/shared/guide/auto_redact \
     helpcontent2/source/text/shared/guide/autohide \
     helpcontent2/source/text/shared/guide/background \
     helpcontent2/source/text/shared/guide/border_paragraph \
diff --git a/source/auxiliary/scalc.tree b/source/auxiliary/scalc.tree
index 4e88f87350..96af43ee37 100644
--- a/source/auxiliary/scalc.tree
+++ b/source/auxiliary/scalc.tree
@@ -91,6 +91,7 @@
 <topic id="scalc/text/scalc/guide/html_doc.xhp">Saving and Opening Sheets in HTML</topic>
 <topic id="scalc/text/scalc/guide/csv_formula.xhp">Importing and Exporting Text Files</topic>
 <topic id="shared/text/shared/guide/redaction.xhp">Redacting a Spreadsheet</topic>
+<topic id="shared/text/shared/guide/auto_redact.xhp">Automatic Redaction</topic>
 		</node>
 		<node id="0805" title="Formatting">
 <topic id="scalc/text/scalc/guide/text_rotate.xhp">Rotating Text</topic>
diff --git a/source/auxiliary/simpress.tree b/source/auxiliary/simpress.tree
index c797aab57c..dba4c6ecf4 100644
--- a/source/auxiliary/simpress.tree
+++ b/source/auxiliary/simpress.tree
@@ -67,6 +67,7 @@
              <topic id="sdraw/text/sdraw/guide/graphic_insert.xhp">Inserting Graphics</topic>
              <topic id="simpress/text/simpress/guide/page_copy.xhp">Copying Slides From Other Presentations</topic>
              <topic id="shared/text/shared/guide/redaction.xhp">Redacting a Presentation</topic>
+             <topic id="shared/text/shared/guide/auto_redact.xhp">Automatic Redaction</topic>
          </node>
          <node id="0404" title="Formatting">
              <topic id="simpress/text/simpress/guide/palette_files.xhp">Loading Color, Gradient, and Hatching Lists</topic>
diff --git a/source/auxiliary/swriter.tree b/source/auxiliary/swriter.tree
index b438e604c6..686960031e 100644
--- a/source/auxiliary/swriter.tree
+++ b/source/auxiliary/swriter.tree
@@ -209,6 +209,7 @@
 <topic id="swriter/text/swriter/guide/send2html.xhp">Saving Text Documents in HTML Format</topic>
 <topic id="swriter/text/swriter/guide/textdoc_inframe.xhp">Inserting an Entire Text Document</topic>
 <topic id="shared/text/shared/guide/redaction.xhp">Redacting a Text Document</topic>
+<topic id="shared/text/shared/guide/auto_redact.xhp">Automatic Redaction</topic>
 		</node>
 		<node id="0220" title="Master Documents">
 <topic id="swriter/text/swriter/guide/globaldoc.xhp">Master Documents and Subdocuments</topic>
diff --git a/source/text/shared/guide/auto_redact.xhp b/source/text/shared/guide/auto_redact.xhp
new file mode 100644
index 0000000000..cca8d13184
--- /dev/null
+++ b/source/text/shared/guide/auto_redact.xhp
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+<!--
+* This file is part of the LibreOffice project.
+*
+* This Source Code Form is subject to the terms of the Mozilla Public
+* License, v. 2.0. If a copy of the MPL was not distributed with this
+* file, You can obtain one at http://mozilla.org/MPL/2.0/.
+*
+-->
+<meta>
+  <topic id="redaction" indexer="include" status="PUBLISH">
+    <title id="tit" xml-lang="en-US">Automatic Redaction</title>
+    <filename>/text/shared/guide/auto_redact.xhp</filename>
+  </topic>
+</meta>
+<body>
+  <bookmark xml-lang="en-US" branch="index" id="bm_id821562797360035">
+    <bookmark_value>spreadsheet; auto-redact</bookmark_value>
+    <bookmark_value>presentations; auto-redact</bookmark_value>
+    <bookmark_value>text documents; auto-redact contents</bookmark_value>
+    <bookmark_value>automatic redaction</bookmark_value>
+  </bookmark>
+
+  <section id="autoredact01">
+    <bookmark id="bm_id981562795247716" branch="hid/.uno:AutoRedactDoc" localize="false"/>
+    <bookmark xml-lang="en-US" branch="hid/sfx/ui/autoredactdialog/" id="bm_id3145208" localize="false"/>
+    <h1 id="hd_id171562795247122"><variable id="autoredact_h1"><link href="text/shared/guide/auto_redact.xhp" name="auto_redact">Automatic Redaction</link></variable></h1>
+    <paragraph id="par_id4715627952214572" role="paragraph"><variable id="auto_redact_var"><ahelp hid="sfx/ui/autoredactdialog/">Use automatic redaction to define words and patterns that are automatically marked for redaction.</ahelp></variable> This makes it easier to redact %PRODUCTNAME documents that have multiple portions of text that need to be hidden due to sensitivity or privacy issues.</paragraph>
+  </section>
+  <section id="howtoget">
+    <paragraph role="paragraph" id="par_id961562795750725">Choose <menuitem>Tools - Auto-Redact</menuitem></paragraph>
+  </section>
+  <paragraph role="paragraph" id="par_id551626027709362">This feature comes in handy in documents that have multiple occurrences of names and other personal information (e.g. credit cards, phone numbers, etc). Redacting all these portions of the document manually would required significant effort, but with Automatic Redaction this task can be automated in a more efficient manner.</paragraph>
+  <h2 id="hd_id11626028179231">Creating Targets</h2>
+  <paragraph role="paragraph" id="par_id211626097811059">Targets are rules and patterns used by Automatic Redaction to find portions of the document to be automatically marked for redaction.</paragraph>
+  <paragraph role="paragraph" id="par_id851626028193218">To create a new target, click the <menuitem>Add Target</menuitem> button.</paragraph>
+  <paragraph role="paragraph" id="par_id101626028852152">The <emph>Add Target</emph> dialog appears, to let you define a <emph>Name</emph> for the new target, as well as to choose its <emph>Type</emph> and <emph>Content</emph>. There are three types of targets to choose from in the <emph>Type</emph> dropdown list:</paragraph>
+  <list type="unordered">
+    <listitem>
+        <paragraph id="par_id241626028988544" role="listitem"><emph>Text</emph>: Automatic Redaction will look for all occurrences of the specified text and mark them for redaction.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id31626028992866" role="listitem"><emph>Regular expression</emph>: Define a regular expression to use to search the document. All matches will be marked for redaction.</paragraph>
+    </listitem>
+    <listitem>
+        <paragraph id="par_id391626028994653" role="listitem"><emph>Predefined</emph>: Choose predefined regular expressions to automatically redact contents, such as credit card numbers, email addresses and so on.</paragraph>
+    </listitem>
+  </list>
+
+  <paragraph role="paragraph" id="par_id181626029575406">Add all targets that you want to apply to your document and click <emph>OK</emph>. This opens the document as a drawing in %PRODUCTNAME Draw with all targets automatically redacted with the <emph>Rectangle Redaction</emph> tool.</paragraph>
+  <paragraph role="paragraph" id="par_id611626029791762">Continue redacting other portions of the generated document and then print or export it to PDF.</paragraph>
+  <tip id="par_id581626101004089">Refer to the help page <embedvar href="text/shared/01/02100001.xhp#02100001"/> to learn more about regular expressions.</tip>
+  <h2 id="hd_id951626029985729">Exporting and Importing Targets</h2>
+  <paragraph role="paragraph" id="par_id701626030005749">Click the <emph>Save Targets</emph> button to save all defined targets in the document as a JSON (JavaScript Object Notation) file.</paragraph>
+  <paragraph role="paragraph" id="par_id971626030103135">Click the <emph>Load Targets</emph> button to import and apply the targets defined in a JSON file to another %PRODUCTNAME document.</paragraph>
+  <note id="par_id311626030327293">The document automatic redaction targets are saved alongside the document. Hence, they are available in the document after you save and close it.</note>
+  <section id="relatedtopics">
+    <embed href="text/shared/guide/redaction.xhp#redaction_h1"/>
+    <embed href="text/shared/01/ref_pdf_export.xhp#ref_pdf_export"/>
+  </section>
+</body>
+</helpdocument>
diff --git a/source/text/shared/guide/redaction.xhp b/source/text/shared/guide/redaction.xhp
index 3b73c862e4..aa89dbbeb4 100644
--- a/source/text/shared/guide/redaction.xhp
+++ b/source/text/shared/guide/redaction.xhp
@@ -24,7 +24,7 @@
     </bookmark>
     <section id="redaction01">
         <bookmark id="bm_id981562795247716" xml-lang="en-US" branch="hid/.uno:RedactDoc" localize="false"/>
-        <h1 id="hd_id171562795247717"><link href="text/shared/guide/redaction.xhp" name="redaction">Redacting Documents</link></h1>
+        <h1 id="hd_id171562795247717"><variable id="redaction_h1"><link href="text/shared/guide/redaction.xhp" name="redaction">Redacting Documents</link></variable></h1>
         <paragraph id="par_id471562795247717" role="paragraph" xml-lang="en-US"><variable id="redaction"><ahelp hid=".">Redacting documents blocks out words or portions of a document for authorized use or viewing.</ahelp></variable> Redaction protects sensitive information and helps enterprises and organizations to comply with regulations on confidentiality or privacy.</paragraph>
     </section>
     <section id="howtoget">
@@ -95,6 +95,7 @@
         </tablerow>
     </table>
     <section id="relatedtopics">
+        <embed href="text/shared/guide/auto_redact.xhp#autoredact_h1"/>
         <embed href="text/shared/01/ref_pdf_export.xhp#ref_pdf_export"/>
     </section>
 </body>
author	Rafael Lima <rafael.palma.lima@gmail.com>	2021-07-12 13:33:18 +0200
committer	Olivier Hallot <olivier.hallot@libreoffice.org>	2021-07-12 17:20:22 +0200
commit	e30dc2a0cd25a3c81bfbbcd61283c67ea66e0c32 (patch)
tree	98fe3d85e28c40c37930b4d82466a3ab441e08c7
parent	f7c998f88c2a4666f5d2a440f1449d763e05b85e (diff)