~ubuntu-branches/debian/sid/kxstitch/sid

« back to all changes in this revision

Viewing changes to doc/en/dialogs.docbook

  • Committer: Bazaar Package Importer
  • Author(s): eric pareja
  • Date: 2005-02-19 12:37:22 UTC
  • Revision ID: james.westby@ubuntu.com-20050219123722-kt3ru1nqvllietee
Tags: upstream-0.6
ImportĀ upstreamĀ versionĀ 0.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<chapter id="Dialogs">
 
2
  <title>Dialogs</title>
 
3
  <sect1 id="AddColorDialog" >
 
4
    <title>The Add Color Dialog</title>
 
5
    <para>
 
6
      <screenshot>
 
7
        <mediaobject>
 
8
          <imageobject>
 
9
            <imagedata fileref="addcolor.png" format="PNG" />
 
10
          </imageobject>
 
11
        </mediaobject>
 
12
      </screenshot>
 
13
    </para>
 
14
    <para>
 
15
      The displayed list is all the colors that are currently available for the selected scheme.
 
16
      New colors may be added using the 'New Color' button.
 
17
    </para>
 
18
    <para>
 
19
      The colors can be selected singularly with the &LMB;, utilising the <keycap>Ctrl</keycap> key to select
 
20
      multiple seperate colors, or in groups using the <keycap>Shift</keycap> key.
 
21
    </para>
 
22
    <para>
 
23
      If you select a color by accident, you can deselect it using the <keycap>Ctrl</keycap> key and the &LMB;.
 
24
    </para>
 
25
  </sect1>
 
26
  
 
27
  <sect1 id="NewColorDialog" >
 
28
    <title>The New Color Dialog</title>
 
29
    <para>
 
30
      <screenshot>
 
31
        <mediaobject>
 
32
          <imageobject>
 
33
            <imagedata fileref="newcolor.png" format="PNG" />
 
34
          </imageobject>
 
35
        </mediaobject>
 
36
      </screenshot>
 
37
    </para>
 
38
    <para>
 
39
      The dialog shows the name of the scheme that the new color will be added to. The color requires a name
 
40
      and a description, which can be anything you want, although color name will usually be defined by the
 
41
      floss manufacturer.
 
42
    </para>
 
43
    <para>
 
44
      Clicking on the Color button will show a standard KDE color selection dialog. The initial color can be
 
45
      selected and then the parameters can be adjusted to give the correct color.
 
46
    </para>
 
47
    <para>
 
48
      Once added this new color will be available to be included in your patterns palette via the 'Add Color'
 
49
      dialog. It may also be adjusted by using the 'Floss Calibration' dialog.
 
50
    </para>
 
51
  </sect1>
 
52
  
 
53
  <sect1 id="DeleteColorDialog" >
 
54
    <title>The Delete Color Dialog</title>
 
55
    <para>
 
56
      <screenshot>
 
57
        <mediaobject>
 
58
          <imageobject>
 
59
            <imagedata fileref="delcolor.png" format="PNG" />
 
60
          </imageobject>
 
61
        </mediaobject>
 
62
      </screenshot>
 
63
    </para>
 
64
    <para>
 
65
      This is essentially the same as the 'Add Color' dialog, although the 'New Color' button is not
 
66
      available. Color selection is the same, but colors that are currently used in the pattern are greyed out
 
67
      and are not available for selection.
 
68
    </para>
 
69
  </sect1>
 
70
  
 
71
  <sect1 id="CalibrateDialog" >
 
72
    <title>The Floss Calibration Dialog</title>
 
73
    <para>
 
74
      <screenshot>
 
75
        <mediaobject>
 
76
          <imageobject>
 
77
            <imagedata fileref="calcolor.png" format="PNG" />
 
78
          </imageobject>
 
79
        </mediaobject>
 
80
      </screenshot>
 
81
    </para>
 
82
    <para>
 
83
      This dialog has two parts.
 
84
    </para>
 
85
    <para>
 
