Skip to content

Commit 8a9e19f

Browse files
committed
[dev] fix internal links for guides
1 parent 4803be3 commit 8a9e19f

20 files changed

Lines changed: 73 additions & 73 deletions

docs/guides/configuration.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can change the type of the counter which renders the progress of completion
2626

2727
By default, each parent task is equipped with the counter whose value is shown as a ratio of completed child tasks and the total number of the child tasks.
2828

29-
If you want the value of the counter to be displayed as a percentage, specify the *type: "percentage"* attribute inside the **counter** parameter of the [`taskShape`](api/configs/taskshape_config.md) property:
29+
If you want the value of the counter to be displayed as a percentage, specify the *type: "percentage"* attribute inside the **counter** parameter of the [`taskShape`](../../api/configs/taskshape_config/) property:
3030

3131
~~~js {5-9}
3232
const list = new ToDo("#root", {
@@ -45,7 +45,7 @@ const list = new ToDo("#root", {
4545

4646
### Date format
4747

48-
By default, the To Do List displays dates in the "%d %M %Y" format (it looks like 09 Mar 2033). If you want to specify another format for dates, use the **date** parameter of the [`taskShape`](api/configs/taskshape_config.md) property:
48+
By default, the To Do List displays dates in the "%d %M %Y" format (it looks like 09 Mar 2033). If you want to specify another format for dates, use the **date** parameter of the [`taskShape`](../../api/configs/taskshape_config/) property:
4949

5050
~~~js {5-10}
5151
const list = new ToDo("#root", {
@@ -63,13 +63,13 @@ const list = new ToDo("#root", {
6363

6464
**Related sample:** [To do list. Subtask counter and date format](https://snippet.dhtmlx.com/magidhw8)
6565

66-
Check [the list of available characters](api/configs/taskshape_config.md#list-of-characters).
66+
Check [the list of available characters](../../api/configs/taskshape_config/#list-of-characters).
6767

6868
### Drag-n-drop
6969

7070
The default configuration of To Do List includes the drag-n-drop functionality. You can [select one or several tasks](../../#selecting-tasks) and drag the selected tasks vertically at once. If you need to create a copy of the selected tasks, hold the *Alt* key during drag-n-drop.
7171

72-
There is the [`drag`](api/configs/drag_config.md) property which allows you:
72+
There is the [`drag`](../../api/configs/drag_config/) property which allows you:
7373

7474
- to configure the behavior of the collapsed tasks so that they don't expand when you hover them over during drag-n-drop:
7575

@@ -99,7 +99,7 @@ const list = new ToDo("#root", {
9999

100100
### Due date validation
101101

102-
If you specify a [due date](api/configs/tasks_config.md) for a task, the due date validation will track the completion of the task. The due date of the task has green color until the task becomes Overdue.
102+
If you specify a [due date](../../api/configs/tasks_config/) for a task, the due date validation will track the completion of the task. The due date of the task has green color until the task becomes Overdue.
103103

104104
![due_date](../assets/due_date.png)
105105

@@ -109,7 +109,7 @@ The dates of the tasks which have not been completed on the due date are highli
109109

110110
This validation works by default.
111111

112-
In case you want to disable this functionality, specify the **validate** setting inside the *date* parameter of the [`taskShape`](api/configs/taskshape_config.md) property to *false*:
112+
In case you want to disable this functionality, specify the **validate** setting inside the *date* parameter of the [`taskShape`](../../api/configs/taskshape_config/) property to *false*:
113113

114114
~~~js {5-10}
115115
const list = new ToDo("#root", {
@@ -136,7 +136,7 @@ By default, the process of checking/unchecking tasks is implemented in the "auto
136136
- If you mark at least one child of a completed task as uncompleted, the task automatically becomes marked as uncompleted
137137
- If you mark the parent task as uncompleted, all its child automatically become uncompleted
138138

139-
You can disable this behavior and activate the "manual" mode. For that, apply the **behavior: "manual"** setting of the **completed** parameter of the [`taskShape`](api/configs/taskshape_config.md) property:
139+
You can disable this behavior and activate the "manual" mode. For that, apply the **behavior: "manual"** setting of the **completed** parameter of the [`taskShape`](../../api/configs/taskshape_config/) property:
140140

141141
~~~js {5-9}
142142
const list = new ToDo("#root", {
@@ -155,9 +155,9 @@ const list = new ToDo("#root", {
155155

156156
## Toolbar
157157

158-
The toolbar is a top part of To Do List which is [initialized](guides/initialization.md#initialize-toolbar) and [configured](category/toolbar-properties.md) separately from To Do List.
158+
The toolbar is a top part of To Do List which is [initialized](../../guides/initialization/#initialize-toolbar) and [configured](category/toolbar-properties.md) separately from To Do List.
159159

160-
To change the default structure of the toolbar, use the [`items`](api/toolbar_api/configs/items_config.md) configuration property of the Toolbar component.
160+
To change the default structure of the toolbar, use the [`items`](../../api/toolbar_api/configs/items_config/) configuration property of the Toolbar component.
161161

162162
~~~js
163163
const toolbar = new Toolbar("#toolbar", {
@@ -170,8 +170,8 @@ The property allows you to define which controls should be shown or hidden. Besi
170170

171171
## Mode of hiding completed tasks
172172

173-
Read the details on how to hide completed tasks from To Do List in the [related section](guides/hide_completed_tasks.md).
173+
Read the details on how to hide completed tasks from To Do List in the [related section](../../guides/hide_completed_tasks/).
174174

175175
## Read-only mode
176176

177-
Read the details on how to make the To Do List read-only in the [related section](guides/readonly_mode.md).
177+
Read the details on how to make the To Do List read-only in the [related section](../../guides/readonly_mode/).

docs/guides/customization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ description: You can learn about the To Do List Customization in the documentati
88

99
## Toolbar
1010

11-
It is possible to customize the appearance of the toolbar. You can hide some default controls, add custom ones, and place them in the necessary order. To do that, use the [`items`](api/toolbar_api/configs/items_config.md) property of the Toolbar component.
11+
It is possible to customize the appearance of the toolbar. You can hide some default controls, add custom ones, and place them in the necessary order. To do that, use the [`items`](../../api/toolbar_api/configs/items_config/) property of the Toolbar component.
1212

1313
You can customize your toolbar as in:
1414

1515
<iframe src="https://snippet.dhtmlx.com/jrnestbk?mode=result" frameborder="0" class="snippet_iframe" width="100%" height="500"></iframe>
1616

1717
## Styling To Do List
1818

19-
You can change the look and feel of To Do List by changing values of the [**CSS variables provided by the library**](guides/stylization.md).
19+
You can change the look and feel of To Do List by changing values of the [**CSS variables provided by the library**](../../guides/stylization/).
2020

2121
Check the example:
2222

docs/guides/hide_completed_tasks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are two modes of displaying tasks in To Do List:
1313
- when all tasks are shown on the page (*default*)
1414
- when completed tasks are hidden from the page
1515

16-
You may initialize To Do List in the mode when all completed tasks will be hidden from the page. It will let you focus only on those tasks which yet need to be done. For that, you need to enable the **taskHide** setting of the **completed** parameter of the [`taskShape`](api/configs/taskshape_config.md) property, as in:
16+
You may initialize To Do List in the mode when all completed tasks will be hidden from the page. It will let you focus only on those tasks which yet need to be done. For that, you need to enable the **taskHide** setting of the **completed** parameter of the [`taskShape`](../../api/configs/taskshape_config/) property, as in:
1717

1818
~~~js {6}
1919
const list = new ToDo("#root", {
@@ -33,7 +33,7 @@ You may easily switch between these two modes after initialization of To Do List
3333

3434
- via the **Completed tasks -> Show/Hide** option of the [Toolbar menu](../../#toolbar)
3535

36-
- via the related [`hideCompletedTasks()`](api/methods/hidecompletedtasks_method.md) and [`showCompletedTasks()`](api/methods/showcompletedtasks_method.md) methods:
36+
- via the related [`hideCompletedTasks()`](../../api/methods/hidecompletedtasks_method/) and [`showCompletedTasks()`](../../api/methods/showcompletedtasks_method/) methods:
3737

3838
~~~js
3939
list.hideCompletedTasks();

docs/guides/initialization.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Thus, create **two containers** to place a List and Toolbar into and give them I
5050
After that, initialize List with the **new ToDo()** constructor. It takes two parameters:
5151

5252
- a container to place a List into. The one we have created at the previous step
53-
- an object with configuration properties. [See the full list here](api/overview/configs_overview.md)
53+
- an object with configuration properties. [See the full list here](../../api/overview/configs_overview/)
5454

5555
~~~js title="index.js"
5656
const { ToDo, Toolbar } = todo; // apply the object destructuring
@@ -94,7 +94,7 @@ You don't need this step if you will use the **new todo.ToDo()** and **new todo.
9494

9595
## Loading data into To Do List
9696

97-
Detailed information on loading data into DHTMLX To Do is given in the [Data loading](guides/loading_data.md) article.
97+
Detailed information on loading data into DHTMLX To Do is given in the [Data loading](../../guides/loading_data/) article.
9898

9999
## Example
100100

docs/guides/inline_editing.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: You can learn about inline editing in the documentation of the DHTM
99
Inline editing lets you edit the content of a task/project directly by double-clicking on it. The functionality is enabled by default.
1010

1111
:::tip
12-
When you enable the [**readonly**](api/configs/readonly_config.md) mode of To Do List, inline editing becomes unavailable.
12+
When you enable the [**readonly**](../../api/configs/readonly_config/) mode of To Do List, inline editing becomes unavailable.
1313
:::
1414

1515
## Supported formats of data
@@ -30,7 +30,7 @@ Use hashtags to categorize tasks and make them more searchable. Here are some si
3030
- To activate strict filtering, click a hashtag or enter it in the search bar in the toolbar
3131

3232
:::info
33-
You can create a default list of tags via the [`tags`](api/configs/tags_config.md) property
33+
You can create a default list of tags via the [`tags`](../../api/configs/tags_config/) property
3434
:::
3535

3636
3\. **Dates**
@@ -40,7 +40,7 @@ To enter a date via the inline editor, type the `!` symbol and the built-in date
4040
You can also wrap some text in the special symbols - `!()` - for instance, **!(Enter Booking date)**, and press Enter to close the editor. In the future, clicking on this text will open the date picker.
4141

4242
:::info
43-
The appearance of the added dates depends on the specified [**locale**](api/configs/locale_config.md) and [**date format**](api/configs/taskshape_config.md)
43+
The appearance of the added dates depends on the specified [**locale**](../../api/configs/locale_config/) and [**date format**](../../api/configs/taskshape_config/)
4444
:::
4545

4646
## Working with editor

docs/guides/integration_with_angular.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ export class ToDoComponent implements OnInit, OnDestroy {
245245
}
246246
~~~
247247

248-
You can also use the [`parse()`](/api/methods/parse_method/) method inside the `ngOnInit()` method of Angular to load data into To Do List.
248+
You can also use the [`parse()`](../../api/methods/parse_method/) method inside the `ngOnInit()` method of Angular to load data into To Do List.
249249

250250
~~~jsx {2,23,31-36} title="todo.component.ts"
251251
import { ToDo, Toolbar } from '@dhx/trial-todolist';
@@ -295,11 +295,11 @@ export class ToDoComponent implements OnInit, OnDestroy {
295295

296296
The `parse(data)` method provides data reloading on each applied change.
297297

298-
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](/api/overview/configs_overview/) to check the full list of available properties.
298+
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](../../api/overview/configs_overview/) to check the full list of available properties.
299299

300300
#### Handling events
301301

302-
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events_overview/).
302+
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](../../api/overview/events_overview/).
303303

304304
Open the **todo.component.ts** file and complete the `ngOnInit()` method in the following way:
305305

docs/guides/integration_with_react.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ export default function ToDoComponent(props) {
245245
}
246246
~~~
247247

248-
You can also use the [`parse()`](/api/methods/parse_method/) method inside the `useEffect()` method of React to load data into To Do List:
248+
You can also use the [`parse()`](../../api/methods/parse_method/) method inside the `useEffect()` method of React to load data into To Do List:
249249

250250
~~~jsx {9-11,21} title="ToDo.jsx"
251251
import { useEffect, useRef } from "react";
@@ -285,11 +285,11 @@ export default function ToDoComponent(props) {
285285

286286
The `parse(data)` method provides data reloading on each applied change.
287287

288-
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](/api/overview/configs_overview/) to check the full list of available properties.
288+
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](../../api/overview/configs_overview/) to check the full list of available properties.
289289

290290
#### Handling events
291291

292-
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events_overview/).
292+
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](../../api/overview/events_overview/).
293293

294294
Open ***ToDo.jsx*** and complete the `useEffect()` method in the following way:
295295

docs/guides/integration_with_svelte.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ onDestroy(() => {
232232
</div>
233233
~~~
234234

235-
You can also use the [`parse()`](/api/methods/parse_method/) method inside the `onMount()` method of Svelte to load data into To Do List:
235+
You can also use the [`parse()`](../../api/methods/parse_method/) method inside the `onMount()` method of Svelte to load data into To Do List:
236236

237237
~~~html {6-8,21} title="ToDo.svelte"
238238
<script>
@@ -272,11 +272,11 @@ onDestroy(() => {
272272

273273
The `parse(data)` method provides data reloading on each applied change.
274274

275-
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](/api/overview/configs_overview/) to check the full list of available properties.
275+
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](../../api/overview/configs_overview/) to check the full list of available properties.
276276

277277
#### Handling events
278278

279-
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events_overview/).
279+
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](../../api/overview/events_overview/).
280280

281281
Open ***ToDo.svelte*** and complete the `onMount()` method in the following way:
282282

docs/guides/integration_with_vue.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ export default {
238238
</template>
239239
~~~
240240

241-
You can also use the [`parse()`](/api/methods/parse_method/) method inside the `mounted()` method of Vue to load data into To Do List:
241+
You can also use the [`parse()`](../../api/methods/parse_method/) method inside the `mounted()` method of Vue to load data into To Do List:
242242

243243
~~~html {6,16-20} title="ToDo.vue"
244244
<script>
@@ -280,11 +280,11 @@ export default {
280280

281281
The `parse(data)` method provides data reloading on each applied change.
282282

283-
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](/api/overview/configs_overview/) to check the full list of available properties.
283+
Now the To Do List component is ready to use. When the element will be added to the page, it will initialize the To Do List with data. You can provide necessary configuration settings as well. Visit our [To Do List API docs](../../api/overview/configs_overview/) to check the full list of available properties.
284284

285285
#### Handling events
286286

287-
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](/api/overview/events_overview/).
287+
When a user makes some action in the To Do List, it invokes an event. You can use these events to detect the action and run the desired code for it. See the [full list of events](../../api/overview/events_overview/).
288288

289289
Open ***ToDo.vue*** and complete the `mounted()` method:
290290

docs/guides/loading_data.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ description: You can learn about loading and storing data in the documentation o
1010

1111
There are the following types of information which can be loaded into DHTMLX To Do List:
1212

13-
- [**tasks**](api/configs/tasks_config.md)
14-
- [**projects**](api/configs/projects_config.md)
15-
- [**users**](api/configs/users_config.md)
16-
- [**priorities**](api/configs/priorities_config.md)
17-
- [**tags**](api/configs/tags_config.md)
18-
- [**activeProject**](api/configs/activeproject_config.md)
13+
- [**tasks**](../../api/configs/tasks_config/)
14+
- [**projects**](../../api/configs/projects_config/)
15+
- [**users**](../../api/configs/users_config/)
16+
- [**priorities**](../../api/configs/priorities_config/)
17+
- [**tags**](../../api/configs/tags_config/)
18+
- [**activeProject**](../../api/configs/activeproject_config/)
1919

2020
You can prepare data in a separate file. Here is an example of an appropriate data set:
2121

@@ -178,7 +178,7 @@ const { tasks, users, projects, priorities } = getData();
178178

179179
### Loading data on initialization
180180

181-
You can load [a predefined data](guides/loading_data.md#preparing-data-to-load) into To Do List on the initialization stage in the following way:
181+
You can load [a predefined data](#preparing-data-to-load) into To Do List on the initialization stage in the following way:
182182

183183
~~~js {2,5-8} title="index.js"
184184
const { ToDo } = todo;
@@ -194,7 +194,7 @@ const list = new ToDo("#root", {
194194

195195
### Loading data after initialization
196196

197-
To load data from a local data source after initialization of the To Do List, use the [`parse()`](api/methods/parse_method.md) method:
197+
To load data from a local data source after initialization of the To Do List, use the [`parse()`](../../api/methods/parse_method/) method:
198198

199199
~~~js {3,5,12-17} title="index.js"
200200
const { ToDo, Toolbar } = todo;
@@ -218,7 +218,7 @@ list.parse({
218218

219219
## Saving and restoring state
220220

221-
To save the current state of a To Do, use the [`serialize()`](api/methods/serialize_method.md) method. It converts the data of the To Do List into a JSON object.
221+
To save the current state of a To Do, use the [`serialize()`](../../api/methods/serialize_method/) method. It converts the data of the To Do List into a JSON object.
222222

223223
~~~js
224224
const state = list.serialize();

0 commit comments

Comments
 (0)