Package_html_media.mk | 1 source/media/helpimg/swriter/MasterDocuments.png |binary source/text/swriter/guide/globaldoc.xhp | 37 ++++++------ source/text/swriter/guide/globaldoc_howtos.xhp | 70 ++++++++++++----------- 4 files changed, 58 insertions(+), 50 deletions(-)
New commits: commit cf0c6be8bfc13b80cbf549fdcd6cf5ab82934415 Author: Olivier Hallot <[email protected]> AuthorDate: Tue Oct 21 19:11:13 2025 -0300 Commit: Olivier Hallot <[email protected]> CommitDate: Wed Oct 22 19:36:27 2025 +0200 tdf#166355 Missing steps in "Working with Master Documents and Subdocuments" + refactor + Add image about common template Change-Id: Idd37ac435e97ce7d5de43cf74e24f8033fc29dc8 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/192817 Tested-by: Jenkins Reviewed-by: Olivier Hallot <[email protected]> diff --git a/Package_html_media.mk b/Package_html_media.mk index 49ba695072..8ec63cb0e3 100644 --- a/Package_html_media.mk +++ b/Package_html_media.mk @@ -376,6 +376,7 @@ $(eval $(call gb_Package_add_files_with_dir,helpcontent2_html_media,$(LIBO_SHARE helpimg/starmath/un21221.svg \ helpimg/python/python_interactive_console.png \ helpimg/python/python_shell.png \ + helpimg/swriter/MasterDocuments.png \ helpimg/sw_paste_range.png \ helpimg/sw_signatureline01.png \ helpimg/sw_signatureline02.png \ diff --git a/source/media/helpimg/swriter/MasterDocuments.png b/source/media/helpimg/swriter/MasterDocuments.png new file mode 100644 index 0000000000..74d5a8b279 Binary files /dev/null and b/source/media/helpimg/swriter/MasterDocuments.png differ diff --git a/source/text/swriter/guide/globaldoc.xhp b/source/text/swriter/guide/globaldoc.xhp index 3522654df2..fb66a4aea6 100644 --- a/source/text/swriter/guide/globaldoc.xhp +++ b/source/text/swriter/guide/globaldoc.xhp @@ -22,49 +22,52 @@ <meta> <topic id="textswriterguideglobaldocxml" indexer="include" status="PUBLISH"> - <title xml-lang="en-US" id="tit">Master Documents and Subdocuments</title> + <title id="tit">Master Documents and Subdocuments</title> <filename>/text/swriter/guide/globaldoc.xhp</filename> </topic> </meta> <body> -<bookmark xml-lang="en-US" branch="index" id="bm_id3145246"><bookmark_value>master documents;properties</bookmark_value> +<bookmark branch="index" id="bm_id3145246"><bookmark_value>master documents;properties</bookmark_value> <bookmark_value>subdocuments;properties</bookmark_value> <bookmark_value>central documents</bookmark_value> <bookmark_value>subsidiary documents</bookmark_value> <bookmark_value>documents; master documents and subdocuments</bookmark_value> <bookmark_value>styles;master documents</bookmark_value> </bookmark><comment>Mw made "master documents" and "subdocuments" a two level entry, deleted "references;" and "bookmarks;" and added a new entry and shifted "Navigator;" and "indexes;" to the file globaldoc_howtos.xhp</comment> -<paragraph xml-lang="en-US" id="hd_id3145246" role="heading" level="1"><variable id="globaldoc"><link href="text/swriter/guide/globaldoc.xhp">Master Documents and Subdocuments</link> -</variable></paragraph><comment>MW: This file was split into globaldoc.xhp (concepts) and globaldoc_howtos.xhp (procedures)</comment> -<paragraph xml-lang="en-US" id="par_id3149806" role="paragraph">A master document lets you manage large documents, such as a book with many chapters. The master document can be seen as a container for individual <item type="productname">%PRODUCTNAME</item> Writer files. The individual files are called subdocuments.</paragraph> +<h1 id="hd_id3145246"><variable id="globaldoc"><link href="text/swriter/guide/globaldoc.xhp">Master Documents and Subdocuments</link> +</variable></h1><comment>MW: This file was split into globaldoc.xhp (concepts) and globaldoc_howtos.xhp (procedures)</comment> +<description id="par_id3149806">A master document lets you manage large documents, such as a book with many chapters. The master document can be seen as a container for individual Writer files. The individual files are called subdocuments.</description> <h2 id="hd_id6537369">Characteristics of Master Documents</h2> <list type="unordered"> <listitem> - <paragraph xml-lang="en-US" id="par_id3150096" role="paragraph">When you print a master document, the contents of all subdocuments, indexes, and any text that you entered are printed.</paragraph> + <paragraph id="par_id3150096" role="paragraph">When you print a master document, the contents of all subdocuments, indexes, and any text that you entered are printed.</paragraph> </listitem> <listitem> - <paragraph xml-lang="en-US" id="par_id3153400" role="paragraph">You can create a table of contents and index in the master document for all of the subdocuments.</paragraph> + <paragraph id="par_id3153400" role="paragraph">You can create a table of contents and index in the master document for all of the subdocuments.</paragraph> </listitem> <listitem> - <paragraph xml-lang="en-US" id="par_id3155854" role="paragraph">Styles that are used in subdocuments, such as new paragraph styles, are automatically imported into the master document.</paragraph> + <paragraph id="par_id3155854" role="paragraph">Styles that are used in subdocuments, such as new paragraph styles, are automatically imported into the master document.</paragraph> </listitem> <listitem> - <paragraph xml-lang="en-US" id="par_id9033783" role="paragraph">When viewing the master document, styles that are already present in the master document take precedence over styles with the same name that are imported from subdocuments. </paragraph> + <paragraph id="par_id9033783" role="paragraph">When viewing the master document, styles that are already present in the master document take precedence over styles with the same name that are imported from subdocuments. </paragraph> </listitem> <listitem> - <paragraph xml-lang="en-US" id="par_id3419598" role="paragraph">Subdocuments never get changed by changes made to the master document.</paragraph> + <paragraph id="par_id3419598" role="paragraph">Subdocuments never get changed by changes made to the master document.</paragraph> </listitem> </list> - <paragraph xml-lang="en-US" id="par_id3155180" role="note">When you add a document to a master document or create a new subdocument, a link is created in the master document. You cannot edit the content of a subdocument directly in the master document, but you can use the Navigator to open any subdocument for edit.</paragraph> + <note id="par_id3155180">When you add a document to a master document or create a new subdocument, a link is created in the master document. You cannot edit the content of a subdocument directly in the master document, but you can use the Navigator to open any subdocument for edit.</note> <h2 id="hd_id7904904">Example of Using Styles</h2> - <paragraph xml-lang="en-US" id="par_id5817743" role="paragraph">A master document master.odm consists of some text and links to the subdocuments sub1.odt and sub2.odt. In each subdocument a new paragraph style with the same name Style1 is defined and used, and the subdocuments are saved.</paragraph> - <paragraph xml-lang="en-US" id="par_id9169591" role="paragraph">When you save the master document, the styles from the subdocuments are imported into the master document. First, the new style Style1 from the sub1.odt is imported. Next, the new styles from sub2.odt will be imported, but as Style1 now already is present in the master document, this style from sub2.odt will not be imported. </paragraph> - <paragraph xml-lang="en-US" id="par_id1590014" role="paragraph">In the master document you now see the new style Style1 from the first subdocument. All Style1 paragraphs in the master document will be shown using the Style1 attributes from the first subdocument. However, the second subdocument by itself will not be changed. You see the Style1 paragraphs from the second subdocument with different attributes, depending whether you open the sub2.odt document by itself or as part of the master document.</paragraph> - <paragraph xml-lang="en-US" id="par_id5878780" role="tip">To avoid confusion, use the same document template for the master document and its subdocuments. This happens automatically when you create the master document and its subdocuments from an existing document with headings, using the command <emph>File - Send - Create Master Document</emph>.</paragraph> + <paragraph id="par_id5817743" role="paragraph">A master document master.odm consists of some text and links to the subdocuments sub1.odt and sub2.odt. In each subdocument a new paragraph style with the same name Style1 is defined and used, and the subdocuments are saved.</paragraph> + <paragraph id="par_id9169591" role="paragraph">When you save the master document, the styles from the subdocuments are imported into the master document. First, the new style Style1 from the sub1.odt is imported. Next, the new styles from sub2.odt will be imported, but as Style1 now already is present in the master document, this style from sub2.odt will not be imported. </paragraph> + <paragraph id="par_id1590014" role="paragraph">In the master document you now see the new style Style1 from the first subdocument. All Style1 paragraphs in the master document will be shown using the Style1 attributes from the first subdocument. However, the second subdocument by itself will not be changed. You see the Style1 paragraphs from the second subdocument with different attributes, depending whether you open the sub2.odt document by itself or as part of the master document.</paragraph> + <tip id="par_id5878780">To avoid confusion, use the same document template for the master document and its subdocuments. This happens automatically when you create the master document and its subdocuments from an existing document with headings, using the command <emph>File - Send - Create Master Document</emph>.</tip> + <paragraph role="paragraph" id="par_id1001761081482766"> + <image src="media/helpimg/swriter/MasterDocuments.png" id="img_id961761081482769" width="412px" height="692px"><alt id="alt_id271761081482771">Master Document Structure</alt></image> + </paragraph> <section id="relatedtopics"> <embed href="text/swriter/guide/globaldoc_howtos.xhp#globaldoc_howtos"/> <embed href="text/swriter/guide/indices_multidoc.xhp#indices_multidoc"/> - <paragraph xml-lang="en-US" id="par_id3154382" role="paragraph"><link href="text/shared/01/02110000.xhp">Navigator in master mode</link></paragraph> + <paragraph id="par_id3154382" role="paragraph"><link href="text/shared/01/02110000.xhp">Navigator in master mode</link></paragraph> </section> </body> -</helpdocument> \ No newline at end of file +</helpdocument> diff --git a/source/text/swriter/guide/globaldoc_howtos.xhp b/source/text/swriter/guide/globaldoc_howtos.xhp index 679ed25779..db4aa955f6 100644 --- a/source/text/swriter/guide/globaldoc_howtos.xhp +++ b/source/text/swriter/guide/globaldoc_howtos.xhp @@ -20,14 +20,14 @@ <meta> <topic id="textswriterguideglobaldoc_howtosxml" indexer="include" status="PUBLISH"> - <title id="tit" xml-lang="en-US">Working with Master Documents and Subdocuments</title> + <title id="tit">Working with Master Documents and Subdocuments</title> <filename>/text/swriter/guide/globaldoc_howtos.xhp</filename> </topic> </meta> <body> -<bookmark xml-lang="en-US" branch="index" id="bm_id3145246"> +<bookmark branch="index" id="bm_id3145246"> <bookmark_value>Navigator;master documents</bookmark_value> <bookmark_value>master documents;creating/editing/exporting</bookmark_value> <bookmark_value>subdocuments;creating/editing/removing</bookmark_value> @@ -37,114 +37,118 @@ <comment>MW created 4 new index entries. 2 index entries were taken from globaldoc.xhp.</comment><comment>MW made one index entry out of 2 "subdocuments;" entries</comment> <h1 id="hd_id3145246"><variable id="globaldoc_howtos"><link href="text/swriter/guide/globaldoc_howtos.xhp">Working with Master Documents and Subdocuments</link></variable></h1><comment>MW: this is a new guide created from splitting globaldoc.xhp</comment> -<paragraph id="par_id1522873" role="paragraph" xml-lang="en-US">A master document lets you manage large documents, such as a book with many chapters. The master document can be seen as a container for individual <item type="productname">%PRODUCTNAME</item> Writer files. The individual files are called subdocuments.</paragraph> +<description id="par_id1522873">A master document lets you manage large documents, such as a book with many chapters. The master document can be seen as a container for individual Writer files. The individual files are called subdocuments.</description> <h2 id="hd_id3153127">To Create a Master Document</h2> <list type="ordered"> <listitem> - <paragraph id="par_id3149634" role="listitem" xml-lang="en-US">Do one of the following:</paragraph> + <paragraph id="par_id3149634" role="listitem">Do one of the following:</paragraph> </listitem> </list> <list type="unordered"> <listitem> - <paragraph id="par_id3149956" role="listitem" xml-lang="en-US">Choose <emph>File - New - Master Document</emph>.</paragraph> + <paragraph id="par_id3149956" role="listitem">Choose <emph>File - New - Master Document</emph>.</paragraph> </listitem> <listitem> - <paragraph id="par_id3149612" role="listitem" xml-lang="en-US">Open an existing document and choose <emph>File - Send - Create Master Document</emph>.</paragraph> - </listitem></list> + <paragraph id="par_id3149612" role="listitem">Open an existing document and choose <emph>File - Send - Create Master Document</emph>.</paragraph> + </listitem> +</list> <list type="ordered" startwith="2"> <listitem> - <paragraph id="par_id3149873" role="listitem" xml-lang="en-US">If you are creating a new master document, the first entry in the Navigator should be a <item type="menuitem">Text</item> entry. Type an introduction or enter some text. This ensures that after having edited an existing style in the master document, you see the changed style when viewing the subdocuments.</paragraph> + <paragraph id="par_id3149873" role="listitem">If you are creating a new master document, the first entry in the Navigator should be a <item type="menuitem">Text</item> entry. Type an introduction or enter some text. This ensures that after having edited an existing style in the master document, you see the changed style when viewing the subdocuments.</paragraph> </listitem> <listitem> - <paragraph id="par_id3145114" role="listitem" xml-lang="en-US">In the <item type="menuitem">Navigator</item> for master documents (should open automatically, else press F5 to open), click and hold the <item type="menuitem">Insert</item> icon, and do one of the following:</paragraph> + <paragraph id="par_id3145114" role="listitem">In the <link href="text/shared/01/02110000.xhp"><menuitem>Navigator</menuitem> for master documents</link> (should open automatically, else press F5 to open), click and hold the <item type="menuitem">Insert</item> icon, and do one of the following:</paragraph> </listitem> </list> <list type="unordered"> <listitem> - <paragraph id="par_id3156240" role="listitem" xml-lang="en-US">To insert an existing file as a subdocument, choose <menuitem>File</menuitem>, locate the file that you want to include, and then click <emph>Open</emph>.</paragraph> + <paragraph id="par_id3156240" role="listitem">To insert an existing file as a subdocument, choose <menuitem>File</menuitem>, locate the file that you want to include, and then click <emph>Open</emph>.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id3145405" role="listitem">To create a new subdocument, choose <emph>New Document</emph>, type a name for the file, and then click <emph>Save</emph>.</paragraph> </listitem> <listitem> - <paragraph id="par_id3145405" role="listitem" xml-lang="en-US">To create a new subdocument, choose <emph>New Document</emph>, type a name for the file, and then click <emph>Save</emph>.</paragraph> + <paragraph id="par_id891761079930672" role="listitem">To create an index, choose <menuitem>Index</menuitem>, and set the index configuration in the <link href="text/swriter/01/04120211.xhp">Table of Contents, Index or Bibliography</link> dialog.</paragraph> </listitem> <listitem> - <paragraph id="par_id8550981" role="listitem" xml-lang="en-US">To insert some text between subdocuments, choose <emph>Text</emph>. Then type the text. You cannot insert text next to an existing text entry in the Navigator.<comment>i81372</comment></paragraph> + <paragraph id="par_id8550981" role="listitem">To insert some text between subdocuments, choose <emph>Text</emph>. Then type the text. You cannot insert text next to an existing text entry in the Navigator.<comment>i81372</comment></paragraph> </listitem></list> <list type="ordered" startwith="4"> <listitem> - <paragraph id="par_id3153382" role="listitem" xml-lang="en-US">Choose <emph>File - Save</emph>.</paragraph> + <paragraph id="par_id3153382" role="listitem">Choose <emph>File - Save</emph>.</paragraph> </listitem> </list> <h2 id="hd_id3154242">To Edit a Master Document</h2> -<paragraph id="par_id3154255" role="paragraph" xml-lang="en-US">Use the Navigator for rearranging and editing the subdocuments in a master document.</paragraph> +<paragraph id="par_id3154255" role="paragraph">Use the Navigator for rearranging and editing the subdocuments in a master document.</paragraph> <list type="unordered"> <listitem> - <paragraph id="par_id3155879" role="listitem" xml-lang="en-US">To open a subdocument for editing, double-click the name of the subdocument in the Navigator.</paragraph> + <paragraph id="par_id3155879" role="listitem">To open a subdocument for editing, double-click the name of the subdocument in the Navigator.</paragraph> </listitem></list> <list type="unordered"> <listitem> - <paragraph id="par_id3155931" role="listitem" xml-lang="en-US">To remove a subdocument from the master document, right-click the subdocument in the Navigator list and choose <emph>Delete</emph>. The subdocument file is not deleted, only the entry in the Navigator is removed.</paragraph> + <paragraph id="par_id3155931" role="listitem">To remove a subdocument from the master document, right-click the subdocument in the Navigator list and choose <emph>Delete</emph>. The subdocument file is not deleted, only the entry in the Navigator is removed.</paragraph> </listitem></list> <list type="unordered"> <listitem> - <paragraph id="par_id3148677" role="listitem" xml-lang="en-US">To add text to a master document, right-click an item in the Navigator list, and then choose <emph>Insert - Text</emph>. A text section is inserted before the selected item in the master document where you can type the text that you want. You cannot insert text next to an existing text entry in the Navigator.<comment>i81372</comment></paragraph> + <paragraph id="par_id3148677" role="listitem">To add text to a master document, right-click an item in the Navigator list, and then choose <emph>Insert - Text</emph>. A text section is inserted before the selected item in the master document where you can type the text that you want. You cannot insert text next to an existing text entry in the Navigator.<comment>i81372</comment></paragraph> </listitem></list> <list type="unordered"> <listitem> - <paragraph id="par_id3149982" role="listitem" xml-lang="en-US">To reorder the subdocuments in a master document, drag a subdocument to a new location in the Navigator list. You can also select a subdocument in the list, and click the <item type="menuitem">Move down</item> or <item type="menuitem">Move up</item> icon.</paragraph> + <paragraph id="par_id3149982" role="listitem">To reorder the subdocuments in a master document, drag a subdocument to a new location in the Navigator list. You can also select a subdocument in the list, and click the <item type="menuitem">Move down</item> or <item type="menuitem">Move up</item> icon.</paragraph> </listitem></list> <list type="unordered"> <listitem> - <paragraph id="par_id3153022" role="listitem" xml-lang="en-US">To add an index, such as a table of contents, right-click in the Navigator list, and then choose <emph>Insert - Index</emph>.</paragraph> + <paragraph id="par_id3153022" role="listitem">To add an index, such as a table of contents, right-click in the Navigator list, and then choose <emph>Insert - Index</emph>.</paragraph> </listitem></list> <table id="tbl_id3154206"> <tablerow> <tablecell> - <paragraph id="par_id3148949" role="paragraph" xml-lang="en-US"> <image id="img_id3148959" src="sw/res/sc20246.png" width="0.473cm" height="0.473cm"><alt xml-lang="en-US" id="alt_id3148959">Icon</alt></image></paragraph> + <paragraph id="par_id3148949" role="paragraph"> <image id="img_id3148959" src="sw/res/sc20246.png" width="0.473cm" height="0.473cm"><alt id="alt_id3148959">Icon</alt></image></paragraph> </tablecell> <tablecell> - <paragraph id="par_id3153632" role="paragraph" xml-lang="en-US">To update an index in a master document, select the index in the Navigator, and then click the <emph>Update</emph> icon.</paragraph> + <paragraph id="par_id3153632" role="paragraph">To update an index in a master document, select the index in the Navigator, and then click the <emph>Update</emph> icon.</paragraph> </tablecell> </tablerow> </table> -<paragraph id="par_idN10C40" role="note" xml-lang="en-US">When you insert an object like a frame or a picture into a master document, do not anchor the object "to page". Instead, set the anchor "to paragraph" on the <emph>Format - (Object type) - Type</emph> tab page, and then set the object's position relative to "Entire Page" in the <emph>Horizontal</emph> and <emph>Vertical</emph> list boxes.</paragraph> +<note id="par_idN10C40">When you insert an object like a frame or a picture into a master document, do not anchor the object "to page". Instead, set the anchor "to paragraph" on the <emph>Format - (Object type) - Type</emph> tab page, and then set the object's position relative to "Entire Page" in the <emph>Horizontal</emph> and <emph>Vertical</emph> list boxes.</note> <h3 id="hd_id3153656">To Start Each Subdocument on a New Page</h3> <list type="ordered"> <listitem> - <paragraph id="par_id3152760" role="listitem" xml-lang="en-US">Ensure that each subdocument starts with a heading that uses the same paragraph style, for example "Heading 1".</paragraph> + <paragraph id="par_id3152760" role="listitem">Ensure that each subdocument starts with a heading that uses the same paragraph style, for example "Heading 1".</paragraph> </listitem> <listitem> - <paragraph id="par_id3153876" role="listitem" xml-lang="en-US">In the master document, choose <emph>View - Styles</emph>, and click the <emph>Paragraph Styles</emph> icon.</paragraph> + <paragraph id="par_id3153876" role="listitem">In the master document, choose <emph>View - Styles</emph>, and click the <emph>Paragraph Styles</emph> icon.</paragraph> </listitem> <listitem> - <paragraph id="par_id3153907" role="listitem" xml-lang="en-US">Right-click "Heading 1" and choose <emph>Modify</emph>.</paragraph> + <paragraph id="par_id3153907" role="listitem">Right-click "Heading 1" and choose <emph>Modify</emph>.</paragraph> </listitem> <listitem> - <paragraph id="par_id3147124" role="listitem" xml-lang="en-US">Click the <item type="menuitem">Text Flow</item> tab.</paragraph> + <paragraph id="par_id3147124" role="listitem">Click the <item type="menuitem">Text Flow</item> tab.</paragraph> </listitem> <listitem> - <paragraph id="par_id3149770" role="listitem" xml-lang="en-US">In the <item type="menuitem">Breaks</item> area, select <item type="menuitem">Insert</item>, and then select “Page”in the <item type="menuitem">Type</item> box.</paragraph> + <paragraph id="par_id3149770" role="listitem">In the <item type="menuitem">Breaks</item> area, select <item type="menuitem">Insert</item>, and then select “Page”in the <item type="menuitem">Type</item> box.</paragraph> </listitem> <listitem> - <paragraph id="par_id3150224" role="listitem" xml-lang="en-US">If you want each subdocument to start on an odd page, select <emph>With Page Style</emph>, and select "Right page" in the box.</paragraph> + <paragraph id="par_id3150224" role="listitem">If you want each subdocument to start on an odd page, select <emph>With Page Style</emph>, and select "Right page" in the box.</paragraph> </listitem> <listitem> - <paragraph id="par_id3145205" role="listitem" xml-lang="en-US">Click <emph>OK</emph>.</paragraph> + <paragraph id="par_id3145205" role="listitem">Click <emph>OK</emph>.</paragraph> </listitem> </list> @@ -152,18 +156,18 @@ <list type="ordered"> <listitem> - <paragraph id="par_id3150315" role="listitem" xml-lang="en-US">Choose <item type="menuitem">File - Export</item>.</paragraph> + <paragraph id="par_id3150315" role="listitem">Choose <item type="menuitem">File - Export</item>.</paragraph> </listitem> <listitem> - <paragraph id="par_id3148580" role="listitem" xml-lang="en-US">In the <emph>Save as type</emph> list, select a text document file format and click <emph>Save</emph>.</paragraph> + <paragraph id="par_id3148580" role="listitem">In the <emph>Save as type</emph> list, select a text document file format and click <emph>Save</emph>.</paragraph> </listitem> </list> -<paragraph id="par_id8371227" role="note" xml-lang="en-US">The subdocuments will be exported as sections. Use <item type="menuitem">Format - Sections</item> to unprotect and remove sections, if you prefer a plain text document without sections.</paragraph> +<note id="par_id8371227">The subdocuments will be exported as sections. Use <item type="menuitem">Format - Sections</item> to unprotect and remove sections, if you prefer a plain text document without sections.</note> <section id="relatedtopics"> <embed href="text/swriter/guide/globaldoc.xhp#globaldoc"/> <embed href="text/swriter/guide/indices_multidoc.xhp#indices_multidoc"/> -<paragraph id="par_id3154382" role="paragraph" xml-lang="en-US"><link href="text/shared/01/02110000.xhp">Navigator in master mode</link></paragraph> +<paragraph id="par_id3154382" role="paragraph"><link href="text/shared/01/02110000.xhp">Navigator in master mode</link></paragraph> </section> </body>
