Skip to content

Commit ac5a8e0

Browse files
committed
[update] corrections and updates in the docs for v9.0
1 parent 760717d commit ac5a8e0

File tree

12 files changed

+40
-38
lines changed

12 files changed

+40
-38
lines changed

data/api/gantt_baselines_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This config defines how baselines are handled and displayed in the Gantt chart.
2323
- **datastore** (*string*) - the name of the datastore used for storing baseline entries. For related functionality, see the `getDatastore` method.
2424
- **render_mode** (*boolean | string*) - determines how baselines are displayed:
2525
- `false` - baselines are not shown.
26-
- `"taskRow"` - baselines are displayed in the same row as the task bar.
26+
- `"taskRow"` - baselines are displayed in the same row with the task bar.
2727
- `"separateRow"` - baselines are shown in a separate subrow, expanding the task row height.
2828
- `"individualRow"` - each baseline is displayed in its own subrow beneath the task.
2929
- **dataprocessor_baselines** (*boolean*) - specifies whether baseline updates trigger the DataProcessor as individual entries.

data/desktop/baselines.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Custom Elements in Timeline Area
44
{{pronote This functionality is available only in the PRO edition}}
55

66
dhtmlxGantt provides the [built-in functionality](desktop/inbuilt_baselines.md) that allows rendering such extra elements as baselines,
7-
deadlines and task constraints by default. In case, you need to extend or modify the default features, you can add custom elements into timeline manually as described below.
7+
deadlines and task constraints by default. In case you need to extend or modify the default features, you can add custom elements into timeline manually as described below.
88

99
Displaying additional elements is usually done by creating a displayable layer and placing custom elements there
1010
(using the absolute positioning to put custom elements next to the related task).

data/desktop/configuring_time_scale.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -723,7 +723,7 @@ You can find detailed examples on how to implement an infinite scroll in the tim
723723

724724
## Sticky labels
725725

726-
Starting from v9.0, time scale labels are sticky by default. This means that when the width of a cell is significantly larger than the width of its label, the label will remain visible as you scroll through the timeline, staying attached to the viewport until it naturally scrolls off. This improves the visibility of scale labels, particularly when zoomed in or out.
726+
Starting from v9.0, time scale labels are sticky by default. It means that when the width of a cell is significantly larger than the width of its label, the label will remain visible as you scroll through the timeline, staying attached to the viewport until it naturally scrolls off. This improves the visibility of scale labels, particularly when zoomed in or out.
727727

728728
To revert to the old behavior where labels are centered within their cells and do not remain visible while scrolling, you can disable sticky labels by setting the `sticky` property of the scale object to `false`:
729729

