(* @configure_input@ *)
#2 "manual/src/html_processing/src/common.ml.in"
(* ------------ OCaml Web-manual -------------- *)
(* Copyright San Vu Ngoc, 2020
file: common.ml
This file contains functions that are used by process_api.ml and
process_manual.ml *)
open Soup
let debug = not (Array.mem "quiet" Sys.argv)
let dbg =
let printf = Printf.(if debug then kfprintf else ikfprintf) in
let flush =
if debug then
fun ch -> output_char ch '\n'; flush ch
else
ignore
in
fun fmt -> printf flush stdout fmt
let ( // ) = Filename.concat
let process_dir = Filename.current_dir_name
let ocaml_version = "@OCAML_VERSION_SHORT@"
(* Output directory *)
let web_dir = Filename.parent_dir_name // "webman" // ocaml_version
(* Output for manual *)
let docs_maindir = web_dir
let docs_file = ( // ) docs_maindir
(* Output for API *)
let api_dir = web_dir // "api"
(* How to go from manual to api *)
let api_page_url = "api"
(* How to go from api to manual *)
let manual_page_url = ".."
(* Set this to the directory where to find the html sources of all versions: *)
let html_maindir = "../htmlman"
(* Where to get the original html files *)
let html_file = ( // ) html_maindir
let releases_url = "https://ocaml.org/releases/"
let favicon = "favicon.ico"
(**** utilities ****)
let flat_option f o = Option.bind o f
let (<<) f g x = f (g x)
let string_of_opt = Option.value ~default:""
let starts_with substring s =
let l = String.length substring in
l <= String.length s &&
String.sub s 0 l = substring
(**** html processing ****)
(* Return next html element. *)
let rec next node =
match next_element node with
| Some n -> n
| None -> match parent node with
| Some p -> next p
| None -> raise Not_found
let logo_html url =
""
|> parse
let wrap_body ~classes soup =
let body = soup $ "body" in
set_name "div" body;
List.iter (fun c -> add_class c body) classes;
wrap body (create_element "body");
body
(* Add favicon *)
let add_favicon head =
parse ({||})
|> append_child head
(* Update html element with javascript and favicon.
Including script.js for OCaml.org's instance of Plausible Analytics. *)
let update_head ?(search = false) soup =
let head = soup $ "head" in
if search then begin
create_element "script" ~attributes:["src","search.js"]
|> append_child head
end;
create_element "script" ~attributes:["src","scroll.js"]
|> append_child head;
create_element "script" ~attributes:["src","navigation.js"]
|> append_child head;
create_element "script" ~attributes:["src", "https://plausible.ci.dev/js/script.js"; "defer data-domain", "ocaml.org"]
|> append_child head;
add_favicon head
(* Add version number *)
let add_version_link nav text url =
let vnum = create_element "div" ~class_:"toc_version" in
let a = create_element "a" ~inner_text:text
~attributes:["href", url; "id", "version-select"] in
append_child vnum a;
prepend_child nav vnum
let add_sidebar_button body =
let btn = create_element "div" ~id:"sidebar-button" in
create_element "span" ~inner_text:"☰"
|> prepend_child btn;
prepend_child body btn
let find_version () = "@OCAML_VERSION_SHORT@"
(*
Local Variables:
compile-command:"dune build"
End:
*)