Email lists > Gentoo documentation discussion > Re: [gentoo-doc] 2007.1 Handbook mojo / include feature > Re: [gentoo-doc] 2007.1 Handbook mojo / include feature

Re: [gentoo-doc] 2007.1 Handbook mojo / include feature




This post if a part of  this thread

2008-01-01 15:51:58
Re: 2007.1 Handbook mojo / include feature 
>>> THE LOGIC IS CHAPTERS, SECTIONS AND BODIES CAN
ALL BE INCLUDED, I.E. THEY
>>> EITHER HAVE THE CURRENT STRUCTURE OR CONTAIN A
SINGLE <INCLUDE HREF=""/>
>>> ELEMENT. A CHAPTER CAN INCLUDE CHAPTERS, A
SECTION CAN INCLUDE SECTIONS AND A
>>> BODY CAN INCLUDE BODIES.
>> AWESOME. SO THE INCLUDES ARE ALL INLINE, AND DON'T
NEED TO BE SPECIFIED
>> IN THE HANDBOOK-$ARCH.XML FILES.
> 
> THEY APPEAR WHERE THEY ARE SUPPOSED TO BE INCLUDED,
JUST LIKE IN THE CURRENT
> HANDBOOK FORMAT, E.G. A <CHAPTER> EITHER CONTAINS
ITS CONTENT AS IT DOES NOW
> *XOR* A SINGLE <INCLUDE> ELEMENT THAT POINTS TO
AN XML FILES THAT CONTAINS
> CHAPTER(S).
> 
> INCLUDING CHAPTERS IN A GUIDE:
> 
> <CHAPTER ID="FOO" TEST="1">
>  <INCLUDE HREF="BAR.XML"/>
> </CHAPTER>
> 
> OR IN A HANDBOOK:
> 
> <SECTION ID="FOO" TEST="1">
>  <INCLUDE HREF="BAR.XML"/>
> </SECTION>
> 
> THE INCLUDED FILE IS EXPECTED TO CONTAIN ONE OR MORE
<CHAPTER>
> 
> 
> INCLUDING SECTIONS IN A GUIDE:
> 
> <SECTION ID="FOO" TEST="1">
>  <INCLUDE HREF="BAR.XML"/>
> </SECTION>
> 
> OR IN A HANDBOOK:
> 
> <SUBSECTION ID="FOO"
TEST="1">
>  <INCLUDE HREF="BAR.XML"/>
> </SUBSECTION>
> 
> THE INCLUDED FILE IS EXPECTED TO CONTAIN ONE OR MORE
<SECTION>
> 
> 
> INCLUDING BODIES:
> 
> <BODY ID="FOO" TEST="1">
>  <INCLUDE HREF="BAR.XML"/>
> </BODY>
> 
> THE INCLUDED FILE IS EXPECTED TO CONTAIN ONE OR MORE
<BODY>


***
READ THE ABOVE EXPLANATION AGAIN, TWICE, BECAUSE THAT'S THE
ONLY DOCUMENTATION
AVAILABLE AT THE MOMENT 
***


> BTW, I STILL THINK IT SUCKS TO HAVE DIFFERENT NAMES FOR
THE SAME THINGS IN
> GUIDES AND BOOKS, AND EVEN MORE TO HAVE THE SAME NAMES
FOR DIFFERENT THINGS :(

STILL DOES.

> CONDITIONAL STILL APPLY TO THE SAME ELEMENTS, NOTHING'S
CHANGED AT ALL.
> NOTHING IS PREVENTING AN INCLUDED CHAPTER FROM
INCLUDING SECTIONS.
> 
> PLEASE NOTE THAT IT'S VERY MUCH USELESS TO FACTOR OUT
JUST A COUPLE OF
> SENTENCES. IT ADDS UNNECESSARY COMPLEXITY AND IT MAKES
IT HARDER TO EVALUATE
> THE IMPACT OF A CHANGE TO A SHARED FILE.
> 
> IT WON'T BE AVAILABLE FOR THE NEXT RELEASE AND IT
WOULDN'T BE REASONABLE TO
> IMPLEMENT THIS RIGHT BEFORE A RELEASE.

SINCE GENTOO DOES NOT HAVE ANY RELEASES... 

I HAD A FULL DAY AT HOME AND I THOUGHT I COULD GET THIS
DONE.
DTDS AND XSLS HAVE BEEN EDITED.
X86 GUICK GUIDES (NORMAL & RAID+LVM2) MAKE USE OF THIS
FEATURE.
IF YOU NOTICE ANYTHING WEIRD, THINK AGAIN, THEN ASK/FILE A
BUG, I PROBABLY
FORGOT SOMETHING.

FYI, <PRE> IN HANDBOOKS ARE NOW NUMBERED EXACTLY AS
THEY ARE IN NORMAL GUIDES,
AND THEY ARE UNIQUE IN ?FULL=1 VERSIONS.


HAPPY NEW YEAR,
-- 
/  XAVIER NEYS
_ GENTOO DOCUMENTATION PROJECT
/
/ HTTP://WWW.GENTOO.ORG/DOC/EN/

about | contact  Other archives ( Real Estate discussion Medical topics )