From d32dfd319461b9f4b73c5dcf9ac85781f13e4fcf Mon Sep 17 00:00:00 2001 From: Garen Torikian Date: Sun, 29 Apr 2012 18:22:02 -0700 Subject: [PATCH] Force higher (fixed) Panino; remove needless package.json --- api/ace.html | 2 +- api/anchor.html | 2 +- api/background_tokenizer.html | 2 +- api/document.html | 2 +- api/edit_session.html | 2 +- api/editor.html | 2 +- api/placeholder.html | 2 +- api/range.html | 2 +- api/scrollbar.html | 2 +- api/search.html | 2 +- api/selection.html | 2 +- api/split.html | 20 ++++++++++---------- api/token_iterator.html | 2 +- api/tokenizer.html | 2 +- api/undomanager.html | 6 +++--- api/virtual_renderer.html | 2 +- doc/README.md | 24 ++++++++++++++++++++---- doc/additionalObjs.json | 19 +++++++++++++++++++ doc/build.js | 2 +- doc/package.json | 15 --------------- doc/resources/ace/templates/lib.jade | 12 +++--------- doc/resources/common_layout.jade | 14 +------------- package.json | 2 +- 23 files changed, 72 insertions(+), 70 deletions(-) delete mode 100644 doc/package.json diff --git a/api/ace.html b/api/ace.html index ffd674d8..03cf704d 100644 --- a/api/ace.html +++ b/api/ace.html @@ -104,7 +104,7 @@
-

Ace[edit] +

