diff options
| -rw-r--r-- | compiler/docgen.nim | 23 | ||||
| -rw-r--r-- | config/nimdoc.cfg | 2 | ||||
| -rw-r--r-- | tools/nimweb.nim | 8 | ||||
| -rw-r--r-- | tools/website.tmpl | 4 |
4 files changed, 33 insertions, 4 deletions
diff --git a/compiler/docgen.nim b/compiler/docgen.nim index 35acf1379..ab513d2cc 100644 --- a/compiler/docgen.nim +++ b/compiler/docgen.nim @@ -23,6 +23,7 @@ type id: int # for generating IDs toc, section: TSections indexValFilename: string + gaId: string # Google Analytics ID, null if doesn't exist seenSymbols: StringTableRef # avoids duplicate symbol generation for HTML. PDoc* = ref TDocumentor ## Alias to type less. @@ -61,6 +62,8 @@ proc newDocumentor*(filename: string, config: StringTableRef): PDoc = initRstGenerator(result[], (if gCmd != cmdRst2tex: outHtml else: outLatex), options.gConfigVars, filename, {roSupportRawDirective}, docgenFindFile, compilerMsgHandler) + if config.hasKey("doc.googleAnalytics"): + result.gaId = config["doc.googleAnalytics"] result.seenSymbols = newStringTable(modeCaseInsensitive) result.id = 100 @@ -534,6 +537,7 @@ proc genOutFile(d: PDoc): PRope = var code, content: PRope title = "" + analytics = "" var j = 0 var tmp = "" renderTocEntries(d[], j, 1, tmp) @@ -553,6 +557,21 @@ proc genOutFile(d: PDoc): PRope = # Modules get an automatic title for the HTML, but no entry in the index. title = "Module " & extractFilename(changeFileExt(d.filename, "")) + # if there exists an analytics id, use it + if d.gaId != nil: + analytics = """ +<script> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', '$1', 'auto'); + ga('send', 'pageview'); + +</script> + """ % [d.gaId] + let bodyname = if d.hasToc: "doc.body_toc" else: "doc.body_no_toc" content = ropeFormatNamedVars(getConfigVar(bodyname), ["title", "tableofcontents", "moduledesc", "date", "time", "content"], @@ -562,10 +581,10 @@ proc genOutFile(d: PDoc): PRope = # XXX what is this hack doing here? 'optCompileOnly' means raw output!? code = ropeFormatNamedVars(getConfigVar("doc.file"), ["title", "tableofcontents", "moduledesc", "date", "time", - "content", "author", "version"], + "content", "author", "version", "analytics"], [title.toRope, toc, d.modDesc, toRope(getDateStr()), toRope(getClockStr()), content, d.meta[metaAuthor].toRope, - d.meta[metaVersion].toRope]) + d.meta[metaVersion].toRope, analytics.toRope]) else: code = content result = code diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg index 3abae7388..3375460cc 100644 --- a/config/nimdoc.cfg +++ b/config/nimdoc.cfg @@ -86,6 +86,7 @@ $moduledesc $content """ +# * $analytics: Google analytics location, includes <script> tags doc.file = """<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> @@ -1243,6 +1244,7 @@ dt pre > span.Operator ~ span.Identifier, dt pre > span.Operator ~ span.Operator </div> </div> </div> +$analytics </body> </html> """ diff --git a/tools/nimweb.nim b/tools/nimweb.nim index 74f561b52..0cf19096d 100644 --- a/tools/nimweb.nim +++ b/tools/nimweb.nim @@ -23,6 +23,7 @@ type gitCommit: string quotations: Table[string, tuple[quote, author: string]] numProcessors: int # Set by parallelBuild:n, only works for values > 0. + gaId: string # google analytics ID, nil means analytics are disabled TRssItem = object year, month, day, title: string TAction = enum @@ -144,7 +145,12 @@ proc parseCmdLine(c: var TConfigData) = c.vars[substr(val, 0, idx-1)] = substr(val, idx+1) of "website": action = actOnlyWebsite of "pdf": action = actPdf - else: quit(usage) + of "googleanalytics": + c.gaId = val + c.nimArgs.add("--doc.googleAnalytics:" & val & " ") + else: + echo("Invalid argument $1" % [key]) + quit(usage) of cmdEnd: break if c.infile.len == 0: quit(usage) diff --git a/tools/website.tmpl b/tools/website.tmpl index 6f7a216a5..2197e361c 100644 --- a/tools/website.tmpl +++ b/tools/website.tmpl @@ -192,13 +192,15 @@ View at: localhost:5000 </footer> <script> +# if c.gaId != nil: (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); - ga('create', 'UA-48159761-1', 'nim-lang.org'); + ga('create', '${c.gaId}', 'nim-lang.org'); ga('send', 'pageview'); +# end if var timer; var prevIndex = 0; |