📚 Docs: @ref links and macros

Project.toml

@@ -2,7 +2,7 @@ name = "Pluto"
 uuid = "c3e4b0f8-55cb-11ea-2926-15256bba5781"
 license = "MIT"
 authors = ["Fons van der Plas <[email protected]>", "Mikołaj Bochenski <[email protected]>"]
-version = "0.11.0"
+version = "0.11.1"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

frontend/components/CellOutput.js

@@ -141,9 +141,22 @@ export class RawHTMLContainer extends Component {
                 console.info("Failed to typeset TeX:")
                 console.info(err)
             }
+
+            if(this.props.on_render != null){
+                this.props.on_render(this.base)
+            }
         })
     }
 
+    shouldComponentUpdate(new_props) {
+        const pure = this.props.pure === true && new_props.pure === true
+        if (pure) {
+            return this.props.body !== new_props.body
+        } else {
+            return true
+        }
+    }
+
     componentDidUpdate() {
         this.render_DOM()
     }

frontend/components/DropRuler.js

@@ -70,7 +70,7 @@ export class DropRuler extends Component {
         /* SELECTIONS */
 
         document.addEventListener("mousedown", (e) => {
-            if (e.target.tagName === "MAIN" || e.target.tagName === "NOTEBOOK" || e.target.tagName === "PREAMBLE") {
+            if (e.button === 0 && (e.target.tagName === "MAIN" || e.target.tagName === "NOTEBOOK" || e.target.tagName === "PREAMBLE")) {
                 this.precompute_cell_edges()
                 const new_index = this.getDropIndexOf(e.pageY)
                 this.setState({

frontend/components/Editor.js

@@ -754,7 +754,12 @@ export class Editor extends Component {
                     }}
                 />
             </main>
-            <${LiveDocs} desired_doc_query=${this.state.desired_doc_query} client=${this.client} notebook=${this.state.notebook} />
+            <${LiveDocs}
+                desired_doc_query=${this.state.desired_doc_query}
+                on_update_doc_query=${(query) => this.setState({ desired_doc_query: query })}
+                client=${this.client}
+                notebook=${this.state.notebook}
+            />
             <footer>
                 <div id="info">
                     <form id="feedback" action="#" method="post">

frontend/components/LiveDocs.js

@@ -69,10 +69,28 @@ export class LiveDocs extends Component {
                     </header>
                     <section>
                         <h1><code>${this.state.shown_query}</code></h1>
-                        <${RawHTMLContainer} body=${this.state.body} />
+                        <${RawHTMLContainer}
+                            body=${this.state.body}
+                            pure=${true}
+                            on_render=${(n) => resolve_doc_reference_links(n, this.props.on_update_doc_query)}
+                        />
                     </section>
                 </helpbox>
             </div>
         `
     }
 }
+
+const resolve_doc_reference_links = (node, on_update_doc_query) => {
+    const as = node.querySelectorAll("a")
+    as.forEach((a) => {
+        const href = a.getAttribute("href")
+        if (href != null && href.startsWith("@ref")) {
+            const query = href.length > 4 ? href.substr(5) : a.textContent
+            a.onclick = (e) => {
+                on_update_doc_query(query)
+                e.preventDefault()
+            }
+        }
+    })
+}

src/runner/PlutoRunner.jl

@@ -491,14 +491,24 @@ function completion_fetcher(query, pos, workspace::Module=current_module)
     (completion_text.(results), loc, found)
 end
 
+# Based on /base/docs/bindings.jl from Julia source code
+function binding_from(x::Expr, workspace::Module=current_module)
+    if x.head == :macrocall
+        Docs.Binding(workspace, x.args[1])
+    elseif x.head == :.
+        Docs.Binding(Core.eval(workspace, x.args[1]), x.args[2])
+    else
+        error("Invalid @var syntax `$x`.")
+    end
+end
+binding_from(s::Symbol, workspace::Module=current_module) = Docs.Binding(workspace, s)
+binding_from(r::GlobalRef, workspace::Module=current_module) = Docs.Binding(r.mod, r.name)
+binding_from(other, workspace::Module=current_module) = error("Invalid @var syntax `$other`.")
+
 function doc_fetcher(query, workspace::Module=current_module)
     try
-        obj = Core.eval(workspace, Meta.parse(query))
-        if obj isa Expr
-            (nothing, :👎)
-        else
-            (repr(MIME"text/html"(), Docs.doc(obj)), :👍)
-        end
+        binding = binding_from(Meta.parse(query), workspace)::Docs.Binding
+        (repr(MIME"text/html"(), Docs.doc(binding)), :👍)
     catch ex
         (nothing, :👎)
     end
@@ -523,7 +533,7 @@ end
 
 """`@bind symbol element`
 
-Returns the HTML `element`, and uses its latest JavaScript value as the definition of `symbol`.
+Return the HTML `element`, and use its latest JavaScript value as the definition of `symbol`.
 
 # Example
 

src/webserver/Static.jl

@@ -107,7 +107,7 @@ function http_router_for(session::ServerSession)
     function serve_sample(req::HTTP.Request)
         uri = HTTP.URI(req.target)
         sample_path = HTTP.URIs.unescapeuri(split(uri.path, "sample/")[2])
-        sample_path_without_dotjl = sample_path[1:end - 3]
+        sample_path_without_dotjl = "sample " * sample_path[1:end - 3]
 
         path = numbered_until_new(joinpath(tempdir(), sample_path_without_dotjl))
         readwrite(joinpath(PKG_ROOT_DIR, "sample", sample_path), path)