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

Fix #38: Control the Chunking process #39

Merged
merged 2 commits into from
Jun 17, 2018
Merged

Conversation

tomschr
Copy link
Owner

@tomschr tomschr commented Jun 17, 2018

Fixes #38.

Changes proposed in this pull request:

  • Describe base.dir, chunk.section.depth, chunk.first.sections, and use.id.as.filename parameters
  • Show default chunking naming scheme and with IDs
  • Give tips about good IDs
  • Add examples

@der-schmelle2 If you have time, could you review this topic please? That would be awesome! 👍

* Describe base.dir, chunk.section.depth, chunk.first.sections,
  and use.id.as.filename parameters
* Show default chunking naming scheme and with IDs
* Give tips about good IDs
* Add examples
@tomschr tomschr self-assigned this Jun 17, 2018
@tomschr tomschr added the HTML 🌐 HTML output format label Jun 17, 2018
@tomschr
Copy link
Owner Author

tomschr commented Jun 17, 2018

Here is a PDF for a better reading experience: DBCookBook-chunking.pdf (4 pages)

Oh, by the way: if you want to comment, use the Files changed tab. To comment, move the mouse over the respective line and you will see a white plus sign on a blue background. Click the plus sign and it will open a text box where you can leave your comments.

Copy link
Owner Author

@tomschr tomschr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments from @der-schmelle2
Thanks Peter! 👍

<term><parameter>base.dir</parameter></term>
<listitem>
<para>Sets the output directory for all chunks. If not set,
the output directory is system dependant. Usually it is the

This comment was marked as resolved.

<para>
By default, only <tag>sect1</tag> elements are written to a file.
Anything below a <tag>sect1</tag> like <tag>sect2</tag>, <tag>sect3</tag>
etc. are written to the same file that contains the <tag>sect1</tag>

This comment was marked as resolved.

Validating your document shows you any problems with IDs. For
example, double IDs, missing IDs, and syntactically wrong IDs.
This is very useful as the DocBook XSL stylesheets do not check
for file names which occur twice. This could lead to a situation
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with -> which

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you are right...

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I've pushed the above two changes in commit 6448c5d. If you are ok with my changes, can you approve them or comment in case I forgot anything?

Thanks! After you have approved it, I'll merge it to develop. 👍

@tomschr tomschr requested a review from der-schmelle2 June 17, 2018 14:59
@tomschr tomschr merged commit 0f31593 into develop Jun 17, 2018
@tomschr tomschr deleted the feature/html-chunking branch June 17, 2018 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
HTML 🌐 HTML output format
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants