tdf#163053 Add Help page for Comments sidebar panel in Writer

Create a new page text/swriter/01/sidebar_comments.xhp to document the Comments sidebar panel feature.

In AllLangHelp_swriter.mk
- Add new page to repository

In text/shared/01/04050000.xhp
- Add section and variable tags to allow the page to be easily linked and embedded in other pages.

In text/shared/optionen/java.xhp
- Add section and variable tags to allow the page to be easily linked and embedded in other pages.

Change-Id: I782c6483b07cc1b7d7b3566fe4664927740387af
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/175915
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>

3 files changed, 206 insertions, 6 deletions

diff --git a/source/text/shared/01/04050000.xhp b/source/text/shared/01/04050000.xhp
index 33de2cfd78..17c7f4a3b7 100644
--- a/source/text/shared/01/04050000.xhp
+++ b/source/text/shared/01/04050000.xhp
@@ -97,8 +97,12 @@
             <embed href="text/shared/01/04050000.xhp#dropdown"/>
             <bookmark branch="hid/.uno:ReplyComment" id="bm_id0429200810593995" localize="false"/>
             <tip id="par_id0302200901430918">In the <emph>Find &amp; Replace</emph> dialog of text documents, you can select to include the comments texts in your searches.</tip>
-            <h2 id="hd_id601573488847729">Replying to comments</h2>
-            <paragraph id="par_id0305200911090684" role="paragraph">If the comment in a text document was written by another author, there is a <emph>Reply</emph> command in the context menu. <ahelp hid=".">This command inserts a new comment adjacent to the comment to which you want to reply.</ahelp> The comment anchor is the same for both comments. Type your reply text in the new comment. Save and send your document to other authors, then those authors can add replies, too.</paragraph><comment>View - Comments command</comment>
+            <section id="replycomments">
+                <h2 id="hd_id601573488847729"><variable id="replycomments_hd">Replying to comments</variable></h2>
+            <section id="replycomments_content">
+                <paragraph id="par_id0305200911090684" role="paragraph">If the comment in a text document was written by another author, there is a <emph>Reply</emph> command in the context menu. <ahelp hid=".">This command inserts a new comment adjacent to the comment to which you want to reply.</ahelp> The comment anchor is the same for both comments. Type your reply text in the new comment. Save and send your document to other authors, then those authors can add replies, too.</paragraph><comment>View - Comments command</comment>
+                </section>
+            </section>
             <section id="resolvecomments">
             <h2 id="hd_id201573491050815">Marking comments as resolved</h2>
             <paragraph role="paragraph" id="par_id961573491046250">When the document has been reviewed and commented and requires your action in its contents, you can mark the comment  <emph>Resolved</emph> or <emph>Unresolved</emph>. Open the comment context menu or click on the comment dropdown list to mark the Resolved checkbox. When you mark the comment resolved, the word <literal>Resolved</literal> is inserted under the date in the comment box. When marking unresolved, the word <literal>Resolved</literal> is removed.</paragraph>
diff --git a/source/text/shared/optionen/java.xhp b/source/text/shared/optionen/java.xhp
index f8490f81f7..3d27b2fa7c 100644
--- a/source/text/shared/optionen/java.xhp
+++ b/source/text/shared/optionen/java.xhp
@@ -96,10 +96,12 @@
 <paragraph id="par_idN10686" role="paragraph" xml-lang="en-US"><ahelp hid="cui/ui/optadvancedpage/classpath">Opens the <link href="text/shared/optionen/javaclasspath.xhp">Class Path</link> dialog.</ahelp></paragraph>
 
 <h2 id="hd_id3148618">Optional Features</h2>
