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

Split IoC chapter DocBook XML into multiple files [SPR-7467] #12125

Closed
spring-projects-issues opened this issue Aug 17, 2010 · 1 comment
Closed
Labels
type: documentation A documentation task
Milestone

Comments

@spring-projects-issues
Copy link
Collaborator

Chris Beams opened SPR-7467 and commented

At 7,500 lines and over 360,000 characters, beans.xml is by far the largest docbook source artifact in the Spring reference documentation.

This means extremely slow rendering times for docbook wysiwyg tools such as oXygen Author XML.

Proposed is that this file be split up into four files, simply named:

  • beans.xml - IoC <chapter/> container and <xi:include/> elements including the following:
  • beans-1.xml - first third of content
  • beans-2.xml - second third of content
  • beans-3.xml - final third of content

Attachments:

Referenced from: commits 9ab2c66

@spring-projects-issues
Copy link
Collaborator Author

Chris Beams commented

All <section/> elements in beans.xml >=~ 500 lines have been broken out
into separate documents with DOCTYPE 'section'. This refactoring makes
working with these files much easier in wysiwyg editors (namely
oXygen Author).

For consistency, this same refactoring should be applied to all other
chapters much larger than 1500 lines, such as aop.xml (3861), mvc.xml
(3466), jdbc.xml (3042), and so on.

beans.xml and the new section files have also been formatted for
consistency and to avoid whitespace diffs as much as possible into the
future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

1 participant