[office/calligraplan] doc/plan: Improve docs

Dag Andersen null at kde.org
Mon Jul 11 10:35:52 BST 2022


Git commit c57ee299bbd05d2640deb0166104af35ae3f5b5a by Dag Andersen.
Committed on 11/07/2022 at 09:34.
Pushed by danders into branch 'master'.

Improve docs

M  +26   -1    doc/plan/managingresources.docbook

https://invent.kde.org/office/calligraplan/commit/c57ee299bbd05d2640deb0166104af35ae3f5b5a

diff --git a/doc/plan/managingresources.docbook b/doc/plan/managingresources.docbook
index c37911e7..e4f13b9c 100644
--- a/doc/plan/managingresources.docbook
+++ b/doc/plan/managingresources.docbook
@@ -1,10 +1,35 @@
 <sect2 id="description"><title>Description</title>
   <para>You can create resources for a project using the <link linkend="resource-editor">Resource Editor</link> and <link linkend="work-and-vacation-editor">Work and Vacation Editor</link>.
   </para>
-  <para>However, if you are going to use the same resources in many projects (which is often the case) it is more convenient to maintain resources in a separate file. The best way to do this is to create your resources file first and then set up &plan; to always load this file when creating a new project.
+  <para>However, if you are going to use the same resources in many projects (which is often the case) it is more convenient to maintain resources in a separate file.
+  The best way to do this is to create your resources file first and then set up &plan; to always load this file when creating a new project.
+  </para>
+</sect2>
+<sect2 id="shared-resources"><title>Shared Resources</title>
+  <para>Shared Resources are resources that can be shared between project and thus facilitates resource levelling across projects.
   </para>
   <para>If you are managing projects that use totally different resource pools you can create multiple resource files, but one project can only refer to one resource file.
   </para>
   <para>You can select the resource file to use when creating a new project.
+  The resources can be automatically loaded on opening your project or you can update manually by selecting
+  <menuchoice><guimenu>Tools</guimenu><guimenuitem>Update Shared Resources</guimenuitem></menuchoice>.
+  </para>
+  <para>Note that the project can still be opened even if the resource file is not available.
+  </para>
+  <para>If anything has been deleted in the shared resource file, you will be presented with a dialog where you can select how to treat the deleted items.
+  </para>
+  <para>
+  You can select if an item shall be:
+  <itemizedlist>
+  <listitem><para><emphasis>Removed:</emphasis> Removes the item from your project.
+  This is the action you would normally select as it keeps your project in sync with the resource file.
+  However if the item is used in your project, you may want to convert to a local item.</para>
+  </listitem>
+  <listitem><para><emphasis>Converted:</emphasis> Converts the item to local item.</para>
+  </listitem>
+  <listitem><para><emphasis>Kept:</emphasis> Keeps the item as a shared item in your project.
+  Next time the resource file is loaded, you will be asked again how to treat the item.</para>
+  </listitem>
+  </itemizedlist>
   </para>
 </sect2>



More information about the kde-doc-english mailing list