Add reports and media to master.
[working/Evergreen.git] / reports / report-folder.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="folder" xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="EN"\r
3     xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">\r
4  <info>\r
5         <title>Folders</title>\r
6     </info>\r
7     <para>There are three main components to reports: <guilabel>Templates</guilabel>, <guilabel>Reports</guilabel>, and <guilabel>Output</guilabel>. Each of these\r
8         components must be stored in a folder.  Folders can be private (accessible to your login only) or shared with other staff at your library, other libraries in your system or consortium. It is also possible to selectively share only certain folders and/or subfolders. </para>\r
9 \r
10     <informalfigure>\r
11         <para>There are two parts to the folders pane. The <guilabel>My Folders</guilabel> section\r
12             contains folders created with your Evergreen account. Folders that other users have\r
13             shared with you appear in the <guilabel>Shared Folders</guilabel> section under the username of the sharing account.</para>\r
14        \r
15         <para>\r
16             <mediaobject>\r
17                 <alt>Screenshot of reports interface</alt>\r
18                 <imageobject>\r
19                     <imagedata scalefit="0" fileref="../media/folder-1.png"/>\r
20                 </imageobject>\r
21             </mediaobject>\r
22         </para>\r
23     </informalfigure>\r
24 \r
25 \r
26     <section xml:id="report-folder-creating">\r
27 \r
28         <info>\r
29             <title>Creating Folders</title>\r
30         </info>\r
31         <para>Whether you are creating a report from scratch or working from a shared template you must first create at least one folder.</para>\r
32         \r
33         <para>The steps for creating folders are similar for each reporting function. It is easier\r
34             to create folders for templates, reports, and output all at once at the beginning, though it is\r
35             possible to do it before each step. This example demonstrates creating a folder for a template. </para>\r
36 \r
37 \r
38         <procedure>\r
39             <step>\r
40                     <para>Click on <guilabel>Templates</guilabel> in the <guilabel>My Folders section</guilabel>. </para>\r
41                 </step>\r
42 \r
43             <step>\r
44                     <para>Name the folder. Select <guimenuitem>Share</guimenuitem> or\r
45                             <guimenuitem>Do not share</guimenuitem> from the dropdown menu.</para>\r
46             </step>\r
47 \r
48             <step>\r
49                     <para>If you want to share your folder, select who you want to share this folder\r
50                         with from the dropdown menu. </para>\r
51             </step>\r
52 \r
53             <step>\r
54               \r
55                     <para>Click <guibutton>Create Sub Folder</guibutton>. </para>\r
56             </step>\r
57         <step>\r
58                     <para>Click <guibutton>OK</guibutton>.</para>\r
59           </step>\r
60 \r
61             <step>\r
62                     <para>Next, create a folder for the report definition to be saved to. Click on\r
63                             <guilabel>Reports</guilabel>.</para>\r
64             </step>\r
65             <step>\r
66                 <para>Repeat steps 2-5 to create a <guilabel>Reports</guilabel> folder also called <guilabel>Circulation</guilabel>. </para>\r
67             </step>\r
68             <step>\r
69              \r
70                     <para>Finally, you need to create a folder for the report’s output to be saved\r
71                         in. Click on <guilabel> Output</guilabel>.</para>\r
72             </step>\r
73         <step>\r
74                 <para>Repeat steps 2-5 to create an <guilabel>Output</guilabel> folder named <guilabel>Circulation</guilabel>.</para>\r
75             </step>\r
76         </procedure>\r
77         <tip>\r
78                 <para>Using a parallel naming scheme for folders in <guilabel>Templates</guilabel>, <guilabel>Reports</guilabel>, and <guilabel>Output</guilabel> helps keep your reports organized and easier to find</para>\r
79         </tip>\r
80             <para>The folders you just created will now be visible by clicking the arrows in\r
81                 <guilabel>My Folders</guilabel>. Bracketed after the folder name is whom the\r
82                 folder is shared with. For example, <guilabel>Circulation (BNCLF)</guilabel>\r
83                 is shared with the North Coast Library Federation.\r
84                 If it is not a shared folder there will be nothing after the folder name.  You may create as many folders and sub-folders as you like.</para>\r
85     </section>\r
86     <section xml:id="report-managing-folder">\r
87         <info>\r
88             <title>Managing Folders</title>\r
89         </info>\r
90         <para>Once a folder has been created you can change the name, delete it, create a new\r
91             subfolder, or change the sharing settings. This example demonstrates changing a folder name; the\r
92             other choices follow similar steps</para>\r
93         <procedure>\r
94             <step>\r
95               <para>Click on the folder that you wish to rename.</para>\r
96          </step>\r
97 \r
98             <step>\r
99                 <para>Click <guilabel>Manage Folder</guilabel>. </para>\r
100             </step>\r
101             <step>\r
102                <para>Select <guimenuitem>Change folder name</guimenuitem> from the dropdown menu\r
103                     and click <guibutton>Go</guibutton>. </para>\r
104             </step>\r
105 \r
106             <step>\r
107                <para>Enter the new name and click <guibutton>Submit</guibutton></para>\r
108             </step>\r
109 \r
110             <step>\r
111                 <para>Click <guibutton>OK</guibutton>. </para>\r
112             </step>\r
113 \r
114             <step>\r
115                <para>You will get a confirmation box that the Action Succeeded. Click\r
116                         <guibutton>OK</guibutton>.</para>\r
117              </step>\r
118         </procedure>\r
119     </section>\r
120 </chapter>\r