@@ -736,7 +736,7 @@ gantt.config.scales = [
736736
gantt.init("gantt_here");
737737
~~~
738738

739-
You can also force sticky labels for a particular scale regardless of cell width by setting `sticky: true`. This will ensure the labels are always sticky, even when the label width is smaller than the cell width:
739+
You can also force sticky labels for a particular scale regardless of the cell width by setting `sticky: true`. It will ensure the labels are always sticky, even when the label width is smaller than the cell width:
740740

741741
~~~js
742742
gantt.config.scales = [

data/desktop/custom_projects_dates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Manually Scheduled Summary Tasks
22
===============================
33

4-
There is a possibility to schedule [projects](desktop/task_types.md) (summary tasks) manually. This feature serves to outline project phases before all subtasks are detailed,
5-
providing a framework for your project timeline.
4+
There is a possibility to schedule [projects](desktop/task_types.md) (summary tasks) manually.
5+
This feature serves to increase flexibility and accuracy in managing projects with Gantt charts.
66

77
By default, summary tasks automatically calculate their dates based on the earliest start and latest end dates of their subtasks.
88
You can also set fixed start and end dates for summary tasks independently of their subtasks. As a result, the Gantt chart will display both the fixed duration

data/desktop/custom_skins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ The script will rebuild CSS files from sources and put them into the *codebase*
209209
Structure
210210
------------
211211

212-
The structure of the **less** folder for version 7.0 (may be changed in future versions) is given below:
212+
The structure of the **less** folder for version 9.0 (may be changed in future versions) is given below:
213213

214214
### Images
215215

@@ -279,15 +279,15 @@ npm run build
279279

280280
<br>
281281
{{note
282-
Note that gantt may apply some predefined settings to the calendar based on the applied skin.
283-
When you create a new skin by copying an existing one, you may need to apply the corresponding settings to the gantt manually.
282+
Note that Gantt may apply some predefined settings to the calendar based on the applied skin.
283+
When you create a new skin by copying an existing one, you may need to apply the corresponding settings to the Gantt manually.
284284
}}
285285

286286

287287
JS styling settings
288288
---------------------
289289

290-
Note that not all aspects of Gantt styling are controlled from CSS, some parameters are defined from the JavaScript configuration, for example following properties:
290+
Note that not all aspects of Gantt styling are controlled from CSS, some parameters are defined from the JavaScript configuration, for example the following properties:
291291

292292
- api/gantt_link_line_width_config.md
293293
- api/gantt_link_radius_config.md

data/desktop/inbuilt_baselines.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ After that you can customize the display of baselines in one of the following wa
3636

3737
1\. Using the **gantt.config.baselines** configuration object
3838

39-
The **baselines** configuration option also allows customizing the rendering of baselines in the Gantt chart when set as an object.
39+
The **baselines** configuration option allows customizing the rendering of baselines in the Gantt chart when set as an object.
4040
The object configuration contains the following properties:
4141

4242
- **datastore** (*string*) - the name of the datastore used for storing baseline entries. For related functionality, see the `getDatastore` method.
4343
- **render_mode** (*boolean | string*) - determines how baselines are displayed:
4444
- `false` - baselines are not shown.
45-
- `"taskRow"` - baselines are displayed in the same row as the task bar.
45+
- `"taskRow"` - baselines are displayed in the same row with the task bar.
4646
- `"separateRow"` - baselines are shown in a separate subrow, expanding the task row height.
4747
- `"individualRow"` - each baseline is displayed in its own subrow beneath the task.
4848
- **dataprocessor_baselines** (*boolean*) - specifies whether baseline updates trigger the DataProcessor as individual entries.
@@ -75,7 +75,7 @@ gantt.render();
7575

7676
### Loading baselines with tasks
7777

78-
Baselines can be loaded directly alongside tasks, streamlining data management and display. Check the example below:
78+
Baselines can be loaded directly alongside tasks. Check the example below:
7979

8080
~~~js
8181
gantt.parse({
@@ -151,34 +151,34 @@ gantt.config.lightbox.sections = [
151151

152152
![Baseline lightbox](desktop/baselines_lightbox.png)
153153

154-
### Baseline rendering modes
154+
### Baselines rendering modes
155155

156156
Gantt offers three modes for displaying baselines. You can choose the rendering mode that suits best for your needs
157157
by setting the **gantt.config.baselines.render_mode** configuration option to the corresponding value. There are three modes available:
158158

159-
- Same row as task ("taskRow")
159+
- In the same row with the task ("taskRow")
160160

161-
Baselines are displayed directly on the same row as the task bars:
161+
Baselines are displayed directly in the same row with the task bars:
162162

163163
~~~js
164164
gantt.config.baselines.render_mode = "taskRow";
165165
~~~
166166

167167
![Task row mode](desktop/baselines_task_row.png)
168168

169-
- Separate subrow below task ("separateRow")
169+
- In a separate subrow below the task ("separateRow")
170170

171-
All baselines are rendered on a single subrow below each task:
171+
All baselines are rendered in a single subrow below each task:
172172

173173
~~~js
174174
gantt.config.baselines.render_mode = "separateRow";
175175
~~~
176176

177177
![Subrow mode](desktop/baselines_subrow.png)
178178

179-
- Individual subrows for each baseline ("individualRow")
179+
- In an individual subrow ("individualRow")
180180

181-
Each baseline is displayed on its subrow for maximum clarity:
181+
Each baseline is displayed in its subrow for maximum clarity:
182182

183183
~~~js
184184
gantt.config.baselines.render_mode = "individualRow";
@@ -208,7 +208,7 @@ DHTMLX Gantt comes with built-in visualization for deadlines and constraints, en
208208

209209
### Deadlines visualization
210210

211-
Gantt supports a numeric **task.deadline** field. When specified, it displays a visual indicator on the chart, thereby simplifying the tracking of task deadlines.
211+
Gantt supports the **task.deadline** field. When specified, it displays a visual indicator on the chart, thereby simplifying the tracking of task deadlines.
212212

213213
~~~js
214214
gantt.parse({
@@ -238,9 +238,9 @@ After that you can customize the display of deadlines by [creating a custom dead
238238
The **gantt.config.deadlines** config enables or disables the display of deadline elements for tasks. If enabled, Gantt will check the **task.deadline** property,
239239
and if it contains a valid date, the deadline element will be displayed in the timeline.
240240

241-
### Task constraints
241+
### Task constraints {#taskconstraints}
242242

243-
Starting from v9.0, when [auto scheduling](desktop/auto_scheduling.md) is enabled and works in Constraint mode (api/gantt_auto_scheduling_compatibility_config.md is set to *false*), Gantt will automatically display constraint dates in the chart.
243+
Starting from v9.0, when [auto scheduling](desktop/auto_scheduling.md) is enabled and works in the Constraint mode (api/gantt_auto_scheduling_compatibility_config.md is set to *false*), Gantt will automatically display constraint dates in the chart.
244244

245245
~~~js
246246
gantt.parse({
@@ -259,12 +259,13 @@ gantt.parse({
259259
})
260260
~~~
261261

262-
The display of constraints can be controlled using the `display_constraints` option in the api/gantt_auto_scheduling_config.md config. By default, constraints are shown, but you can disable them by setting `display_constraints` to `false`:
262+
The display of constraints can be controlled using the `show_constraints` option in the api/gantt_auto_scheduling_config.md config.
263+
By default, constraints are shown, but you can disable them by setting `show_constraints` to `false`:
263264

264265
~~~js
265266
gantt.config.auto_scheduling = {
266267
enabled: true,
267-
display_constraints: false
268+
show_constraints: false
268269
};
269270
~~~
270271

data/desktop/skins.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ By default, skins import the `Inter` font from `https://fonts.googleapis.com`. R
4040
If necessary, you can remove the font directly from **.less** files in the **codebase/sources/less/** folder
4141
and then rebuild the skin as described in the desktop/custom_skins.md article.
4242

43-
'Teracce' skin
43+
'Terrace' skin
4444
-----------------------------
4545

4646
To apply the default skin, include the default CSS file:
@@ -49,6 +49,7 @@ To apply the default skin, include the default CSS file:
4949
- **dhtmlxgantt.css**
5050

5151
<img alt="DHTMLX Gantt - Light Theme" src="desktop/gantt-default-skin.png"/>
52+
5253
{{sample 06_skins/01_default.html}}
5354

5455
'Dark' skin

data/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Start
99
<ul>
1010
<li><a href="desktop/custom_skins.md">Skins customization with CSS variables</a></li>
1111
<li><a href="desktop/skins.md#darkskin">New Dark skin</a></li>
12-
<li><a href="desktop/baselines.md">Built-in support for baselines</a></li>
12+
<li><a href="desktop/inbuilt_baselines.md">Built-in support for baselines</a></li>
1313
<li><a href="desktop/custom_projects_dates.md">Manually scheduled projects</a></li>
1414
</ul>
1515

data/migrating.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ gantt.init("gantt_here");
141141
Previously, adding baselines required manual coding using the `gantt.addTaskLayer` API. With Gantt 9.0, we've introduced built-in support for baseline entities together with
142142
deadlines and task constraints.
143143

144-
In case, you want to switch off the default settings and render baselines and deadlines manually,
145-
you can use the corresponding confguration options: api/gantt_baselines_config.md and api/gantt_deadlines_config.md:
144+
In case you want to switch off the default settings and render baselines and deadlines manually,
145+
you can use the corresponding configuration options: api/gantt_baselines_config.md and api/gantt_deadlines_config.md:
146146

147147
~~~js
148148
// disabling the built-in baselines functionality
@@ -152,16 +152,16 @@ gantt.config.baselines = false;
152152
gantt.config.deadlines = false;
153153
~~~
154154

155-
Built-in display of task constraints can also be disabled using the extended api/gantt_autoscheduling_config.md config:
155+
Built-in display of task constraints can also be disabled using the extended api/gantt_auto_scheduling_config.md config:
156156

157157
~~~js
158158
gantt.config.auto_scheduling = {
159159
enabled: true,
160-
show_constraints: false
160+
show_constraints: false /*!*/
161161
};
162162
~~~
163163

164-
This disables the default display of task constraints while still keeping auto-scheduling functionality active.
164+
It disables the default display of task constraints while still keeping auto-scheduling functionality active.
165165

166166
### Sticky labels in the Timeline
167167

data/whatsnew.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ This update brings some changes in the structure of the Gantt package and behavi
2626

2727
- [Skins customization](desktop/custom_skins.md) with CSS variables
2828
- New [Dark skin](desktop/skins.md#darkskin) is introduced
29-
- Built-in support for [Baselines](desktop/baselines.md) is added
30-
- [Manually Scheduled Summary tasks](desktop/custom_projects_dates.md) are now supported
31-
- [Sticky labels for time scales](desktop/configuring_time_scale.html#stickylabels)
29+
- Built-in support for [baselines](desktop/inbuilt_baselines.md) is added
30+
- [Manually scheduled summary tasks](desktop/custom_projects_dates.md) are now supported
31+
- [Sticky labels for time scales](desktop/configuring_time_scale.md#stickylabels)
3232

3333
### Updates
3434

3535
- [Terrace skin](desktop/skins.md#terraceskin) is updated
36-
- Added support for Deadlines
37-
- Added default display of [Constraints](desktop/auto_scheduling.md)
36+
- Default display of [deadlines](desktop/inbuilt_baselines.md#deadlinesandconstraints) is added
37+
- Default display of [task constraints](desktop/inbuilt_baselines.md#taskconstraints) is added
3838
- [Source files of skins](desktop/custom_skins.md) are now included in the package
39-
- Add `setUndoStack` and `setRedoStack` methods to the [Undo plugin](desktop/undo_redo.md) for managing the undo/redo stacks
39+
- The `setUndoStack` and `setRedoStack` methods are added to the [Undo plugin](desktop/undo_redo.md) for managing the undo/redo stacks
4040
- Ability to [install the professional versions of the Gantt via npm](desktop/install_with_bower.md)
4141
- [Bluebird Promise](api/gantt_promise.md) library is **removed** from the core library
4242
- Various improvements for scaling on high-definition screens and responsiveness on smaller screens

0 commit comments

Comments
 (0)