Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Draft] Add appendix about migration #405

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/guide/xml/guide.xml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ contained herein.</para>
<xi:include href="ch04.xml"/> <!-- implementation -->
<xi:include href="ch05.xml"/> <!-- building -->
<xi:include href="ver2.xml"/>
<xi:include href="migration.xml"/><!-- Migration from XSLT 1 -> 3 -->
<xi:include href="glossary.xml"/>
<xi:include href="references.xml"/>
<xi:include href="ackno.xml"/>
Expand Down
37 changes: 37 additions & 0 deletions src/guide/xml/migration.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0" xml:id="migration">
<info>
<?db filename="ch-preface"?>
<title>Migration from XSLT 1.0 to XSLT 3.0</title>
</info>

<!--
This is the migration chapter for issue #212
Some ideas to cover:
* Benefits of moving to the new stylesheets (that's probably mostly covered in this project already)
* Target groups (probably developers that already wrote customization layers?)
* Requirements:
* Skills needed (certainly some XSLT/XPath 3.0 would be useful)
* Software (perhaps Saxon9-12. Other XSLT 3.0 processors aren't available at the moment, right?)
* System (the necessary dependencies, Docker images, or other requirements etc.)
* Migration considerations
* Tips and recommendations
* Best practices
* Traps or things to avoid (for example, how to migrate extension elements/functions from other XSLT
processors, like exsl:node-set)
* Testing
The xslTNG stylesheets contains test cases which is really great! How can we use this for a migration project?
* Costs
Not so from a financial aspect, but more about:
* Speed (is it slower/faster than the DocBook XSLT 1.0 stylesheets with xsltproc? By what factor? What can we do to speed up things?)
* Time (how much effort is it to move an existing code base? I know, that's hard to answer, but maybe there are some experiences?)
* Complete rewrite? (when it is useful to just throw away the existing code base and start from scratch? Any experience?)
-->

<para>TBD</para>
</appendix>
Loading