Ace[edit]

  • diff --git a/api/anchor.html b/api/anchor.html index c7745c5a..2ed10b26 100644 --- a/api/anchor.html +++ b/api/anchor.html @@ -104,7 +104,7 @@
    -

    Anchor[edit] +

    Anchor[edit]

    • Events (1) diff --git a/api/background_tokenizer.html b/api/background_tokenizer.html index c54a62cf..c5ce5431 100644 --- a/api/background_tokenizer.html +++ b/api/background_tokenizer.html @@ -104,7 +104,7 @@
      -

      BackgroundTokenizer[edit] +

      BackgroundTokenizer[edit]

      • diff --git a/api/document.html b/api/document.html index 336c25cd..8dfe5efc 100644 --- a/api/document.html +++ b/api/document.html @@ -104,7 +104,7 @@
        -

        Document[edit] +

        Document[edit]

        • diff --git a/api/edit_session.html b/api/edit_session.html index bddcf8d0..b0e543fa 100644 --- a/api/edit_session.html +++ b/api/edit_session.html @@ -104,7 +104,7 @@
          -

          EditSession[edit] +

          EditSession[edit]

          • Events (3) diff --git a/api/editor.html b/api/editor.html index 1d272c83..daf3fe68 100644 --- a/api/editor.html +++ b/api/editor.html @@ -104,7 +104,7 @@
            -

            Editor[edit] +

            Editor[edit]

            • Events (18) diff --git a/api/placeholder.html b/api/placeholder.html index 1158ed7a..cf3e073d 100644 --- a/api/placeholder.html +++ b/api/placeholder.html @@ -104,7 +104,7 @@
              -

              PlaceHolder[edit] +

              PlaceHolder[edit]

              • Events (2) diff --git a/api/range.html b/api/range.html index e0e8314c..1c7f7e70 100644 --- a/api/range.html +++ b/api/range.html @@ -104,7 +104,7 @@
                -

                Range[edit] +

                Range[edit]

                • diff --git a/api/scrollbar.html b/api/scrollbar.html index 40ba1925..71e8b3ad 100644 --- a/api/scrollbar.html +++ b/api/scrollbar.html @@ -104,7 +104,7 @@
                  -

                  ScrollBar[edit] +

                  ScrollBar[edit]

                  • Events (1) diff --git a/api/search.html b/api/search.html index d56e801d..8675899c 100644 --- a/api/search.html +++ b/api/search.html @@ -104,7 +104,7 @@
                    -

                    Search[edit] +

                    Search[edit]

                    • diff --git a/api/selection.html b/api/selection.html index 688629e2..b703ce6f 100644 --- a/api/selection.html +++ b/api/selection.html @@ -104,7 +104,7 @@
                      -

                      Selection[edit] +

                      Selection[edit]

                      • diff --git a/api/split.html b/api/split.html index 573a713f..01e64844 100644 --- a/api/split.html +++ b/api/split.html @@ -104,7 +104,7 @@
                        -

                        Split.blur[edit] +

                        Split.blur[edit]

                        • @@ -163,7 +163,7 @@
                          -

                          Split.focus[edit] +

                          Split.focus[edit]

                          • @@ -222,7 +222,7 @@
                            -

                            Split.getCurrentEditor[edit] +

                            Split.getCurrentEditor[edit]

                            • @@ -280,7 +280,7 @@
                              -

                              Split.getEditor[edit] +

                              Split.getEditor[edit]

                              • @@ -339,7 +339,7 @@
                                -

                                Split.getSplits[edit] +

                                Split.getSplits[edit]

                                • @@ -397,7 +397,7 @@
                                  -

                                  Split.resize[edit] +

                                  Split.resize[edit]

                                  • @@ -455,7 +455,7 @@
                                    -

                                    Split.setFontSize[edit] +

                                    Split.setFontSize[edit]

                                    • @@ -515,7 +515,7 @@
                                      -

                                      Split.setSession[edit] +

                                      Split.setSession[edit]

                                      • @@ -575,7 +575,7 @@
                                        -

                                        Split.setTheme[edit] +

                                        Split.setTheme[edit]

                                        • @@ -635,7 +635,7 @@
                                          -

                                          Split.UndoManagerProxy[edit] +

                                          Split.UndoManagerProxy[edit]

                                          • diff --git a/api/token_iterator.html b/api/token_iterator.html index 0f82cded..29a0be0f 100644 --- a/api/token_iterator.html +++ b/api/token_iterator.html @@ -104,7 +104,7 @@
                                            -

                                            TokenIterator[edit] +

                                            TokenIterator[edit]

                                            • diff --git a/api/tokenizer.html b/api/tokenizer.html index bf5b37f2..f2a60a99 100644 --- a/api/tokenizer.html +++ b/api/tokenizer.html @@ -104,7 +104,7 @@
                                              -

                                              Tokenizer[edit] +

                                              Tokenizer[edit]

                                              • diff --git a/api/undomanager.html b/api/undomanager.html index 198ea6d9..7fa44b49 100644 --- a/api/undomanager.html +++ b/api/undomanager.html @@ -104,7 +104,7 @@
                                                -

                                                UndoManager[edit] +

                                                UndoManager[edit]

                                                • @@ -199,10 +199,10 @@
                                                -

                                                Provides a means for implementing your own undo manager. options has one property, args, an Array, w...

                                                +

                                                Provides a means for implementing your own undo manager. options has one property, args, an undefined, w...

                                                -

                                                Provides a means for implementing your own undo manager. options has one property, args, an Array, with two elements: +

                                                Provides a means for implementing your own undo manager. options has one property, args, an undefined, with two elements: args[0] is an array of deltas args[1] is the document to associate with

                                                diff --git a/api/virtual_renderer.html b/api/virtual_renderer.html index 26699bbe..de13f589 100644 --- a/api/virtual_renderer.html +++ b/api/virtual_renderer.html @@ -104,7 +104,7 @@
                                                -

                                                VirtualRenderer[edit] +

                                                VirtualRenderer[edit]

                                                • diff --git a/doc/README.md b/doc/README.md index b49ec651..38dbd144 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,11 +1,27 @@ # Introduction -The beginnings of an API documentation set for Ace. +The API doc build takes a look a source Javascript files in the _lib_ directory, and turns it into HTML output in the _api_ directory. It uses [Panino](https://github.com/gjtorikian/panino-docs) to perform the conversion. + +For any questions, please see that repo. # Building -In this directory, just run +In the root directory, just run: - node build.js [path_to_ndoc] + make doc -`[path_to_ndoc]` is a required argument, indicating the location of your ndoc install, relative to the `build.js` file. By default, this will point to `./build/ndoc/bin/ndoc`. \ No newline at end of file +In this directory, just run: + + node build.js + +# Build File + +Here's a breakdown of what the arguments in _build.js_ are doing: + +`--path=srcPath`: The location of the Ace source +`-o=../api/`: The location of the output +`-a=./additionalObjs.json`: A list of URLs to use for "missing objects" that the documentation requires +`-i=index.md`: The location of the Ace index/landing page +`-t=Ace API`: The title of the documentation +`--skin=./resources/ace/`: The location of all the templates and design +`-s`: Choose to split each class into its own file \ No newline at end of file diff --git a/doc/additionalObjs.json b/doc/additionalObjs.json index 6eb756a2..45903778 100644 --- a/doc/additionalObjs.json +++ b/doc/additionalObjs.json @@ -1,4 +1,23 @@ { + "Array" : "http://www.nodemanual.org/latest/js_doc/Array.html", + "Boolean" : "http://www.nodemanual.org/latest/js_doc/Boolean.html", + "Date" : "http://www.nodemanual.org/latest/js_doc/Date.html", + "Error" : "http://www.nodemanual.org/latest/js_doc/Error.html", + "EvalError" : "http://www.nodemanual.org/latest/js_doc/EvalError.html", + "RangeError" : "http://www.nodemanual.org/latest/js_doc/RangeError.html", + "ReferenceError" : "http://www.nodemanual.org/latest/js_doc/ReferenceError.html", + "SyntaxError" : "http://www.nodemanual.org/latest/js_doc/SyntaxError.html", + "TypeError" : "http://www.nodemanual.org/latest/js_doc/TypeError.html", + "URIError" : "http://www.nodemanual.org/latest/js_doc/URIError.html", + "Function" : "http://www.nodemanual.org/latest/js_doc/Function.html", + "Infinity" : "http://www.nodemanual.org/latest/js_doc/Infinity.html", + "JSON" : "http://www.nodemanual.org/latest/js_doc/JSON.html", + "Math" : "http://www.nodemanual.org/latest/js_doc/Math.html", + "NaN" : "http://www.nodemanual.org/latest/js_doc/NaN.html", + "Number" : "http://www.nodemanual.org/latest/js_doc/Number.html", + "Object" : "http://www.nodemanual.org/latest/js_doc/Object.html", + "RegExp" : "http://www.nodemanual.org/latest/js_doc/RegExp.html", + "String" : "http://www.nodemanual.org/latest/js_doc/String.html", "DOMElement": "https://developer.mozilla.org/en/DOM/element", "Event": "https://github.com/ajaxorg/ace/blob/master/lib/ace/lib/event.js", "TextMode": "https://github.com/ajaxorg/ace/blob/master/lib/ace/mode/text.js", diff --git a/doc/build.js b/doc/build.js index 29449f30..81455917 100644 --- a/doc/build.js +++ b/doc/build.js @@ -2,7 +2,7 @@ var panino = require("panino"); var srcPath = process.cwd() + "/../lib/ace"; -panino.main(["--path=" + srcPath, "-o", "../api/", "-a", "./additionalObjs.json", "-i", "index.md", "-t", "Ace API", "--skin", "./resources/ace/"], function(err) { +panino.main(["--path=" + srcPath, "-o", "../api/", "-a", "./additionalObjs.json", "-i", "index.md", "-t", "Ace API", "--skin", "./resources/ace/", "-s"], function(err) { if (err) { console.error(err); process.exit(-1); diff --git a/doc/package.json b/doc/package.json deleted file mode 100644 index 89639d2c..00000000 --- a/doc/package.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "name": "ace_docs", - "version": "0.0.1", - "repository": { - "type": "git", - "url": "git://github.com/ajaxorg/ace.git" - }, - "engines": { - "node": "~0.6.0" - }, - "dependencies": { - "panino" : "~1.0.12" - }, - "devDependencies": {} -} \ No newline at end of file diff --git a/doc/resources/ace/templates/lib.jade b/doc/resources/ace/templates/lib.jade index a9befa1b..ca9b277f 100644 --- a/doc/resources/ace/templates/lib.jade +++ b/doc/resources/ace/templates/lib.jade @@ -217,7 +217,7 @@ mixin api() -var heading = obj.path span.name #{heading} span.editInC9 - mixin formatGHHref(obj.href, 'nodejs_ref_guide') + mixin formatGHHref(obj.fullPath, 'nodejs_ref_guide') -if (true || obj.filename.indexOf("index") < 0) ul(class='nav tabs pos#{pos}', data-tabs='tabs') @@ -258,13 +258,7 @@ mixin links(collection) mixin link(obj) mixin formatGHHref(url, type) - url = url.substring(url.indexOf("src/") + 4) - - if type == 'nodejs_ref_guide' - url = url.substring(0, url.lastIndexOf("#")) - url = 'src/' + url - else if type == 'nodejs_dev_guide' - url = 'src/' + url + url = url.substring(url.indexOf("ace/lib")) -url = url.replace(/\/{2,}/g, "/").replace(/\//g,"%2F") - [edit] \ No newline at end of file + [edit] \ No newline at end of file diff --git a/doc/resources/common_layout.jade b/doc/resources/common_layout.jade index 0a6321c4..31a96eab 100644 --- a/doc/resources/common_layout.jade +++ b/doc/resources/common_layout.jade @@ -83,16 +83,4 @@ mixin identifyBuild(tree, type) -dirPrefix = './' mixin markdown(text, inline) - != markdown(text, inline) - -mixin formatGHHref(url, type) - url = url.substring(url.indexOf("src/") + 4) - - if type == 'nodejs_ref_guide' - url = url.substring(0, url.lastIndexOf("#")) - url = 'src/' + url - else if type == 'nodejs_dev_guide' - url = 'src/' + url - - -url = url.replace(/\/{2,}/g, "/").replace(/\//g,"%2F") - [edit] \ No newline at end of file + != markdown(text, inline) \ No newline at end of file diff --git a/package.json b/package.json index 4bbadad4..49bbf54f 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "amd-loader": "~0.0.4", "libxml": "0.0.x", "dryice": "0.4.2", - "panino" : "~1.0.14" + "panino" : "~1.0.15" }, "engines": { "node": "~0.6.0"