86
      On the left, a pick list of the schemes that are currently available along with a list of colors that
 
87
      are in that scheme.  The color description will be appended with '(Calibrated)' if the color has been
 
88
      modified by the current invocation of this dialog.
 
89
    </para>
 
90
    <para>
 
91
      On the right, is the name and description of the currently selected color, this will be appended with
 
92
      '(Modified)' if the color has been modified, a preview of the color, and the current RGB values for the color.
 
93
    </para>
 
94
    <para>
 
95
      Also shown is a 'Reset Color' button. This will reset the currently selected color to the value it had
 
96
      when the dialog was first invoked.
 
97
    </para>
 
98
    <para>
 
99
      Pressing the 'OK' button will commit all of the changed colors.
 
100
    </para>
 
101
    <para>
 
102
      Pressing the 'Cancel' button will restore all the changed colors back to thier original values.
 
103
    </para>
 
104
  </sect1>
 
105
  
 
106
  <sect1 id="ConfigurationDialog" >
 
107
    <title>The Configuration Dialog</title>
 
108
    <para>
 
109
      <screenshot>
 
110
        <mediaobject>
 
111
          <imageobject>
 
112
            <imagedata fileref="config.png" format="PNG" />
 
113
          </imageobject>
 
114
        </mediaobject>
 
115
      </screenshot>
 
116
    </para>
 
117
    <para>
 
118
      This dialog lets you configure some of the &kapp; display parameters.
 
119
    </para>
 
120
    <para>
 
121
      Most of the options are self explanatory.  The check boxes enable or disable the display of various
 
122
      elements. The pick lists allow selection of the required format of those elements.
 
123
    </para>
 
124
    <para>
 
125
      The cell size value is the size of a grid square in screen pixels. The grouping value is the number
 
126
      of squares in a major group, ie between the heavier lines.  It may be necessary to change the grid line
 
127
      colors if you work on dark materials and have set the patterns background color accordingly.
 
128
    </para>
 
129
    <para>
 
130
      The scale size is the width of the border in screen pixels.  You may need to adjust this if you have
 
131
      large patterns and want to see the full text of the scales.
 
132
    </para>
 
133
  </sect1>
 
134
  
 
135
  <sect1 id="ImportImageDlg" >
 
136
    <title>The Import Image Dialog</title>
 
137
    <para>
 
138
      <screenshot>
 
139
        <mediaobject>
 
140
          <imageobject>
 
141
            <imagedata fileref="import.png" format="PNG" />
 
142
          </imageobject>
 
143
        </mediaobject>
 
144
      </screenshot>
 
145
    </para>
 
146
    <para>
 
147
      On the left of the dialog there is a preview of the imported image, based on the parameters on the right.
 
148
    </para>
 
149
    <para>
 
150
      The floss scheme for the finished pattern can be selected, by default this is the same as the 'New
 
151
      Pattern Dialog' defaults. The maximum colors to be used for the pattern can be enabled and changed as
 
152
      required, by default the imported pattern will have as many colors as are defined in the original image
 
153
      that are converted to floss colors.
 
154
    </para>
 
155
    <para>
 
156
      The cloth count value defaults to the 'New Pattern Properties' dialog and the scale is set such that
 
157
      the final size is as close to the 'New Pattern Properties' pattern size as possible. These values can be
 
158
      changed as required.
 
159
    </para>
 
160
    <para>
 
161
      Clicking 'Import' will convert the image into a pattern.
 
162
    </para>
 
163
  </sect1>
 
164
  
 
165
  <sect1 id="PatternPropertiesDialog" >
 
166
    <title>The Pattern Properties Dialog</title>
 
167
    <para>
 
168
      <screenshot>
 
169
        <mediaobject>
 
170
          <imageobject>
 
171
            <imagedata fileref="properties.png" format="PNG" />
 
172
          </imageobject>
 
173
        </mediaobject>
 
174
      </screenshot>
 
175
    </para>
 
176
    <para>
 
177
      The pattern size can be defined in units of stitches, centimeters or inches.
 