-
-<h3 id="hd_id3148619"><ahelp hid="cui/ui/optadvancedpage/experimental">Enable experimental features</ahelp></h3>
-<paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">Enables features that are not yet complete or may contain known bugs. The list of these features is different version by version, or even it can be empty.</paragraph>
-
+<section id="enable_experimental_features">
+  <h3 id="hd_id3148619"><ahelp hid="cui/ui/optadvancedpage/experimental"><variable id="enable_experimental_features_hd">Enable experimental features</variable></ahelp></h3>
+  <section id="enable_experimental_features_content">
+    <paragraph id="par_id3156344" role="paragraph" xml-lang="en-US">Enables features that are not yet complete or may contain known bugs. The list of these features is different version by version, or even it can be empty.</paragraph>
+  </section>
+</section>
 <h3 id="hd_id3148610"><ahelp hid="cui/ui/optadvancedpage/macrorecording">Enable macro recording</ahelp></h3>
 <paragraph id="par_id3156345" role="paragraph" xml-lang="en-US">Enables macro recording. The <link href="text/shared/guide/macro_recording.xhp"><item type="menuitem">Tools - Macros - Record Macro</item></link> menu item is available.</paragraph>
 
diff --git a/source/text/swriter/01/sidebar_comments.xhp b/source/text/swriter/01/sidebar_comments.xhp
new file mode 100644
index 0000000000..044d5f2f47
--- /dev/null
+++ b/source/text/swriter/01/sidebar_comments.xhp
@@ -0,0 +1,194 @@
+<?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="textswriter01sidebarcommentsxhp" indexer="include" status="PUBLISH">
+        <title id="tit">Comments Deck</title>
+        <filename>/text/swriter/01/sidebar_comments.xhp</filename>
+    </topic>
+</meta>
+<body>
+<bookmark branch="index" id="bm_id31727446644995">
+    <bookmark_value>sidebar;comments</bookmark_value>
+    <bookmark_value>comments;sidebar</bookmark_value>
+    <bookmark_value>comments;filter</bookmark_value>
+    <bookmark_value>comments;sort</bookmark_value>
+    <bookmark_value>comments;sort by date</bookmark_value>
+    <bookmark_value>comments;sort by position</bookmark_value>
+    <bookmark_value>filter;comments</bookmark_value>
+    <bookmark_value>sort;comments</bookmark_value>
+</bookmark>
+<bookmark branch="hid/SIDEBAR_COMMENTSDECK" id="bm_id601727462675938" localize="false"/>
+<bookmark branch="hid/modules/swriter/ui/commentspanel/@@nowidget@@" id="bm_id731727464045660" localize="false"/>
+<section id="comments">
+    <h1 id="hd_id411727446256926"><variable id="h1"><link href="text/shared/01/sidebar_comments.xhp">Comments</link></variable></h1>
+    <section id="comments_content">
+        <paragraph role="paragraph" id="par_id391727446298797">Use the Comments sidebar deck to view, filter, and sort comments within a document.</paragraph>
+    </section>
+</section>
+<section id="howtoget">
+     <embed href="text/shared/00/00000004.xhp#from_sidebar"/>
+    <table id="tab_id41727464763411">
+        <tablerow>
+            <tablecell>
+                <paragraph id="par_id41727464763411" role="paragraph"><image src="cmd/sc_showannotations.svg" id="img_id481727464763411" width="1cm"  height="1cm"><alt id="alt_id381727464763411">Icon Comments</alt></image></paragraph>
+            </tablecell>
+            <tablecell>
+                <paragraph id="par_id441727464763411" role="paragraph">Comments</paragraph>
+            </tablecell>
+        </tablerow>
+    </table>
+</section>
+<note id="par_id81727707460279">The Comments sidebar deck is an experimental feature. To enable experimental features, open the <link href="text/shared/optionen/01000000.xhp"><menuitem>Options</menuitem></link> dialog, choose <menuitem>%PRODUCTNAME - Advanced</menuitem>, and check the <link href="text/shared/optionen/java.xhp#enable_experimental_features">Enable experimental features</link> checkbox.</note>
+<section id="options">
+    <h2 id="hd_id681727448244687"><variable id="options_hd">Options</variable></h2>
+</section>
+<bookmark branch="hid/modules/swriter/ui/commentspanel/label_filter" id="bm_id281730485997442" localize="false"/>
+<section id="filter">
+    <h2 id="hd_id271727447600253"><variable id="filter_hd">Filter</variable></h2>
+    <section id="filter_content">
+        <paragraph id="par_id31727447600254" role="paragraph">Set filter criteria for the Comments thread.</paragraph>
+</section>
+</section>
+<bookmark branch="hid/modules/swriter/ui/commentspanel/filter_author" id="bm_id41730486057936" localize="false"/>
+<section id="author">
+    <h4 id="hd_id81727447664121"><variable id="author_hd">Author</variable></h4>
+    <section id="author_content">
+        <paragraph id="par_id641727447664121" role="paragraph">Select an author from the combobox to filter comments by author.</paragraph>
+    </section>
+</section>
+<bookmark branch="hid/modules/swriter/ui/commentspanel/filter_date" id="bm_id621730486108431" localize="false"/>
+<section id="date">
+    <h4 id="hd_id901727447668041"><variable id="date_hd">Date</variable></h4>
+    <section id="date_content">
+        <paragraph id="par_id331727447668042" role="paragraph">Use the date picker to view comments from a specific date.</paragraph>
+    </section>
+</section>
+<section id="show">
+    <h3 id="hd_id221727448530765"><variable id="show_hd">Show</variable></h3>
+    <section id="show_content">
+        <paragraph id="par_id511727448530765" role="paragraph"></paragraph>
+    </section>
+</section>
+<bookmark branch="hid/modules/swriter/ui/commentspanel/show_time" id="bm_id901730486200579" localize="false"/>
+<section id="show_time">
+    <h3 id="hd_id761727448534167"><variable id="show_time_hd">Time</variable></h3>
+    <section id="show_time_content">
+        <paragraph id="par_id51727448534167" role="paragraph">Check this box to display the time a comment was made next to the date in the comment thread.</paragraph>
+    </section>
+</section>
+    <bookmark branch="hid/modules/swriter/ui/commentspanel/show_resolved" id="bm_id621729868182794" localize="false"/>
+<section id="resolved">
+    <h3 id="hd_id461727448537638"><variable id="resolved_hd">Resolved</variable></h3>
+    <section id="resolved_content">
+        <paragraph id="par_id611727448537639" role="paragraph">Check this box to show comments that have been resolved in the comments thread.</paragraph>
+    </section>
+</section>
+<bookmark branch="hid/modules/swriter/ui/commentspanel/show_reference" id="bm_id81729868293998" localize="false"/>
+<section id="reference">
+    <h3 id="hd_id271727448541299"><variable id="reference_hd">Reference</variable></h3>
+    <section id="reference_content">
+        <paragraph id="par_id61727448541299" role="paragraph">Check this box to show the text in the document that the comment references.</paragraph>
+    </section>
+</section>
+<section id="sort_by">
+    <h3 id="hd_id941727463655014"><variable id="sort_by_hd">Sort by:</variable></h3>
+    <section id="sort_by_content">
+        <paragraph id="par_id371727463655014" role="paragraph">Choose the order in which comments are displayed in the comments thread.</paragraph>
+    </section>
+    </section>
+    <bookmark branch="hid/modules/swriter/ui/commentspanel/sortby_position" id="bm_id781730486321976" localize="false"/>
+    <section id="position">
+        <h4 id="hd_id361727463660425"><variable id="position_hd">Position</variable></h4>
+        <section id="position_content">
+            <paragraph id="par_id171727463660426" role="paragraph">Sort comments according to their position in the document.</paragraph>
+        </section>
+    </section>
+    <bookmark branch="hid/modules/swriter/ui/commentspanel/sortby_time" id="bm_id891730486358971" localize="false"/>
+    <section id="time">
+        <h4 id="hd_id981727463665076"><variable id="time_hd">Time</variable></h4>
+        <section id="time_content">
+            <paragraph id="par_id971727463665077" role="paragraph">Sort comments according to the time at which they were made.</paragraph>
+        </section>
+    </section>
+    <bookmark branch="hid/modules/swriter/ui/commentspanel/comment_threads" id="bm_id421730486429664" localize="false"/>
+    <section id="comment_threads">
+        <h2 id="hd_id541727708645758"><variable id="comments thread_hd">Comment threads</variable></h2>
+        <section id="comment_threads_content">
+            <paragraph id="par_id161727708645759" role="paragraph">The comment threads panel displays a list of comments in the current document. Click the expander to expand and collapse a comment thread.</paragraph>
+        </section>
+    </section>
+    <section id="reference_text">
+        <h3 id="hd_id211730494219412"><variable id="reference_text_hd">Reference text</variable></h3>
+        <section id="reference_text_content">
+            <paragraph id="par_id871730494219413" role="paragraph">Displays the text in the document that the comment thread is referencing.</paragraph>
+        </section>
+        </section>
+    <bookmark branch="hid/modules/swriter/ui/commentwidget/author_label" id="bm_id351730492195462" localize="false"/>
+    <section id="author_name">
+        <h3 id="hd_id881730492015951"><variable id="author_name_hd">Author name</variable></h3>
+        <section id="author_name_content">
+            <paragraph role="paragraph" id="par_id631730499386905">Displays the name of the comment's author.</paragraph>
+        </section>
+    <bookmark branch="hid/modules/swriter/ui/commentwidget/datelabel" id="bm_id631730492271873" localize="false"/>
+    <section id="date">
+        <h3 id="hd_id491730492314699"><variable id="date_hd">Date</variable></h3>
+        <section id="date_content">
+            <paragraph id="par_id661730492314699" role="paragraph">Displays the date on which the comment was created.</paragraph>
+        </section>
+        <section id="time">
+            <h3 id="hd_id801730492351260"><variable id="time_hd">Time</variable></h3>
+            <section id="time_content">
+                <paragraph id="par_id911730492351261" role="paragraph">Displays the time at which the comment was made. Uncheck the <link href="/text/swriter/01/sidebar_comments.xhp#show_time">Time</link> checkbox to hide this label.</paragraph>
+            </section>
+        </section>
+        </section>
+        <bookmark branch="hid/modules/swriter/ui/commentspanel/modules/swriter/ui/commentwidget/reply_button" id="bm_id801730489969884" localize="false"/>
+    <bookmark branch="hid/modules/swriter/ui/annotation/editview" id="bm_id591730491129349" localize="false"/>
+    <section id="reply">
+        <h3 id="hd_id361727709265112"><variable id="reply_hd">Reply</variable></h3>
+        <section id="reply_content">
+            <paragraph id="par_id981727709265113" role="paragraph">Click the Reply icon above a comment to <link href="text/shared/01/04050000.xhp#replycomments">reply</link> to the comment. Type a comment in the new comment box that appears below the parent comment.</paragraph>
+        </section>
+        <section id="syreply">
+            <table id="tab_id51729863817470">
+                <tablerow>
+                    <tablecell>
+                        <paragraph role="paragraph" id="par_id141729863817470">
+                            <image src="cmd/sc_replycomment.png" id="img_id201729863817470" width="1cm" height="1cm"><alt id="alt_id841729863817471">Icon Reply</alt></image>
+                        </paragraph>
+                    </tablecell>
+                    <tablecell>
+                        <paragraph id="par_id521729863817471" role="paragraph">Reply</paragraph>
+                    </tablecell>
+                </tablerow>
+            </table>
+        </section>
+    </section>
+    <section id="resolve">
+        <h3 id="hd_id871727709268833"><variable id="resolve_hd">Resolve</variable></h3>
+        <section id="resolve_content">
+            <paragraph id="par_id221727709268833" role="paragraph">Check the checkbox to mark the selected comment as <link href="text/shared/01/04050000.xhp#resolvecomments">resolved</link>.</paragraph>
+        </section>
+    </section>
+    <bookmark branch="hid/modules/swriter/ui/commentwidget/resolvebutton" id="bm_id601729868123027" localize="false"/>
+    </section>
+    <bookmark branch="hid/modules/swriter/ui/commentwidget/textview" id="bm_id221730490474746" localize="false"/>
+    <section id="comment_box">
+        <h3 id="hd_id541730490392993"><variable id="comment_box_hd">Comment box</variable></h3>
+        <section id="comment_box_content">
+            <paragraph role="paragraph" id="par_id291730490824507">The comment box displays the text of each comment.</paragraph></section>
+    </section>
+    <section id="relatedtopics">
+        <embed href="text/shared/01/04050000.xhp#h1"/>
+    </section>
+</body>
+</helpdocument>