Opened 19 years ago

Closed 19 years ago

#1075 closed defect (fixed)

Create a new sources layout

Reported by: manuel@… Owned by: manuel@…
Priority: lowest Milestone:
Component: Book Version: SVN
Severity: normal Keywords:
Cc:

Description

Due the complexity of the cross-build/multi-arch LFS book we need to develop a new files structure that could made more easy and minor error-prone to edit the sources. Also, we need to find a way to render the books avoiding duplicated files. Please, add your comments and suggestions here.

Change History (4)

comment:1 by jim@…, 19 years ago

Decided to try something on my own. I have converted one section currently the cross-tools section.

Output http://documents.jg555.com/cross-lfs-new Test svn - http://svn.jg555.com/viewcvs.cgi/?root=cross-lfs

I will convert more sections, but it involves an index for each architecture, a chapter file for each architecture, and a common directory.

comment:2 by Jeremy Huntwork, 19 years ago

Manuel, have you taken a look at Jim's structure he has yet? To me, though I'm XML/DocBook expert, it seems to be a very logical way of structuring the book.

Each arch has their own index.xml page (specifically named) and for each main section of the book, ie, introduction, there is a common directory and arch-specific directories, containing the xml files for that section.

It helps because in many areas it avoids all the "arch" tags and makes editing for a particular arch much easier.

Anyway, anxious to hear your thoughts.

comment:3 by manuel@…, 19 years ago

Yes, I also agree with many aspects of that structure. Profiles are good when there is only two or three variants, four max. But we have now several different architectures. Try to manage they using the arch attribute will be a pain. I vote for do that changes in all chapters. Later I will see is there is a way to render the books in one step skipping duplicated files (using a different profile engine, hacking the TOC and Navigational engines or, maybe, creating the TOCs manually, I'm evaluating different theoretical methods)

comment:4 by manuel@…, 19 years ago

Resolution: fixed
Status: newclosed

To avoid rendering duplicated XML files isn't possible due that actually there is no HTML duplicated files: each HTML file need their own navigational links to can read each arch book linearly, then we can't reuse an unique HTML file for all books. To create a <set> of books isn't possible also due duplicated IDs that can't be avoided (the ones from common/ files and the ones used to create the Index.) Then, IMHO, the current method to build the books is the best one that we can have for now. For the sources structure, look like the current one allow to made easilly by-arch changes. But keeping in mind that we should to use XInclude tags for all text that is common in different files, to can edit also that commom text in an easy way.

Note: See TracTickets for help on using tickets.