178
      The width and height values will updated automatically to the equivilent size in the new unit type if
 
179
      the units type is changed.
 
180
    </para>
 
181
    <para>
 
182
      The cloth count is defined in units per centimeter or inches and is dependant on the units of size.
 
183
      ie. if CM is selected for the units then cloth count will be in units per centimeter, similarly for inches.
 
184
      if the Stitches unit is selected then the cloth count units will remain as the last CM or inches value.
 
185
    </para>
 
186
    <para>
 
187
      The Title, Author, Copyright and Fabric fields are free text, so you can enter anything you like
 
188
      here. The fabric color can be set by pressing the color button and selecting the required color. This will
 
189
      then be shown in the editor and preview windows.
 
190
    </para>
 
191
    <para>
 
192
      The floss scheme has a pick list for all the available floss schemes, including any that you have
 
193
      defined yourself.
 
194
    </para>
 
195
    <para>
 
196
      The 'Set as default' checkbox will save the current values which will then be used as defaults
 
197
      for all new patterns.
 
198
    </para>
 
199
    <para>
 
200
      The Instructions tab can be used to enter any specific instructions for sewing the pattern.
 
201
    </para>
 
202
  </sect1>
 
203
  
 
204
  <sect1 id="PatternLibraryDialog" >
 
205
    <title>The Pattern Library Dialog</title>
 
206
    <para>
 
207
      <screenshot>
 
208
        <mediaobject>
 
209
          <imageobject>
 
210
            <imagedata fileref="inslib.png" format="PNG" />
 
211
          </imageobject>
 
212
        </mediaobject>
 
213
      </screenshot>
 
214
    </para>
 
215
    <para>
 
216
      The Pattern Library Manager has a hierarchical tree view (more of a forest really) of catagories
 
217
      on the left with an icon view of the selected catagory of patterns on the right.
 
218
    </para>
 
219
    <para>
 
220
      Moving the mouse over one of the pattern icons will pop up a tooltip showing the floss scheme, size
 
221
      and number of colors in the library pattern. Currently it is only possible to incorporate library
 
222
      patterns of the same scheme as the current pattern.
 
223
    </para>
 
224
    <para>
 
225
      Selecting an icon will enable the Insert button, which can then be clicked to insert the library
 
226
      pattern. Alternatively the icon can be double clicked to insert it.
 
227
    </para>
 
228
    <para>
 
229
      When the dialog has closed, press the &LMB; on the editor window roughly where you want
 
230
      the library pattern to be placed. This will show you a preview of the library pattern on the current pattern.
 
231
      Move the mouse to adjust the position of the preview, then release the &LMB; to place the
 
232
      library pattern.
 
233
    </para>
 
234
    <para>
 
235
      This method is exactly the same as using the Paste command. Similarly, the pasted pattern will overwrite
 
236
      the paste area. Alternatively press the <keycap>Ctrl</keycap> key when releasing the mouse button will merge
 
237
      the library pattern with the current pattern.
 
238
    </para>
 
239
    <para>
 
240
      When creating a new library pattern, the dialog is essentially the same.  The differences are that the
 
241
      Insert button has changed to an Add button and the icon view only shows an icon of the pattern being added.
 
242
    </para>
 
243
    <para>
 
244
      Navigate through the tree as required and select the catagory that you want to add the new pattern to.
 
245
      If you want a new catagory, press the &RMB; and select the 'New Catagory' option from the
 
246
      context menu. Fill in the name of the catagory and press OK. If there is no catagory currently selected,
 
247
      the new catagory will be a root level catagory, otherwise it will become a child of the catagory currently
 
248
      selected.
 
249
    </para>
 
250
    <para>
 
251
      After you have selected the required catagory, press 'Add' and the pattern will be added to that catagory.
 
252
    </para>
 
253
  </sect1>
 
254
  
 
255
  <sect1 id="TextDialog" >
 
256
    <title>The Text Dialog</title>
 
257
    <para>
 
258
      <screenshot>
 
259
        <mediaobject>
 
