mirror/ede
1
0
Fork 0
mirror of https://github.com/edeproject/ede.git synced 2023-08-10 21:13:03 +03:00
Code Issues Projects Releases Wiki Activity

EdeManual will use tidy tool if available to reformat html pages.

Browse Source 
Added EdeManualWithToc rule that will build Table of Contents on page.
This commit is contained in:
Sanel Zukan 2008-08-05 14:28:46 +00:00
parent 545bbbb330
commit 8cfff8f370
1 changed files with 33 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
build/Doc.jam
View File

@ -15,7 +15,7 @@ MANUALDIR = "$(DOCDIR)/manual" ;
# Must be relative to "docs" dir # Must be relative to "docs" dir
MANUALICONS = "images" ; MANUALICONS = "images" ;
# EdeManual [file] : [optinal-images] ; # EdeManual [file] : [optinal-images] : "make-toc" ;
# Creates [file].html via asciidoc. If [optinal-images] are # Creates [file].html via asciidoc. If [optinal-images] are
# given, they will be copied in $(DOCICONS). # given, they will be copied in $(DOCICONS).
rule EdeManual rule EdeManual
@ -25,6 +25,9 @@ rule EdeManual
return ; return ;
} }
# see if we have tidy installed
local tidy_paths = [ Glob $(PATH) : tidy ] ;
local html_ext = ".html" ; local html_ext = ".html" ;
local path = $(SEARCH_SOURCE) ; local path = $(SEARCH_SOURCE) ;
@ -46,7 +49,19 @@ rule EdeManual
# set output to $(MANUALDIR) directory # set output to $(MANUALDIR) directory
MakeLocate $(target) : $(MANUALDIR) ; MakeLocate $(target) : $(MANUALDIR) ;
AsciiDoc1 $(target) : $(source) ; # a hack to create Table of Content
# seems that this is the only way asciidoc can do it
if $(3) = "make-toc" {
TOC_FLAG on $(target) = "-a toc" ;
}
if ! $(tidy_paths) {
AsciiDoc1 $(target) : $(source) ;
} else {
TIDY on $(target) = "tidy" ;
AsciiDoc2 $(target) : $(source) ;
}
LocalClean clean : $(target) ; LocalClean clean : $(target) ;
} }
@ -70,9 +85,24 @@ rule EdeManual
} }
} }
# EdeManualWithToc [file] : [optinal-images] ;
# The same as EdeManual, but it will build Table of Contents
rule EdeManualWithToc
{
EdeManual $(1) : $(2) : "make-toc" ;
}
actions AsciiDoc1 actions AsciiDoc1
{ {
$(ASCIIDOC) -a icons -a iconsdir=$(MANUALICONS) -a edeversion="EDE 2.0" -o $(<) $(>) $(ASCIIDOC) $(TOC_FLAG) -a icons -a iconsdir=$(MANUALICONS) -a edeversion="EDE 2.0" -o $(<) $(>)
}
# version with tidy (utility to clean HTML/XHTML code)
actions AsciiDoc2
{
$(ASCIIDOC) $(TOC_FLAG) -a icons -a iconsdir=$(MANUALICONS) -a edeversion="EDE 2.0" -o "$(<).tmp" $(>)
$(TIDY) -q -i "$(<).tmp" > "$(<)"
$(RM) "$(<).tmp"
} }
NotFile doc ; NotFile doc ;