Skip to content

Commit 1e571c1

Browse files
committed
add migration guide
1 parent c740b1e commit 1e571c1

File tree

2 files changed

+44
-2
lines changed

2 files changed

+44
-2
lines changed

content/document-definition-object/page.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,12 @@ var dd = {
7171
{text: '3 Headline', headlineLevel: 1},
7272
'Some long text of variable length ...',
7373
],
74-
pageBreakBefore: function(currentNode, followingNodesOnPage, nodesOnNextPage, previousNodesOnPage) {
75-
return currentNode.headlineLevel === 1 && followingNodesOnPage.length === 0;
74+
pageBreakBefore: function(currentNode, nodeContainer) {
75+
// nodeContainer.getFollowingNodesOnPage();
76+
// nodeContainer.getNodesOnNextPage();
77+
// nodeContainer.getPreviousNodesOnPage();
78+
79+
return currentNode.headlineLevel === 1 && nodeContainer.getFollowingNodesOnPage().length === 0;
7680
}
7781
}
7882
```

content/migration-from-0.1/_index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
+++
2+
title = "Migration from 0.1"
3+
description = ""
4+
weight = 9
5+
alwaysopen = true
6+
+++
7+
8+
#### Unified interfaces and all methods return promise
9+
10+
[See Methods for client-side](/docs/0.3/getting-started/client-side/methods/).
11+
12+
[See Methods for server-side](/docs/0.3/getting-started/server-side/methods/).
13+
14+
15+
#### Changed including virtual font storage in client-side
16+
17+
Regenerate virtual file system (VFS) is required.
18+
19+
20+
#### Changed parameters of pageBreakBefore function
21+
22+
Version 0.1 or 0.2:
23+
```js
24+
pageBreakBefore: function(currentNode, followingNodesOnPage, nodesOnNextPage, previousNodesOnPage) {
25+
26+
}
27+
```
28+
29+
Version 0.3:
30+
```js
31+
pageBreakBefore: function(currentNode, nodeContainer) {
32+
// nodeContainer.getFollowingNodesOnPage();
33+
// nodeContainer.getNodesOnNextPage();
34+
// nodeContainer.getPreviousNodesOnPage();
35+
}
36+
```
37+
38+
[See documentation](/docs/0.3/document-definition-object/page/#dynamically-control-page-breaks-for-instance-to-avoid-orphan-children).

0 commit comments

Comments
 (0)