260
          <imageobject>
 
261
            <imagedata fileref="text.png" format="PNG" />
 
262
          </imageobject>
 
263
        </mediaobject>
 
264
      </screenshot>
 
265
    </para>
 
266
    <para>
 
267
      The text dialog allows you to select a font and size, then enter the text.  Clicking OK closes the
 
268
      dialog and returns you to the &kapp; window. Positioning the text is the same as pasting any other
 
269
      element. Press the &LMB; on the canvas roughly where you want the text, this will show a preview of
 
270
      the text, position the text exactly where you want it, then release the &LMB;
 
271
    </para>
 
272
      <screenshot>
 
273
        <mediaobject>
 
274
          <imageobject>
 
275
            <imagedata fileref="text1.png" format="PNG" />
 
276
          </imageobject>
 
277
        </mediaobject>
 
278
      </screenshot>
 
279
  </sect1>
 
280
  
 
281
  <sect1 id="PrinterDialog" >
 
282
    <title>The Printer Dialog</title>
 
283
    <para>
 
284
      <screenshot>
 
285
        <mediaobject>
 
286
          <imageobject>
 
287
            <imagedata fileref="print.png" format="PNG" />
 
288
          </imageobject>
 
289
        </mediaobject>
 
290
      </screenshot>
 
291
    </para>
 
292
    <para>
 
293
      The standard &kde; print dialog has been extended with a &kapp; specific page that allows
 
294
      the printing of the pattern to be customized to your requirements.
 
295
    </para>
 
296
    <para>
 
297
      The possible elements that can be printed are
 
298
      <itemizedlist>
 
299
        <listitem><para>Front page</para></listitem>
 
300
        <listitem><para>Instructions</para></listitem>
 
301
        <listitem><para>Floss key</para></listitem>
 
302
        <listitem><para>pattern</para></listitem>
 
303
      </itemizedlist>
 
304
      Checkboxes in the dialog allow you to turn on or off any of these elements.
 
305
    </para>
 
306
    <para>
 
307
      The front page will show the title of the pattern and the authors name at the top of the page
 
308
      if they have been defined. It will show an image of the design in the centre and a copyright
 
309
      message at the bottom, if it has been defined.
 
310
      <screenshot>
 
311
        <mediaobject>
 
312
          <imageobject>
 
313
            <imagedata fileref="front.png" format="PNG" />
 
314
          </imageobject>
 
315
        </mediaobject>
 
316
      </screenshot>
 
317
    </para>
 
318
    <para>
 
319
      With the floss key you can additionally specify the printing of the floss usage which will
 
320
      be shown in metres, this will either be a total for all stitches, or the backstitches can be
 
321
      shown as a seperate length, with a with a seperate total. The stitch count for each floss
 
322
      can also be printed, either comprehensively with each stitch type totalled seperately or
 
323
      the fractional stitches can be combined and totalled together.
 
324
      <screenshot>
 
325
        <mediaobject>
 
326
          <imageobject>
 
327
            <imagedata fileref="usage.png" format="PNG" />
 
328
          </imageobject>
 
329
        </mediaobject>
 
330
      </screenshot>
 
331
    </para>
 
332
    <para>
 
333
      The pattern can be printed on a single sheet, or it will span over as many sheets as
 
334
      required. The Grid Squares per Inch and the Minimum Spill Over values can be adjusted to
 
335
      give some control over the number of sheets. The stitches can be printed in any of the 
 
336
      available formats. The backstitches can only be printed as black or coloured lines.
 
337
    </para>
 
338
    <para>
 
339
      For patterns that span multiple sheets, a keyplan will be printed in the top right hand
 
340
      corner of each sheet.
 
341
      <screenshot>
 
342
        <mediaobject>
 
343
          <imageobject>
 
344
            <imagedata fileref="map.png" format="PNG" />
 
345
          </imageobject>
 
346
        </mediaobject>
 
347
      </screenshot>
 
348
    </para>
 
349
  </sect1>
 
350
 
 
351
</chapter>