Skip to content

Commit

Permalink
CHM fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@CyberShadow @aG0aep6G
CyberShadow authored and aG0aep6G committed Jan 14, 2016
1 parent df3f31a commit c8e305d
Show file tree
Hide file tree
Showing 6 changed files with 147 additions and 102 deletions.
35 changes: 34 additions & 1 deletion chm-nav.dd
View file
Expand Up @@ -2,7 +2,36 @@ Ddoc


Macros:
DDOC=[$(NAVIGATION)]
DDOC=
[
{
"hook" : "",
"root" : "",
"nav" : [{"t":"D Programming Language","a":"index.html"},$(NAVIGATION)]
},
{
"hook" : "Language Reference",
"root" : "",
"nav" : [$(SUBNAV_SPEC)]
},
{
"hook" : "Library Reference",
"root" : "phobos/",
"nav" : [{"t":"Library Reference","a":"index.html"},$(MODULE_MENU)]
},
{
"hook" : "Articles",
"root" : "",
"nav" : [$(SUBNAV_ARTICLES)]
},
{
"hook" : "D-Specific Tools",
"root" : "",
"nav" : [$(SUBNAV_TOOLS)]
},
]
_=

DIVID=$2
B=$0
TT=$0
Expand All @@ -14,15 +43,19 @@ LATEST=
MENU={"t":"$2","a":"$1"},
MENU_W_SUBMENU=[{"t":"$2"},
MENU_W_SUBMENU_END=
MENU_W_SUBMENU_LINK=[{"t":"$2","a":"$1"},
ITEMIZE=$(ITEMS_HELPER $1, $+)],
ITEMS_HELPER = $1$(ITEMS_HELPER $+)
SUBMENU=$(SUBMENU2 $1,$+)],
SUBMENU2={"t":"$2","a":"$1"},
$(SUBMENU3 $+)
SUBMENU3=$(SUBMENU2 $+)
SUBNAV_TEMPLATE=$0
SUBNAV_HEAD={"t":"$3","a":"$2"},
MODULE=
{"t":"$1","a":"$2$(JOIN_LINE_TAIL $+).html"},
PACKAGE=[$1$(ITEMIZE $+)
PACKAGE_NAME={"t":"$1"},
ESCAPES=/"/\"/
ROOT_DIR=
_=
173 changes: 94 additions & 79 deletions chmgen.d
View file
Expand Up @@ -17,79 +17,6 @@ string docRoot = `.`;

// ********************************************************************

class Nav
{
string title, url;
Nav[] children;
}

Nav loadNav(string fileName, string base, bool warn)
{
import std.json;
auto text = fileName
.readText()
.replace("\r", "")
.replace("\n", "")
// .replaceAll(re!`/\*.*?\*/`, "")
.replaceAll(re!`,\s*\]`, `]`)
;
scope(failure) std.file.write("error.json", text);
auto json = text.parseJSON();

Nav parseNav(JSONValue json)
{
if (json.type == JSON_TYPE.ARRAY)
{
auto nodes = json.array;
auto parsedNodes = nodes.map!parseNav.array().filter!`a`.array();
if (!parsedNodes.length)
{
if (warn)
stderr.writeln("Warning: Empty navigation group");
return null;
}

auto root = parsedNodes[0];
root.children = parsedNodes[1..$];
return root;
}
else
{
auto obj = json.object;
auto nav = new Nav;
nav.title = obj["t"].str.strip();
if ("a" in obj)
{
auto url = absoluteUrl(base, obj["a"].str.strip());
if (url.canFind(`://`))
{
stderr.writeln("Skipping external navigation item: " ~ url);
return null;
}
else
if (!exists(`chm/files/` ~ url))
{
if (warn)
stderr.writeln("Warning: Item in navigation does not exist: " ~ url);
else
stderr.writeln("Skipping non-existent navigation item: " ~ url);
//url = "http://dlang.org/" ~ url;
return null;
}
else
nav.url = `files\` ~ url.backSlashes();
}
return nav;
}
}

return parseNav(json);
}

Nav nav;

// ********************************************************************

struct KeyLink { string anchor; int confidence; bool sawAnchor; }
KeyLink[string][string] keywords; // keywords[keyword][original url w/o anchor] = anchor/confidence
string[] keywordList; // Sorted alphabetically, case-insensitive
Expand All @@ -101,6 +28,11 @@ void addKeyword(string keyword, string link, int confidence, bool isAnchor = tru
if (!keyword.length)
return;
link = link.strip();

while (link.skipOver("./")) {}
if (link.endsWith("/"))
link ~= "index.html";

string file = link.stripAnchor();
string anchor = link.getAnchor();

Expand Down Expand Up @@ -204,7 +136,7 @@ void main(string[] args)

foreach (m; src.matchAll(re!(`<a `~attrs~`href="([^"]*)"`~attrs~`>(.*?)</a>`)))
if (!m.captures[1].canFind("://"))
addKeyword(m.captures[2].replaceAll(re!`<.*?>`, ``), absoluteUrl(fileName, m.captures[1]), 4, false);
addKeyword(m.captures[2].replaceAll(re!`<.*?>`, ``), absoluteUrl(fileName, m.captures[1].strip()), 4, false);

// Disable scripts

Expand Down Expand Up @@ -246,15 +178,98 @@ void main(string[] args)

// ************************************************************

class Nav
{
string title, url;
Nav[] children;
}

Nav nav;

void loadNavigation()
{
stderr.writeln("Loading navigation");

nav = loadNav("chm-nav-doc.json", ``, false);
auto phobosIndex = `files\phobos\index.html`;
auto navPhobos = nav.children.find!(child => child.url == phobosIndex).front;
auto phobos = loadNav("chm-nav-std.json", `phobos/`, true);
navPhobos.children = phobos.children.filter!(child => child.url != phobosIndex).array();
import std.json;
auto text = "chm-nav.json"
.readText()
.replace("\r", "")
.replace("\n", "")
// .replaceAll(re!`/\*.*?\*/`, "")
.replaceAll(re!`,\s*\]`, `]`)
;
scope(failure) std.file.write("error.json", text);
auto json = text.parseJSON();

Nav[string] subNavs;

foreach_reverse (node; json.array)
{
auto hook = node["hook"].str;
auto root = node["root"].str;

Nav parseNav(JSONValue json)
{
if (json.type == JSON_TYPE.ARRAY)
{
auto nodes = json.array;
auto parsedNodes = nodes.map!parseNav.array().filter!`a`.array();
if (!parsedNodes.length)
{
if (/*warn*/true)
stderr.writeln("Warning: Empty navigation group");
return null;
}

auto root = parsedNodes[0];
root.children = parsedNodes[1..$];
return root;
}
else
{
auto obj = json.object;
auto nav = new Nav;
nav.title = obj["t"].str.strip();
if ("a" in obj)
{
auto url = absoluteUrl(root, obj["a"].str.strip());
if (url.canFind(`://`))
{
stderr.writeln("Skipping external navigation item: " ~ url);
return null;
}
else
if (!exists(`chm/files/` ~ url))
{
if (/*warn*/true)
stderr.writeln("Warning: Item in navigation does not exist: " ~ url);
else
stderr.writeln("Skipping non-existent navigation item: " ~ url);
//url = "http://dlang.org/" ~ url;
return null;
}
else
nav.url = `files\` ~ url.backSlashes();
}
auto psubNav = nav.title in subNavs;
if (psubNav)
{
// if (nav.title != psubNav.title)
// stderr.writefln("Warning: Sub-navigation title mismatch: %s / %s", nav.title, psubNav.title);
// if (nav.url != psubNav.url)
// stderr.writefln("Warning: Sub-navigation url mismatch: %s / %s", nav.url, psubNav.url);
nav.url = psubNav.url;
nav.children = psubNav.children;
}
return nav;
}
}

auto nav = parseNav(node["nav"]);
subNavs[hook] = nav;
}

.nav = subNavs[""];
}

// ************************************************************
Expand Down
3 changes: 2 additions & 1 deletion css/style.css
View file
Expand Up @@ -1196,7 +1196,8 @@ img
}

body.chm div#news,
body.chm div#navigation,
body.chm div.subnav-helper,
body.chm div.subnav,
body.chm div#top
{
display: none;
Expand Down
16 changes: 8 additions & 8 deletions dlang.org.ddoc
View file
Expand Up @@ -340,10 +340,7 @@ _=
SUBNAV=
SUBNAV_ARTICLES=
$(SUBNAV_TEMPLATE
$(DIVC head,
$(H2 Articles)
$(P $(LINK2 $(ROOT_DIR)articles.html, overview))
)
$(SUBNAV_HEAD Articles, articles.html, overview)
$(UL $(SUBMENU2
$(ROOT_DIR)faq.html, FAQ,
$(ROOT_DIR)const-faq.html, const(FAQ),
Expand All @@ -370,15 +367,18 @@ $(SUBNAV_TEMPLATE
))
)

SUBNAV_HEAD=
$(DIVC head,
$(H2 $1)
$(TC p, $4,
$(LINK2 $(ROOT_DIR)$2, $3))
)
SUBNAV_TEMPLATE=$(DIVC subnav-helper) $(DIVC subnav, $0)
_=

SUBNAV_TOOLS=
$(SUBNAV_TEMPLATE
$(DIVC head,
$(H2 D-Specific Tools)
$(P $(LINK2 $(ROOT_DIR)tools.html, overview))
)
$(SUBNAV_HEAD D-Specific Tools, tools.html, overview)
$(UL $(SUBMENU2
https://github.com/Hackerpilot/dfix, dfix,
https://github.com/Hackerpilot/dfmt, dfmt,
Expand Down
9 changes: 3 additions & 6 deletions spec/spec.ddoc
View file
Expand Up @@ -2,13 +2,10 @@ ROOT_DIR = ../
ROOT = ..
SEARCHDEFAULT_SPEC = selected

SUBNAV=
SUBNAV=$(SUBNAV_SPEC)
SUBNAV_SPEC=
$(SUBNAV_TEMPLATE
$(DIVC head,
$(H2 Language Reference)
$(TC p, subnav-duplicate,
$(LINK2 $(ROOT_DIR)spec/spec.html, table of contents))
)
$(SUBNAV_HEAD Language Reference, spec/spec.html, table of contents, subnav-duplicate)
$(UL
$(SUBMENU2
$(ROOT_DIR)spec/intro.html, Introduction,
Expand Down
13 changes: 6 additions & 7 deletions win32.mak
View file
Expand Up @@ -591,18 +591,17 @@ chm : d.chm
chmgen.exe : chmgen.d
$(DMD) -g chmgen

chm\d.hhp chm\d.hhc chm\d.hhk : chmgen.exe chm-nav-doc.json chm-nav-std.json $(TARGETS)
chm\d.hhp chm\d.hhc chm\d.hhk : chmgen.exe chm-nav.json $(TARGETS)
chmgen

d.chm : chm\d.hhp chm\d.hhc chm\d.hhk
chm\d.chm : chm\d.hhp chm\d.hhc chm\d.hhk
-cmd /C "cd chm && "$(HHC)" d.hhp"
copy /Y chm\d.chm d.chm

chm-nav-doc.json : $(DDOC) chm-nav.dd
$(DMD) -o- -c -Df$@ $(DDOC) chm-nav.dd
d.chm : chm\d.chm
copy /Y chm\d.chm d.chm

chm-nav-std.json : $(DDOC) $(DDOC_STD) chm-nav.dd
$(DMD) -o- -c -Df$@ $(DDOC) $(DDOC_STD) chm-nav.dd
chm-nav.json : $(DDOC) std.ddoc spec\spec.ddoc modlist-release.ddoc chm-nav.dd
$(DMD) -o- -c -Df$@ $**

d.tag : chmgen.exe $(TARGETS)
chmgen --only-tags
Expand Down

0 comments on commit c8e305d

Please sign in to comment.