summaryrefslogtreecommitdiffstats
path: root/chalk/doc/doc-outline
blob: 081f9ed7087a706967c081cf42c4eabbf4ec42be (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
Chalk documentation outline

Last edited 2006-09-08 (Sander Koning)


Changelog (of major updates)

2006-09-08: ASK: add section separators, update for 1.6
2006-05-28: ASK: split into 1.5 and 1.6 parts
2006-01-31: ASK: elaborate on parts to be written; consistent spelling
2006-01-26: ASK: split the "Using Chalk" chapter
2006-01-21: ASK: update and make consistent
2006-01-12: ASK: add status, and put in SVN for others to enjoy ;)
2005-08-31: ASK: adhere to KDE style
2005-08-30: ASK: initial version

----------------------------------------------------------------------

This document tries to give a suitable outline for Chalk's documentation. It
is based on the Chalk manual in SVN (koffice/chalk/doc/manual/chalk.kwd) as of
2005-07-08, the KDE documentation template, and furthermore contains my own
thoughts about what the documentation for a graphics application such as this
should look like.  Comments, suggestions, ideas etc. are more than welcome.
Especially the real content still needs a lot of polishing.

----------------------------------------------------------------------

The current outline (working towards 1.6):

- Introduction
  - What is Chalk
  - Key features
    - Color management
    - File formats
  - About this manual
  - About the application author

- Tutorial
  - Starting to know Chalk (up to a new document)
  - A small selections and layers tutorial
  - Quick start guides
    - Crop an area and save it as a new image
    - Draw a rectangle on your picture
  - Using tablets
  - [TODO] Fills (colors, patterns and gradients)
  - [TODO] Using tool options (the "Tool" palette)
  - [TODO] Editing image properties (resize, rotate, ...)

- [TODO] Painting
  - [TODO] Introduction to Chalk's painting model
  - [TODO] Detailed description of tools and options, colors, ...
  - [TODO] Brushes, adding/customising, ...
  - [TODO] ...

- Viewing
  - Zooming and full screen mode
  - Working with views (multiple and split views)
  - Miscellaneous view options (rulers and grid)

- Layers
  - General information
  - Layer box
  - Working with layers ([TODO] expand)
  - Adjustment layers ([TODO] expand)
  - [TODO] Layer masks
  - Compositing modes ([TODO] expand)
  - [TODO] Create, transform, combine, histograms, ...

- Selections
  - Making a selection
  - Painting your selection
  - Unselecting
  - Making a new selection
  - Selecting a contiguous area (magic wand)
  - Selecting similar colors
  - Inverting the selection
  - [TODO] elaborate and extend hugely

- Filters
  - (all filters)

- Colorspaces
  - Introduction to colorspaces
  - Available colorspaces
  - [TODO] properties, usage, converting, ...

- Commands
  - General tqlayout
  - Menus
  - Toolbars
  - Palettes
  - Dialogs

- Settings

- Developers' information
  - Scripting
  - Plugins

- FAQ

- Credits

- Installation

----------------------------------------------------------------------

Outline for the 1.5 manual (final as of 2006-05-31):

- Introduction
  - What is Chalk
  - Key features
    - Color management
    - File formats
  - About this manual
  - About the application author

- Tutorial
  - Starting to know Chalk (up to a new document)
  - A small selections and layers tutorial
  - Quick start guides
    - Crop an area and save it as a new image
    - Draw a rectangle on you picture

- Layers
  - General information
  - Adjustment layers ([TODO] elaborate)

- Selections
  - Making a selection
  - Painting your selection
  - Unselecting
  - Making a new selection
  - Selecting a contiguous area (magic wand)
  - Selecting similar colors
  - Inverting the selection

- Filters

- Colorspaces
  - Introduction to colorspaces
  - Available colorspaces

- Commands ([TODO] make up-to-date)
  - General tqlayout
  - Menus
  - Toolbars
  - Palettes
  - Dialogs

- Settings

- Scripting

- FAQ

- Credits

- Installation

----------------------------------------------------------------------

An outline of the manual content as in chalk.kwd:

- Introduction
  - About the manual
  - About the author
- Showing Off
  - Intro tutorial
- On the face of it
  - Layout
  - Menus
- Files
- Serious about color
  - Colour theory
- Selections
  - Creating selections (select, unselect, wand)
- Messing with images
- Painting
- Layers
- Filters
- Hacking Chalk
- Configuring Chalk
- Help!
  - Help contact info