From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/erl_docgen/Makefile | 36 + lib/erl_docgen/doc/src/book.xml | 47 + lib/erl_docgen/doc/src/convert.howto | 13 + lib/erl_docgen/doc/src/erl_docgen.txt | 6 + lib/erl_docgen/doc/src/notes.xml | 45 + lib/erl_docgen/priv/Makefile | 34 + lib/erl_docgen/priv/bin/Makefile | 74 + .../priv/bin/codeline_preprocessing.escript | 117 ++ lib/erl_docgen/priv/css/Makefile | 77 + lib/erl_docgen/priv/css/otp_doc.css | 117 ++ lib/erl_docgen/priv/docbuilder_dtd/Makefile | 99 ++ lib/erl_docgen/priv/docbuilder_dtd/application.dtd | 29 + lib/erl_docgen/priv/docbuilder_dtd/appref.dtd | 33 + lib/erl_docgen/priv/docbuilder_dtd/book.dtd | 73 + .../priv/docbuilder_dtd/bookinsidecover.dtd | 36 + lib/erl_docgen/priv/docbuilder_dtd/chapter.dtd | 36 + lib/erl_docgen/priv/docbuilder_dtd/cites.dtd | 35 + lib/erl_docgen/priv/docbuilder_dtd/common.dtd | 87 ++ .../priv/docbuilder_dtd/common.entities.dtd | 24 + .../priv/docbuilder_dtd/common.header.dtd | 42 + .../priv/docbuilder_dtd/common.image.dtd | 21 + lib/erl_docgen/priv/docbuilder_dtd/common.refs.dtd | 40 + .../priv/docbuilder_dtd/common.table.dtd | 25 + lib/erl_docgen/priv/docbuilder_dtd/comref.dtd | 31 + lib/erl_docgen/priv/docbuilder_dtd/cref.dtd | 34 + lib/erl_docgen/priv/docbuilder_dtd/erlref.dtd | 31 + lib/erl_docgen/priv/docbuilder_dtd/fascicules.dtd | 35 + lib/erl_docgen/priv/docbuilder_dtd/fileref.dtd | 31 + lib/erl_docgen/priv/docbuilder_dtd/part.dtd | 29 + lib/erl_docgen/priv/docbuilder_dtd/report.dtd | 138 ++ lib/erl_docgen/priv/docbuilder_dtd/terms.dtd | 36 + .../priv/docbuilder_dtd/xhtml1-frameset.dtd | 1235 ++++++++++++++++ .../priv/docbuilder_dtd/xhtml1-strict.dtd | 978 +++++++++++++ .../priv/docbuilder_dtd/xhtml1-transitional.dtd | 1201 ++++++++++++++++ lib/erl_docgen/priv/dtd_html_entities/Makefile | 75 + .../priv/dtd_html_entities/xhtml-lat1.ent | 196 +++ lib/erl_docgen/priv/dtd_man_entities/Makefile | 75 + .../priv/dtd_man_entities/xhtml-lat1.ent | 195 +++ lib/erl_docgen/priv/images/Makefile | 79 ++ lib/erl_docgen/priv/images/erlang-logo.gif | Bin 0 -> 11588 bytes lib/erl_docgen/priv/images/erlang-logo.png | Bin 0 -> 14795 bytes lib/erl_docgen/priv/images/erlang-old.gif | Bin 0 -> 7549 bytes lib/erl_docgen/priv/js/flipmenu/Makefile | 81 ++ lib/erl_docgen/priv/js/flipmenu/flip_closed.gif | Bin 0 -> 82 bytes lib/erl_docgen/priv/js/flipmenu/flip_open.gif | Bin 0 -> 86 bytes lib/erl_docgen/priv/js/flipmenu/flip_static.gif | Bin 0 -> 109 bytes lib/erl_docgen/priv/js/flipmenu/flipmenu.js | 352 +++++ lib/erl_docgen/priv/js/flipmenu/fm.js | 376 +++++ lib/erl_docgen/priv/nyi.html | 16 + lib/erl_docgen/priv/xsl/Makefile | 80 ++ lib/erl_docgen/priv/xsl/db_html.xsl | 1486 ++++++++++++++++++++ lib/erl_docgen/priv/xsl/db_html_params.xsl | 35 + lib/erl_docgen/priv/xsl/db_man.xsl | 308 ++++ lib/erl_docgen/priv/xsl/db_pdf.xsl | 1129 +++++++++++++++ lib/erl_docgen/priv/xsl/db_pdf_params.xsl | 406 ++++++ lib/erl_docgen/vsn.mk | 22 + 56 files changed, 9836 insertions(+) create mode 100644 lib/erl_docgen/Makefile create mode 100644 lib/erl_docgen/doc/src/book.xml create mode 100644 lib/erl_docgen/doc/src/convert.howto create mode 100644 lib/erl_docgen/doc/src/erl_docgen.txt create mode 100644 lib/erl_docgen/doc/src/notes.xml create mode 100644 lib/erl_docgen/priv/Makefile create mode 100644 lib/erl_docgen/priv/bin/Makefile create mode 100755 lib/erl_docgen/priv/bin/codeline_preprocessing.escript create mode 100644 lib/erl_docgen/priv/css/Makefile create mode 100644 lib/erl_docgen/priv/css/otp_doc.css create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/Makefile create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/application.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/appref.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/book.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/bookinsidecover.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/chapter.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/cites.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/common.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/common.entities.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/common.header.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/common.image.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/common.refs.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/common.table.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/comref.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/cref.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/erlref.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/fascicules.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/fileref.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/part.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/report.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/terms.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/xhtml1-frameset.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/xhtml1-strict.dtd create mode 100644 lib/erl_docgen/priv/docbuilder_dtd/xhtml1-transitional.dtd create mode 100644 lib/erl_docgen/priv/dtd_html_entities/Makefile create mode 100644 lib/erl_docgen/priv/dtd_html_entities/xhtml-lat1.ent create mode 100644 lib/erl_docgen/priv/dtd_man_entities/Makefile create mode 100644 lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent create mode 100644 lib/erl_docgen/priv/images/Makefile create mode 100644 lib/erl_docgen/priv/images/erlang-logo.gif create mode 100644 lib/erl_docgen/priv/images/erlang-logo.png create mode 100644 lib/erl_docgen/priv/images/erlang-old.gif create mode 100644 lib/erl_docgen/priv/js/flipmenu/Makefile create mode 100644 lib/erl_docgen/priv/js/flipmenu/flip_closed.gif create mode 100644 lib/erl_docgen/priv/js/flipmenu/flip_open.gif create mode 100644 lib/erl_docgen/priv/js/flipmenu/flip_static.gif create mode 100644 lib/erl_docgen/priv/js/flipmenu/flipmenu.js create mode 100644 lib/erl_docgen/priv/js/flipmenu/fm.js create mode 100644 lib/erl_docgen/priv/nyi.html create mode 100644 lib/erl_docgen/priv/xsl/Makefile create mode 100644 lib/erl_docgen/priv/xsl/db_html.xsl create mode 100644 lib/erl_docgen/priv/xsl/db_html_params.xsl create mode 100644 lib/erl_docgen/priv/xsl/db_man.xsl create mode 100644 lib/erl_docgen/priv/xsl/db_pdf.xsl create mode 100644 lib/erl_docgen/priv/xsl/db_pdf_params.xsl create mode 100644 lib/erl_docgen/vsn.mk (limited to 'lib/erl_docgen') diff --git a/lib/erl_docgen/Makefile b/lib/erl_docgen/Makefile new file mode 100644 index 0000000000..c5bed632a5 --- /dev/null +++ b/lib/erl_docgen/Makefile @@ -0,0 +1,36 @@ +# ``The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved via the world wide web at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# The Initial Developer of the Original Code is Ericsson Utvecklings AB. +# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings +# AB. All Rights Reserved.'' +# +# $Id$ +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# +# Macros +# + +SUB_DIRECTORIES = priv +#doc/src + + +SPECIAL_TARGETS = + +# +# Default Subdir Targets +# +include $(ERL_TOP)/make/otp_subdir.mk + + diff --git a/lib/erl_docgen/doc/src/book.xml b/lib/erl_docgen/doc/src/book.xml new file mode 100644 index 0000000000..9df5c39271 --- /dev/null +++ b/lib/erl_docgen/doc/src/book.xml @@ -0,0 +1,47 @@ + + + + +
+ + 20042009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + erl_docgen + Lars Thorsen + + 2009-11-10 + 0.1 + book.xml +
+ + + erl_docgen + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/doc/src/convert.howto b/lib/erl_docgen/doc/src/convert.howto new file mode 100644 index 0000000000..2c72de8c4c --- /dev/null +++ b/lib/erl_docgen/doc/src/convert.howto @@ -0,0 +1,13 @@ + +- add xmlns:xi="http://www.w3.org/2001/XInclude" on top tag + in files whith include directives + +- change + +- change to + +- remove chapers directly in the book and put them in the part instead + +-change title to just the application name + +- fix codeinclude : xml --> xmlsrc \ No newline at end of file diff --git a/lib/erl_docgen/doc/src/erl_docgen.txt b/lib/erl_docgen/doc/src/erl_docgen.txt new file mode 100644 index 0000000000..14a4dc8e10 --- /dev/null +++ b/lib/erl_docgen/doc/src/erl_docgen.txt @@ -0,0 +1,6 @@ + + + +/home/otptest/bin/otp_wrap_ssh boddington /home/otptest/bin/otp_build_doc -rel r13b02 -view otptest_r13_daily_doc2 -csfile /usr/local/otp/config-specs/r13_dev.cs -insdir /ldisk/daily_build +_ + \ No newline at end of file diff --git a/lib/erl_docgen/doc/src/notes.xml b/lib/erl_docgen/doc/src/notes.xml new file mode 100644 index 0000000000..caa113df08 --- /dev/null +++ b/lib/erl_docgen/doc/src/notes.xml @@ -0,0 +1,45 @@ + + + + +
+ + 20042009 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + erl_docgen Release Notes + otp_appnotes + nil + nil + nil + notes.xml +
+

This document describes the changes made to the erl_docgen application.

+ + +
erl_docgen 0.1 + +
+ Improvements and new features +

This is the first release of erl_docgen for internal use.

+
+ + +
+ + + diff --git a/lib/erl_docgen/priv/Makefile b/lib/erl_docgen/priv/Makefile new file mode 100644 index 0000000000..f50350bef2 --- /dev/null +++ b/lib/erl_docgen/priv/Makefile @@ -0,0 +1,34 @@ +# ``The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved via the world wide web at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# The Initial Developer of the Original Code is Ericsson Utvecklings AB. +# Portions created by Ericsson are Copyright 1999, Ericsson Utvecklings +# AB. All Rights Reserved.'' +# +# $Id$ +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# +# Macros +# + +SUB_DIRECTORIES = bin css docbuilder_dtd dtd_html_entities dtd_man_entities images js/flipmenu xsl + +SPECIAL_TARGETS = + +# +# Default Subdir Targets +# +include $(ERL_TOP)/make/otp_subdir.mk + + diff --git a/lib/erl_docgen/priv/bin/Makefile b/lib/erl_docgen/priv/bin/Makefile new file mode 100644 index 0000000000..bd59675003 --- /dev/null +++ b/lib/erl_docgen/priv/bin/Makefile @@ -0,0 +1,74 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +ESCRIPT_FILES= \ + codeline_preprocessing.escript + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/bin + $(INSTALL_SCRIPT) $(ESCRIPT_FILES) $(RELSYSDIR)/priv/bin + +release_docs_spec: + + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/bin/codeline_preprocessing.escript b/lib/erl_docgen/priv/bin/codeline_preprocessing.escript new file mode 100755 index 0000000000..33a678d3a4 --- /dev/null +++ b/lib/erl_docgen/priv/bin/codeline_preprocessing.escript @@ -0,0 +1,117 @@ +#!/usr/bin/env escript +%% -*- erlang -*- +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2009. All Rights Reserved. +%% +%% The contents of this file are subject to the Erlang Public License, +%% Version 1.1, (the "License"); you may not use this file except in +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% +%%---------------------------------------------------------------------- +%% File : codeline_preprocessing.escript +%% +%% Created : 10 Sep 2008 by Lars Thorsen +%%---------------------------------------------------------------------- + +%%====================================================================== +%% External functions +%%====================================================================== +%%---------------------------------------------------------------------- +%% Function: main/1 +%% Description: +%%---------------------------------------------------------------------- +main([InFile, OutFile]) -> + InDev = + case file:open(InFile, [read]) of + {ok,ID} -> + ID; + _ -> + halt(5) + end, + CPath=filename:dirname(InFile), + OutDev = + case file:open(OutFile, [write]) of + {ok,OD} -> + OD; + _ -> + halt(5) + end, + case re:compile("|/codeinclude>)") of + {ok, Mp} -> + parse(InDev, OutDev, CPath, Mp); + _ -> + halt(2) + end; +main(_) -> + usage(). + + +%%---------------------------------------------------------------------- +%% Function: main/1 +%% Description: +%%---------------------------------------------------------------------- +usage() -> + io:format("usage: codeline_preprocessing \n"), + halt(1). + + +%%====================================================================== +%% Internal functions +%%====================================================================== + +parse(InDev, OutDev, CPath, Mp) -> + case io:get_line(InDev, "") of + eof -> + file:close(OutDev), + file:close(InDev); + String -> + case re:run(String, Mp,[{capture, [1,2], list}]) of + {match,[File, []]} -> + case file:read_file(filename:join(CPath, File))of + {ok, Bin} -> + file:write(OutDev, "\n"); + _ -> + halt(3) + end; + {match,[File, Tag]} -> + String2 = get_code(filename:join(CPath, File), Tag), + file:write(OutDev, "\n"); + _ -> + file:write(OutDev, String) + end, + parse(InDev, OutDev, CPath, Mp) + end. + +%%---------------------------------------------------------------------- +%% Function: get_code/2 +%% Description: +%%---------------------------------------------------------------------- +get_code(File, Tag) -> + case file:read_file(File) of + {ok, Bin} -> + case re:run(Bin,"^" ++ Tag ++ "\n((.|\n)*)\n" ++ + Tag ++ "\$",[global, multiline, {capture, [1], binary}]) of + {match,[[Match]]} -> + Match; + _ -> + halt(4) + end; + _ -> + halt(3) + end. + + + diff --git a/lib/erl_docgen/priv/css/Makefile b/lib/erl_docgen/priv/css/Makefile new file mode 100644 index 0000000000..81124fb111 --- /dev/null +++ b/lib/erl_docgen/priv/css/Makefile @@ -0,0 +1,77 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +CSS_FILES = \ + otp_doc.css + + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/css + $(INSTALL_DATA) $(CSS_FILES) $(RELSYSDIR)/priv/css + + +release_docs_spec: + $(INSTALL_DIR) $(RELEASE_PATH)/doc + $(INSTALL_DATA) $(CSS_FILES) ../nyi.html $(RELEASE_PATH)/doc + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/css/otp_doc.css b/lib/erl_docgen/priv/css/otp_doc.css new file mode 100644 index 0000000000..97d8c2df74 --- /dev/null +++ b/lib/erl_docgen/priv/css/otp_doc.css @@ -0,0 +1,117 @@ + + +body { + background: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + margin: 0; + padding: 0; + border: 0; + overflow: scroll; + height: 100%; + max-height: 100%; +} + + +th { font-family: Verdana, Arial, Helvetica, sans-serif } +td { font-family: Verdana, Arial, Helvetica, sans-serif } +p { font-family: Verdana, Arial, Helvetica, sans-serif } + +.header { background: #222; color: #fff } +.top { background: #efe } +.otp { background: #efe } +.erlang { background: #ffe } +.otp2 { background: #efe } +.app { background: #ffe } + +a:link { color: blue; text-decoration: none } +a:active { color: blue; text-decoration: none } +a:visited { color: blue; text-decoration: none } + +#container { + width: 100%; + margin: 0; + background-color: #fff; +} + + +#leftnav { + position: fixed; + float: left; + top: 0; + bottom: 0; + left: 0; + width: 200px; + overflow:auto; + margin: 0; + padding: 1px; + border-right: 1px solid red; +} + + +#content { + margin-left: 240px; /* set left value to WidthOfFrameDiv */ +} + +.frontpage +{ + padding-top: 50px; /* Magins for inner DIV inside each DIV (to provide padding) */ +} + + +.innertube +{ + margin: 15px; /* Magins for inner DIV inside each DIV (to provide padding) */ +} + +.footer +{ + margin: 15px; /* Magins for inner DIV inside each DIV (to provide padding) */ + +} +span.bold_code { font-family: courier;font-weight: bold} +span.code { font-family: courier;font-weight: normal} + +.note, .warning { + border: solid black 1px; + margin: 1em 3em; +} + +.note .label { + background: #30d42a; + color: white; + font-weight: bold; + padding: 5px 10px; +} +.note .content { + background: #eafeea; + color: black; + line-height: 120%; + font-size: 90%; + padding: 5px 10px; +} +.warning .label { + background: #C00; + color: white; + font-weight: bold; + padding: 5px 10px; +} +.warning .content { + background: #FFF0F0; + color: black; + line-height: 120%; + font-size: 90%; + padding: 5px 10px; +} + +.example { + background-color:#eeeeff; + padding: 0px 10px; +} + +pre { font-family: courier; font-weight: normal } + +.REFBODY { margin-left: 13mm } + +.REFTYPES { margin-left: 8mm } + +footer { } diff --git a/lib/erl_docgen/priv/docbuilder_dtd/Makefile b/lib/erl_docgen/priv/docbuilder_dtd/Makefile new file mode 100644 index 0000000000..e2214107cb --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/Makefile @@ -0,0 +1,99 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +DTD_FILES = \ + application.dtd \ + chapter.dtd \ + common.header.dtd \ + comref.dtd \ + fileref.dtd \ + xhtml1-frameset.dtd \ + appref.dtd \ + cites.dtd \ + common.image.dtd \ + cref.dtd \ + part.dtd \ + xhtml1-strict.dtd \ + book.dtd \ + common.dtd \ + common.refs.dtd \ + erlref.dtd \ + report.dtd \ + xhtml1-transitional.dtd \ + bookinsidecover.dtd \ + common.entities.dtd \ + common.table.dtd \ + fascicules.dtd \ + terms.dtd + + + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/docbuilder_dtd + $(INSTALL_DATA) $(DTD_FILES) $(RELSYSDIR)/priv/docbuilder_dtd + + +release_docs_spec: + + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/application.dtd b/lib/erl_docgen/priv/docbuilder_dtd/application.dtd new file mode 100644 index 0000000000..8a1e8832ec --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/application.dtd @@ -0,0 +1,29 @@ + + + + +%common; + +%common.header; + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/appref.dtd b/lib/erl_docgen/priv/docbuilder_dtd/appref.dtd new file mode 100644 index 0000000000..70a5ff37af --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/appref.dtd @@ -0,0 +1,33 @@ + + + + +%common.refs; + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/book.dtd b/lib/erl_docgen/priv/docbuilder_dtd/book.dtd new file mode 100644 index 0000000000..bb89a6d255 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/book.dtd @@ -0,0 +1,73 @@ + + + + +%common; + +%common.header; + +%common.table; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/bookinsidecover.dtd b/lib/erl_docgen/priv/docbuilder_dtd/bookinsidecover.dtd new file mode 100644 index 0000000000..d6efbef6a4 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/bookinsidecover.dtd @@ -0,0 +1,36 @@ + + +%ISOlat1; + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/chapter.dtd b/lib/erl_docgen/priv/docbuilder_dtd/chapter.dtd new file mode 100644 index 0000000000..eb2c96b04f --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/chapter.dtd @@ -0,0 +1,36 @@ + + + + +%common; + +%common.header; + +%common.table; + +%common.image; + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/cites.dtd b/lib/erl_docgen/priv/docbuilder_dtd/cites.dtd new file mode 100644 index 0000000000..334574bff9 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/cites.dtd @@ -0,0 +1,35 @@ + + +%ISOlat1; + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/common.dtd b/lib/erl_docgen/priv/docbuilder_dtd/common.dtd new file mode 100644 index 0000000000..fdc02c55a1 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/common.dtd @@ -0,0 +1,87 @@ + + + + +%common.entities; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/common.entities.dtd b/lib/erl_docgen/priv/docbuilder_dtd/common.entities.dtd new file mode 100644 index 0000000000..f893ecd070 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/common.entities.dtd @@ -0,0 +1,24 @@ + + +%ISOlat1; + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/common.header.dtd b/lib/erl_docgen/priv/docbuilder_dtd/common.header.dtd new file mode 100644 index 0000000000..d422a89693 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/common.header.dtd @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/common.image.dtd b/lib/erl_docgen/priv/docbuilder_dtd/common.image.dtd new file mode 100644 index 0000000000..fc95a669dd --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/common.image.dtd @@ -0,0 +1,21 @@ + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/common.refs.dtd b/lib/erl_docgen/priv/docbuilder_dtd/common.refs.dtd new file mode 100644 index 0000000000..7b9974fbda --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/common.refs.dtd @@ -0,0 +1,40 @@ + + + + +%common; + +%common.header; + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/common.table.dtd b/lib/erl_docgen/priv/docbuilder_dtd/common.table.dtd new file mode 100644 index 0000000000..7741da1018 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/common.table.dtd @@ -0,0 +1,25 @@ + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/comref.dtd b/lib/erl_docgen/priv/docbuilder_dtd/comref.dtd new file mode 100644 index 0000000000..fcdea625d5 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/comref.dtd @@ -0,0 +1,31 @@ + + + + +%common.refs; + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/cref.dtd b/lib/erl_docgen/priv/docbuilder_dtd/cref.dtd new file mode 100644 index 0000000000..e43bb2bf51 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/cref.dtd @@ -0,0 +1,34 @@ + + + + +%common.refs; + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/erlref.dtd b/lib/erl_docgen/priv/docbuilder_dtd/erlref.dtd new file mode 100644 index 0000000000..21656a1446 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/erlref.dtd @@ -0,0 +1,31 @@ + + + + +%common.refs; + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/fascicules.dtd b/lib/erl_docgen/priv/docbuilder_dtd/fascicules.dtd new file mode 100644 index 0000000000..b14276a2c0 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/fascicules.dtd @@ -0,0 +1,35 @@ + + + + +%ISOlat1; + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/fileref.dtd b/lib/erl_docgen/priv/docbuilder_dtd/fileref.dtd new file mode 100644 index 0000000000..5a1cc54afe --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/fileref.dtd @@ -0,0 +1,31 @@ + + + + +%common.refs; + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/part.dtd b/lib/erl_docgen/priv/docbuilder_dtd/part.dtd new file mode 100644 index 0000000000..3f97199042 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/part.dtd @@ -0,0 +1,29 @@ + + + + +%common; + +%common.header; + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/report.dtd b/lib/erl_docgen/priv/docbuilder_dtd/report.dtd new file mode 100644 index 0000000000..3d07e6e5a7 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/report.dtd @@ -0,0 +1,138 @@ + + + + +%ISOlat1; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/terms.dtd b/lib/erl_docgen/priv/docbuilder_dtd/terms.dtd new file mode 100644 index 0000000000..6105ec593e --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/terms.dtd @@ -0,0 +1,36 @@ + + +%ISOlat1; + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-frameset.dtd b/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-frameset.dtd new file mode 100644 index 0000000000..d128f2eb7c --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-frameset.dtd @@ -0,0 +1,1235 @@ + + + + + +%HTMLlat1; + + +%HTMLsymbol; + + +%HTMLspecial; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-strict.dtd b/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-strict.dtd new file mode 100644 index 0000000000..2927b9ece7 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-strict.dtd @@ -0,0 +1,978 @@ + + + + + +%HTMLlat1; + + +%HTMLsymbol; + + +%HTMLspecial; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-transitional.dtd b/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-transitional.dtd new file mode 100644 index 0000000000..628f27ac50 --- /dev/null +++ b/lib/erl_docgen/priv/docbuilder_dtd/xhtml1-transitional.dtd @@ -0,0 +1,1201 @@ + + + + + +%HTMLlat1; + + +%HTMLsymbol; + + +%HTMLspecial; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/dtd_html_entities/Makefile b/lib/erl_docgen/priv/dtd_html_entities/Makefile new file mode 100644 index 0000000000..d57302bd1b --- /dev/null +++ b/lib/erl_docgen/priv/dtd_html_entities/Makefile @@ -0,0 +1,75 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +ENTITY_FILES = \ + xhtml-lat1.ent + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/dtd_html_entities + $(INSTALL_DATA) $(ENTITY_FILES) $(RELSYSDIR)/priv/dtd_html_entities + + +release_docs_spec: + + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/dtd_html_entities/xhtml-lat1.ent b/lib/erl_docgen/priv/dtd_html_entities/xhtml-lat1.ent new file mode 100644 index 0000000000..aaae738cfc --- /dev/null +++ b/lib/erl_docgen/priv/dtd_html_entities/xhtml-lat1.ent @@ -0,0 +1,196 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/dtd_man_entities/Makefile b/lib/erl_docgen/priv/dtd_man_entities/Makefile new file mode 100644 index 0000000000..5651d8bc29 --- /dev/null +++ b/lib/erl_docgen/priv/dtd_man_entities/Makefile @@ -0,0 +1,75 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +ENTITY_FILES = \ + xhtml-lat1.ent + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/dtd_man_entities + $(INSTALL_DATA) $(ENTITY_FILES) $(RELSYSDIR)/priv/dtd_man_entities + + +release_docs_spec: + + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent b/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent new file mode 100644 index 0000000000..3df9970a43 --- /dev/null +++ b/lib/erl_docgen/priv/dtd_man_entities/xhtml-lat1.ent @@ -0,0 +1,195 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/images/Makefile b/lib/erl_docgen/priv/images/Makefile new file mode 100644 index 0000000000..8b858fefb3 --- /dev/null +++ b/lib/erl_docgen/priv/images/Makefile @@ -0,0 +1,79 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +GIF_FILES = \ + erlang-logo.gif + +PNG_FILES = \ + erlang-logo.png + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/images + $(INSTALL_DATA) $(GIF_FILES) $(PNG_FILES) $(RELSYSDIR)/priv/images + + +release_docs_spec: + $(INSTALL_DIR) $(RELEASE_PATH)/doc + $(INSTALL_DATA) $(PNG_FILES) $(RELEASE_PATH)/doc + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/images/erlang-logo.gif b/lib/erl_docgen/priv/images/erlang-logo.gif new file mode 100644 index 0000000000..abf5f225d7 Binary files /dev/null and b/lib/erl_docgen/priv/images/erlang-logo.gif differ diff --git a/lib/erl_docgen/priv/images/erlang-logo.png b/lib/erl_docgen/priv/images/erlang-logo.png new file mode 100644 index 0000000000..56291aac15 Binary files /dev/null and b/lib/erl_docgen/priv/images/erlang-logo.png differ diff --git a/lib/erl_docgen/priv/images/erlang-old.gif b/lib/erl_docgen/priv/images/erlang-old.gif new file mode 100644 index 0000000000..ed2796223a Binary files /dev/null and b/lib/erl_docgen/priv/images/erlang-old.gif differ diff --git a/lib/erl_docgen/priv/js/flipmenu/Makefile b/lib/erl_docgen/priv/js/flipmenu/Makefile new file mode 100644 index 0000000000..65c5c91f35 --- /dev/null +++ b/lib/erl_docgen/priv/js/flipmenu/Makefile @@ -0,0 +1,81 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +GIF_FILES = \ + flip_closed.gif \ + flip_open.gif \ + flip_static.gif + +JS_FILES = \ + flipmenu.js + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/js/flipmenu + $(INSTALL_DATA) $(JS_FILES) $(GIF_FILES) $(RELSYSDIR)/priv/js/flipmenu + + +release_docs_spec: + $(INSTALL_DIR) $(RELEASE_PATH)/doc/js/flipmenu + $(INSTALL_DATA) $(JS_FILES) $(GIF_FILES) $(RELEASE_PATH)/doc/js/flipmenu + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/js/flipmenu/flip_closed.gif b/lib/erl_docgen/priv/js/flipmenu/flip_closed.gif new file mode 100644 index 0000000000..9a27c7c25d Binary files /dev/null and b/lib/erl_docgen/priv/js/flipmenu/flip_closed.gif differ diff --git a/lib/erl_docgen/priv/js/flipmenu/flip_open.gif b/lib/erl_docgen/priv/js/flipmenu/flip_open.gif new file mode 100644 index 0000000000..9dda60e73a Binary files /dev/null and b/lib/erl_docgen/priv/js/flipmenu/flip_open.gif differ diff --git a/lib/erl_docgen/priv/js/flipmenu/flip_static.gif b/lib/erl_docgen/priv/js/flipmenu/flip_static.gif new file mode 100644 index 0000000000..2b3ddb5382 Binary files /dev/null and b/lib/erl_docgen/priv/js/flipmenu/flip_static.gif differ diff --git a/lib/erl_docgen/priv/js/flipmenu/flipmenu.js b/lib/erl_docgen/priv/js/flipmenu/flipmenu.js new file mode 100644 index 0000000000..1f70f2509b --- /dev/null +++ b/lib/erl_docgen/priv/js/flipmenu/flipmenu.js @@ -0,0 +1,352 @@ +// ###################################################################### + +// ## flipMenu 5.0.0 (c) J. Reijers +// ## Last modifications: 23 March 2007 + +// ###################################################################### + +// ## Degree of indentation from the left. + flipIndentation = "5px"; + +// ## Padding inbetween menu items. + flipVerticalPadding = "4px"; + +// ## Margin between the left of the browser and the menu. + flipLeftMargin = "16px"; + +// ## Margin between the top of the browser and the menu. + flipTopMargin = "10px"; + +// ## Allow multiple menus to fold out without closing all the other open ones. + flipOpenMultipleMenus = false; + +// ## Preserve the current state of the menu (requires cookies). + flipSaveMenuState = false; + +// ## Open entries where the attribute expanded is true + flipMarked = true; + +// ## Use custom images for bullets + flipImages = true; + +// ## Images to use (specify full path) + flipImg_open = "flip_open.gif"; + flipImg_closed = "flip_closed.gif"; + flipImg_static = "flip_static.gif"; + +// ## Initialise all flipMenus onload + flipInitOnLoad = true; + +// ## Message to display in status bar while loading + flipLoadingMessage = "Loading..."; + +// ###################################################################### + +function alterSize(someSize, alterAmount) { + someSize = String(someSize); + var tmpNr = parseFloat(someSize.replace(/\D/g, "")); + var tmpChar = someSize.replace(/\d/g, ""); + return isNaN(tmpNr) ? someSize : ((tmpNr + alterAmount) + tmpChar); +} + +isIE = (String(navigator.appVersion).indexOf("MSIE") > -1); +if (!isIE) flipIndentation = alterSize(flipIndentation, -16); +if (!isIE) flipLeftMargin = alterSize(flipLeftMargin, -16); + +document.write( + "" +); + + + +if (flipImages) { + aFlipPreloads = []; + aFlipPreloads[0] = new Image; + aFlipPreloads[0].src = document.getElementById("js").getAttribute("src").match( /.*\// ) + flipImg_open; + aFlipPreloads[1] = new Image; + aFlipPreloads[1].src = document.getElementById("js").getAttribute("src").match( /.*\// ) + flipImg_closed; + aFlipPreloads[2] = new Image; + aFlipPreloads[2].src = document.getElementById("js").getAttribute("src").match( /.*\// ) + flipImg_static; +} + +function addEvent(someObj, someEvent, someFunction) { + if (someObj.addEventListener) { someObj.addEventListener(someEvent, someFunction, true); return true; } else if (someObj.attachEvent) return someObj.attachEvent("on" + someEvent, someFunction); else return false; +} + +function openCloseFlip(theItem, newSetting, openParents) { + if (theItem.flipID) { + if (openParents) { + var tmpItem = theItem; + while (tmpItem.parentElement || tmpItem.parentNode) { + tmpItem = (tmpItem.parentElement) ? tmpItem.parentElement : tmpItem.parentNode; + openCloseFlip(tmpItem, newSetting); + } + } + if ((theItem.className == "flipFolderOpen" && newSetting == "closed") || (theItem.className == "flipFolderClosed" && newSetting == "open")) { + if (!theItem.childrenInitialised) { + for (var j = 0; j < theItem.childNodes.length; j++) if (theItem.childNodes[j].nodeName == "UL" && !theItem.childNodes[j].initialised) initFlip(theItem.childNodes[j]); + theItem.childrenInitialised = true; + } + theItem.getElementsByTagName("UL")[0].style.display = (newSetting == "open") ? "" : "none"; + theItem.className = newSetting == "open" ? "flipFolderOpen" : "flipFolderClosed"; + } + } +} + +function openFlip(theItem, openParents) { + openCloseFlip(theItem, "open", openParents); +} + +function closeFlip(theItem, closeParents) { + openCloseFlip(theItem, "closed", closeParents); +} + +function toggleFlip(theElement) { + if (theElement.flipID) { + var theItem = theElement; + var isContained = true; + } else { + if (theElement && theElement.button > 0) return false; + var theItem = (isIE) ? event.srcElement : theElement.target; + + var isContained = false; + if (theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed") isContained = true; else while (theItem.parentElement || theItem.parentNode) { + if (theItem.className == "flipStatic" || theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed") { + isContained = (theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed"); + break; + } + theItem = (theItem.parentElement) ? theItem.parentElement : theItem.parentNode; + } + } + + var toOpenFlip = (isContained && theItem.className == "flipFolderClosed"); + + if (!flipOpenMultipleMenus && (toOpenFlip || theItem.className == "flipStatic")) { + if (theItem.parentElement || theItem.parentNode) { + var parentUL = (theItem.parentElement) ? theItem.parentElement : theItem.parentNode; + for (var i = 0; i < parentUL.childNodes.length; i++) closeFlip(parentUL.childNodes[i]); + } + } + + if (isContained) { + if (toOpenFlip) openFlip(theItem); else closeFlip(theItem); + } +} + +function setAllFlips(startElement, newSetting) { + if (typeof startElement == "undefined") var startElement = document; + if (typeof newSetting == "undefined") var newSetting = "closed"; + + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var parentFlip = aUL[i].parentElement ? aUL[i].parentElement : aUL[i].parentNode; + openCloseFlip(parentFlip, newSetting); + } +} + +function openAllFlips(startElement) { + setAllFlips(startElement, "open"); +} + +function closeAllFlips(startElement) { + setAllFlips(startElement, "closed"); +} + +function initFlip(startElement) { + if (!document.createElement) return false; + + if (!startElement || !startElement.nodeName) { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + if (flipLoadingMessage != "") window.status = flipLoadingMessage + " " + parseInt((i / (aUL.length - 1)) * 100, 10) + "%"; + var curUL = aUL[i]; + if (curUL.className == "flipMenu") { + initFlip(curUL); + + // ## Fix text selecting problem in Mozilla + curUL.onselectstart = new Function("return false"); + curUL.onmousedown = new Function("return false"); + curUL.onclick = new Function("return true"); + } + } + + if (flipSaveMenuState) loadMenuState(); + + if (flipLoadingMessage != "") window.status = ""; + return true; + } + + if (startElement.className == "flipMenu") startElement.style.display = ""; + + if (!startElement.childNodes || startElement.childNodes.length == 0) return false; + + if (typeof flipIDCur == "undefined") flipIDCur = 0; + if (!startElement.initialised) { + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) aUL[i].style.display = "none"; + } + + for (var i = 0; i < startElement.childNodes.length; i++) { + var curNode = startElement.childNodes[i]; + if (curNode.nodeName == "LI") { + flipIDCur++; + curNode.flipID = flipIDCur; + + var nodeHasChildren = curNode.getElementsByTagName("UL").length > 0; + if (nodeHasChildren) { + if (flipImages && curNode.flipClosed) curNode.style.listStyleImage = "url(" + curNode.flipClosed + ")"; + + if (curNode.className == null || curNode.className == "") curNode.className = "flipFolderClosed"; + } else { + curNode.className = "flipStatic"; + if (flipImages && !curNode.style.listStyleImage) { + if (!curNode.flipStatic) curNode.flipStatic = document.getElementById("js").getAttribute("src").match( /.*\// ) + flipImg_static; + curNode.style.listStyleImage = "url(" + curNode.flipStatic + ")"; + } + } + + + if (!curNode.flipOpen) curNode.flipOpen = document.getElementById("js").getAttribute("src").match( /.*\// ) + flipImg_open; + if (!curNode.flipClosed) curNode.flipClosed = document.getElementById("js").getAttribute("src").match( /.*\// ) + flipImg_closed; + + if (flipMarked) { + if (curNode.getAttribute("expanded") == "true") curNode.flipIsOpen=1; + } + + if (curNode.flipIsOpen) openFlip(curNode); + } + } + + startElement.initialised = true; +} + +function rootOfFlip(flipID, startElement) { + + function containsFlip(startElement, flipID) { + var flipFound = false; + var i = 0; + while (i < startElement.childNodes.length && !flipFound) { + var curNode = startElement.childNodes[i]; + flipFound = (curNode.flipID == flipID) ? true : containsFlip(curNode, flipID); + i++; + } + return flipFound; + } + + var rootFlip = null; + + if (!startElement || !startElement.nodeName) { + var aUL = document.getElementsByTagName("UL"); + var i = 0; + while (rootFlip == null && i < aUL.length) { + var curUL = aUL[i]; + if (curUL.nodeName == "UL" && curUL.className == "flipMenu") rootFlip = rootOfFlip(flipID, curUL); + i++; + } + return rootFlip; + } + + if (startElement.childNodes) for (var i = 0; i < startElement.childNodes.length; i++) { + var curNode = startElement.childNodes[i]; + if (curNode.flipID == flipID || containsFlip(curNode, flipID)) rootFlip = curNode; + } + + return rootFlip; +} + +function getCookie(cookieName) { + var allCookies = document.cookie; + var indexStr = allCookies.indexOf(cookieName + "="); + if (indexStr == -1) return ""; + indexStr = allCookies.indexOf("=", indexStr) + 1; + var endStr = allCookies.indexOf(";", indexStr); + if (endStr == -1) endStr = allCookies.length; + return unescape(allCookies.substring(indexStr, endStr)); +} + +function inArray(someID, someArray) { + for (var i = 0; i < someArray.length; i++) if (someArray[i] == someID) return true; + return false; +} + +function getMenuState(startElement) { + if (!startElement.childNodes || startElement.childNodes.length == 0) return ""; + + var openItems = ""; + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curNode = aUL[i]; + var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode; + if (curNode.style.display == "" && parentFlip.flipID) openItems += " " + parentFlip.flipID; + } + return openItems; +} + +function putMenuState(startElement) { + if (!startElement.childNodes || startElement.childNodes.length == 0) return false; + + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curNode = aUL[i]; + var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode; + if (inArray(parentFlip.flipID, aOpenItems)) { + openFlip(parentFlip); + if (typeof prevFlipRoot == "undefined") { + var testRoot = rootOfFlip(parentFlip.flipID); + if (testRoot.flipID == parentFlip.flipID) prevFlipRoot = testRoot; + } + } + } +} + +function saveMenuState() { + if (flipSaveMenuState) { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") document.cookie = cookiePrefix + curID + "=" + getMenuState(curUL) + ";"; + } + } +} + +function loadMenuState() { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") { + var savedState = String(getCookie(cookiePrefix + curID)); + if (savedState != "") { + aOpenItems = savedState.split(" "); + putMenuState(curUL); + } + } + } + + addEvent(window, "unload", saveMenuState); +} + +function clearMenuState(flipMenuID) { + if (typeof flipMenuID == "undefined") { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") document.cookie = cookiePrefix + curID + "=;"; + } + } else document.cookie = cookiePrefix + flipMenuID + "=;"; +} + +cookiePrefix = document.location.pathname + "_"; + +addEvent(document, "click", toggleFlip); +if (flipInitOnLoad) addEvent(window, "load", initFlip); diff --git a/lib/erl_docgen/priv/js/flipmenu/fm.js b/lib/erl_docgen/priv/js/flipmenu/fm.js new file mode 100644 index 0000000000..f07177051b --- /dev/null +++ b/lib/erl_docgen/priv/js/flipmenu/fm.js @@ -0,0 +1,376 @@ +// ###################################################################### + +// ## flipMenu 5.0.0 (c) J. Reijers +// ## Last modifications: 23 March 2007 + +// ###################################################################### + +// ## Degree of indentation from the left. + flipIndentation = "5px"; + +// ## Padding inbetween menu items. + flipVerticalPadding = "4px"; + +// ## Margin between the left of the browser and the menu. + flipLeftMargin = "16px"; + +// ## Margin between the top of the browser and the menu. + flipTopMargin = "10px"; + +// ## Allow multiple menus to fold out without closing all the other open ones. + flipOpenMultipleMenus = false; + +// ## Preserve the current state of the menu (requires cookies). + flipSaveMenuState = false; + +// ## Preserve the current state of the menu (requires cookies). + constantState = true; + +// ## Use custom images for bullets + flipImages = true; + +// ## Images to use (specify full path) + flipImg_open = "js/flipmenu/flip_open.gif"; + flipImg_closed = "js/flipmenu/flip_closed.gif"; + flipImg_static = "js/flipmenu/flip_static.gif"; + +// ## Initialise all flipMenus onload + flipInitOnLoad = true; + +// ## Message to display in status bar while loading + flipLoadingMessage = "Loading..."; + +// ###################################################################### + +function alterSize(someSize, alterAmount) { + someSize = String(someSize); + var tmpNr = parseFloat(someSize.replace(/\D/g, "")); + var tmpChar = someSize.replace(/\d/g, ""); + return isNaN(tmpNr) ? someSize : ((tmpNr + alterAmount) + tmpChar); +} + +isIE = (String(navigator.appVersion).indexOf("MSIE") > -1); +if (!isIE) flipIndentation = alterSize(flipIndentation, -16); +if (!isIE) flipLeftMargin = alterSize(flipLeftMargin, -16); + +document.write( + "" +); + +if (flipImages) { + aFlipPreloads = []; + aFlipPreloads[0] = new Image; + aFlipPreloads[0].src = flipImg_open; + aFlipPreloads[1] = new Image; + aFlipPreloads[1].src = flipImg_closed; + aFlipPreloads[2] = new Image; + aFlipPreloads[2].src = flipImg_static; +} + +function addEvent(someObj, someEvent, someFunction) { + if (someObj.addEventListener) { someObj.addEventListener(someEvent, someFunction, true); return true; } else if (someObj.attachEvent) return someObj.attachEvent("on" + someEvent, someFunction); else return false; +} + +function openCloseFlip(theItem, newSetting, openParents) { + if (theItem.flipID) { + if (openParents) { + var tmpItem = theItem; + while (tmpItem.parentElement || tmpItem.parentNode) { + tmpItem = (tmpItem.parentElement) ? tmpItem.parentElement : tmpItem.parentNode; + openCloseFlip(tmpItem, newSetting); + } + } + if ((theItem.className == "flipFolderOpen" && newSetting == "closed") || (theItem.className == "flipFolderClosed" && newSetting == "open")) { + if (!theItem.childrenInitialised) { + for (var j = 0; j < theItem.childNodes.length; j++) if (theItem.childNodes[j].nodeName == "UL" && !theItem.childNodes[j].initialised) initFlip(theItem.childNodes[j]); + theItem.childrenInitialised = true; + } + theItem.getElementsByTagName("UL")[0].style.display = (newSetting == "open") ? "" : "none"; + theItem.className = newSetting == "open" ? "flipFolderOpen" : "flipFolderClosed"; + } + } +} + +function openFlip(theItem, openParents) { + openCloseFlip(theItem, "open", openParents); +} + +function closeFlip(theItem, closeParents) { + + openCloseFlip(theItem, "closed", closeParents); +} + +function toggleFlip(theElement) { + if (theElement.flipID) { + var theItem = theElement; + var isContained = true; + } else { + if (theElement && theElement.button > 0) return false; + var theItem = (isIE) ? event.srcElement : theElement.target; + + var isContained = false; + if (theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed") isContained = true; else while (theItem.parentElement || theItem.parentNode) { + if (theItem.className == "flipStatic" || theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed") { + isContained = (theItem.className == "flipFolderOpen" || theItem.className == "flipFolderClosed"); + break; + } + theItem = (theItem.parentElement) ? theItem.parentElement : theItem.parentNode; + } + } + + var toOpenFlip = (isContained && theItem.className == "flipFolderClosed"); + + if (!flipOpenMultipleMenus && (toOpenFlip || theItem.className == "flipStatic")) { + if (theItem.parentElement || theItem.parentNode) { + var parentUL = (theItem.parentElement) ? theItem.parentElement : theItem.parentNode; + for (var i = 0; i < parentUL.childNodes.length; i++) closeFlip(parentUL.childNodes[i]); + } + } + + if (isContained) { + if (toOpenFlip) openFlip(theItem); else closeFlip(theItem); + } +} + +function setAllFlips(startElement, newSetting) { + if (typeof startElement == "undefined") var startElement = document; + if (typeof newSetting == "undefined") var newSetting = "closed"; + + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var parentFlip = aUL[i].parentElement ? aUL[i].parentElement : aUL[i].parentNode; + openCloseFlip(parentFlip, newSetting); + } +} + +function openAllFlips(startElement) { + setAllFlips(startElement, "open"); +} + +function closeAllFlips(startElement) { + setAllFlips(startElement, "closed"); +} + +function initFlip(startElement) { + if (!document.createElement) return false; + + if (!startElement || !startElement.nodeName) { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + if (flipLoadingMessage != "") window.status = flipLoadingMessage + " " + parseInt((i / (aUL.length - 1)) * 100, 10) + "%"; + var curUL = aUL[i]; + if (curUL.className == "flipMenu") { + initFlip(curUL); + + // ## Fix text selecting problem in Mozilla + curUL.onselectstart = new Function("return false"); + curUL.onmousedown = new Function("return false"); + curUL.onclick = new Function("return true"); + } + } + + if (flipSaveMenuState) loadMenuState(); + + if (flipLoadingMessage != "") window.status = ""; + return true; + } + + if (startElement.className == "flipMenu") startElement.style.display = ""; + + if (!startElement.childNodes || startElement.childNodes.length == 0) return false; + + if (typeof flipIDCur == "undefined") flipIDCur = 0; + if (!startElement.initialised) { + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) aUL[i].style.display = "none"; + } + + for (var i = 0; i < startElement.childNodes.length; i++) { + var curNode = startElement.childNodes[i]; + if (curNode.nodeName == "LI") { + flipIDCur++; + curNode.flipID = flipIDCur; + + var nodeHasChildren = curNode.getElementsByTagName("UL").length > 0; + if (nodeHasChildren) { + if (flipImages && curNode.flipClosed) curNode.style.listStyleImage = "url(" + curNode.flipClosed + ")"; + + if (curNode.className == null || curNode.className == "") curNode.className = "flipFolderClosed"; + } else { + curNode.className = "flipStatic"; + if (flipImages && !curNode.style.listStyleImage) { + if (!curNode.flipStatic) curNode.flipStatic = flipImg_static; + curNode.style.listStyleImage = "url(" + curNode.flipStatic + ")"; + } + } + + if (!curNode.flipOpen) curNode.flipOpen = flipImg_open; + if (!curNode.flipClosed) curNode.flipClosed = flipImg_closed; + + if (curNode.flipIsOpen) openFlip(curNode); + } + } + + startElement.initialised = true; +} + +function rootOfFlip(flipID, startElement) { + + function containsFlip(startElement, flipID) { + var flipFound = false; + var i = 0; + while (i < startElement.childNodes.length && !flipFound) { + var curNode = startElement.childNodes[i]; + flipFound = (curNode.flipID == flipID) ? true : containsFlip(curNode, flipID); + i++; + } + return flipFound; + } + + var rootFlip = null; + + if (!startElement || !startElement.nodeName) { + var aUL = document.getElementsByTagName("UL"); + var i = 0; + while (rootFlip == null && i < aUL.length) { + var curUL = aUL[i]; + if (curUL.nodeName == "UL" && curUL.className == "flipMenu") rootFlip = rootOfFlip(flipID, curUL); + i++; + } + return rootFlip; + } + + if (startElement.childNodes) for (var i = 0; i < startElement.childNodes.length; i++) { + var curNode = startElement.childNodes[i]; + if (curNode.flipID == flipID || containsFlip(curNode, flipID)) rootFlip = curNode; + } + + return rootFlip; +} + +function getCookie(cookieName) { + var allCookies = document.cookie; + var indexStr = allCookies.indexOf(cookieName + "="); + if (indexStr == -1) return ""; + indexStr = allCookies.indexOf("=", indexStr) + 1; + var endStr = allCookies.indexOf(";", indexStr); + if (endStr == -1) endStr = allCookies.length; + return unescape(allCookies.substring(indexStr, endStr)); +} + +function inArray(someID, someArray) { + for (var i = 0; i < someArray.length; i++) if (someArray[i] == someID) return true; + return false; +} + +function getMenuState(startElement) { + if (!startElement.childNodes || startElement.childNodes.length == 0) return ""; + + var openItems = ""; + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curNode = aUL[i]; + var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode; + if (curNode.style.display == "" && parentFlip.flipID) openItems += " " + parentFlip.flipID; + } + return openItems; +} + +function putMenuState(startElement) { + if (!startElement.childNodes || startElement.childNodes.length == 0) return false; + + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curNode = aUL[i]; + var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode; + if (inArray(parentFlip.flipID, aOpenItems)) { + openFlip(parentFlip); + if (typeof prevFlipRoot == "undefined") { + var testRoot = rootOfFlip(parentFlip.flipID); + if (testRoot.flipID == parentFlip.flipID) prevFlipRoot = testRoot; + } + } + } +} +function setMenuState(startElement) { + if (!startElement.childNodes || startElement.childNodes.length == 0) return false; + + var aTitle = document.title; + aTitleParts = aTitle.split(" "); + + var aUL = startElement.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curNode = aUL[i]; + var parentFlip = (curNode.parentElement) ? curNode.parentElement : curNode.parentNode; + if (aTitleParts[3] == curNode.content) { + openFlip(parentFlip); + if (typeof prevFlipRoot == "undefined") { + var testRoot = rootOfFlip(parentFlip.flipID); + if (testRoot.flipID == parentFlip.flipID) prevFlipRoot = testRoot; + } + } + } +} +function saveMenuState() { + if (flipSaveMenuState) { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") document.cookie = cookiePrefix + curID + "=" + getMenuState(curUL) + ";"; + } + } +} + +function loadMenuState() { + if(constantState) { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") { + setMenuState(curUL); + } + } + } else { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") { + var savedState = String(getCookie(cookiePrefix + curID)); + if (savedState != "") { + aOpenItems = savedState.split(" "); + putMenuState(curUL); + } + } + } + + addEvent(window, "unload", saveMenuState); + } +} + + +function clearMenuState(flipMenuID) { + if (typeof flipMenuID == "undefined") { + var aUL = document.getElementsByTagName("UL"); + for (var i = 0; i < aUL.length; i++) { + var curUL = aUL[i]; + var curID = curUL.id ? curUL.id : i; + if (curUL.className == "flipMenu") document.cookie = cookiePrefix + curID + "=;"; + } + } else document.cookie = cookiePrefix + flipMenuID + "=;"; +} + +cookiePrefix = document.location.pathname + "_"; + +addEvent(document, "click", toggleFlip); +if (flipInitOnLoad) addEvent(window, "load", initFlip); diff --git a/lib/erl_docgen/priv/nyi.html b/lib/erl_docgen/priv/nyi.html new file mode 100644 index 0000000000..b948034174 --- /dev/null +++ b/lib/erl_docgen/priv/nyi.html @@ -0,0 +1,16 @@ + + + + Not Yet Implemented + + + +

Not Yet Implemented

+ +

This page is not yet generated.

+ + +
+ + + diff --git a/lib/erl_docgen/priv/xsl/Makefile b/lib/erl_docgen/priv/xsl/Makefile new file mode 100644 index 0000000000..92a53b8c0b --- /dev/null +++ b/lib/erl_docgen/priv/xsl/Makefile @@ -0,0 +1,80 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(ERL_DOCGEN_VSN) + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN) + + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- + + +XSL_FILES = \ + db_pdf.xsl \ + db_pdf_params.xsl \ + db_html.xsl \ + db_html_params.xsl \ + db_man.xsl + + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +debug opt: + +docs: + +clean: + $(RM) $(TARGET_FILES) + + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + + +release_spec: opt + $(INSTALL_DIR) $(RELSYSDIR)/priv/xsl + $(INSTALL_DATA) $(XSL_FILES) $(RELSYSDIR)/priv/xsl + + +release_docs_spec: + + +release_tests_spec: + + diff --git a/lib/erl_docgen/priv/xsl/db_html.xsl b/lib/erl_docgen/priv/xsl/db_html.xsl new file mode 100644 index 0000000000..3e6f762870 --- /dev/null +++ b/lib/erl_docgen/priv/xsl/db_html.xsl @@ -0,0 +1,1486 @@ + + + + + + + + + + + + + + + Erlang -- <xsl:value-of select="header/title"/> + + + +
+ + + + + + + +
+
+ + + + + +
+ +
+
+

+ + + - + + + +

+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + refpage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Erlang logo +
+ + + User's Guide
+ + + Reference Manual
+ + + Release Notes
+ + PDF
+ Top + + + + + +
+ + Expand All
+ Contract All + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + .  + + +

+ + + + + + + + + + +

+ + +

+ + + + + + + + + + +

+ + + +

+
+ + + +
+ + + + + + +

+ +

+
+ + + +
+ + + + + + + +
    + + + +
+ + + + +
  • + + + +
    • +     + + + + +
    + + + +
    +     + + + +
    + + + +
    +     + + + + +
    + + + +
    +     + + + + +
    +
    Note
    +
    +

    + + + +

    +
    +
    +     + + + + +
    +
    Warning
    +
    +

    + + + +

    +
    +
    +     + + + +

    + +

    +     + + + + + + + + +
    +     + + + + + + + + + + + + + + + +
    +     + + + + + + + +
    +     + + + + + + + + + + + + + + + +
    + + + + +     + + + + + + + + + + + + + + + + + + + Table + .: +   + + + + + + + + + + + + + IMAGE MISSING
    + + + + + + + +     + + + + + + + Figure + .: +   + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +

    User's Guide

    + +

    Version

    +

    + + + + + + + + + +
    +
    + + + +

    +
    + User's Guide
    + Version +

    + + + +

    + + Chapters + +

    + +
      + + + + +
    +
    +
    +     + + + + + + + + + + + + + true + false + + +
  • + + +
    • +     +     + + + + + + +
  • + + + +
    • +     +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +   +

    + + + + + + +     + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +

    Reference Manual

    + +

    Version

    +

    + + + + + + + + +
    +
    + + + +

    +
    + Reference Manual
    + Version +

    + + + +

    + + Table of Contents + +

    + +
      + + + + + +
    +
    +
    +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + false + false + false + true + false + + + + + + true + false + + + + + + + + +
  • + + +
    • +     + + + +
  • + + (App) + +
    • +     + +
  • + + + +
    • +     +     +     +     +     +     + + + + + + + + + + + + + +
  • + + () + +
    • +     + +
  • + + () + +
    • +     +     +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  • + + / + +
    • +     +     + +     +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    + + + + + + + + + + + + + + + + + +

    +
    + + + + + +     + + + + + +

    MODULE

    +
    + + + +
    +     + + + + + +

    MODULE SUMMARY

    +
    + + + +
    +     + + + + +

    C LIBRARY

    +
    + + + +
    +     + + + + + +

    LIBRARY SUMMARY

    +
    + + + +
    +     + + + + +

    COMMAND

    +
    + + + +
    +     + + + + + +

    COMMAND SUMMARY

    +
    + + + +
    +     + + + + +

    FILE

    +
    + + + +
    +     + + + + + +

    FILE SUMMARY

    +
    + + + +
    +     + + + + + +

    APPLICATION

    +
    + + + +
    +     + + + + + +

    APPLICATION SUMMARY

    +
    + + + +
    +     + + + + +

    DESCRIPTION

    +
    +

    + + + +

    +
    +     + + + + +

    + EXPORTS +

    + + + + + +     + + + + + +

    + + + + + +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +     + +
    +     +     + + +     + + + + + + +

    Types:

    + + + + +
    + +     + + + + + +
    + + + + +
    +
    +     + + + + +
    + + + +
    +     + + + +
    +

    + + + +

    +
    +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +

    Release Notes

    + +

    Version

    +

    + + + + + + + + + +
    +
    + + + +

    +
    + Release Notes
    + Version +

    + + + +

    + + Chapters + +

    + +
      + + + + +
    +
    +
    +     + + + + + + + + + Erlang Documentation -- <xsl:value-of select="header/title"/> + + + +
    + + + + + +
    +
    +

    Glossary

    +
    + +
    + + + +
    +
    +     +     +
    + +
    +
    +

    + + + - + + + +

    +
    + +
    +
    + + + + +     +     + + + + + + + + + + Erlang Documentation -- <xsl:value-of select="header/title"/> + + + +
    + + + + + +
    +
    +

    Bibliography

    +
    + + + + + + + + + + + +
    + +
    +
    +

    + + + - + + + +

    +
    + +
    +
    + + + + +     +     + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/xsl/db_html_params.xsl b/lib/erl_docgen/priv/xsl/db_html_params.xsl new file mode 100644 index 0000000000..2373200702 --- /dev/null +++ b/lib/erl_docgen/priv/xsl/db_html_params.xsl @@ -0,0 +1,35 @@ + + + + + + + + + + + Copyright © + + + + diff --git a/lib/erl_docgen/priv/xsl/db_man.xsl b/lib/erl_docgen/priv/xsl/db_man.xsl new file mode 100644 index 0000000000..c759a77496 --- /dev/null +++ b/lib/erl_docgen/priv/xsl/db_man.xsl @@ -0,0 +1,308 @@ + + + + + + + + + + + + + + + + + + + + .RE + .SH "" + + + + + + .RE + .SS "" + + + + + + + + .RS 2 + + .RE + + + + .TP 2 + * + + + + + .br + .br + + + + .RS 2 + + .RE + + + + .TP 4 + .B + + + + + + + + + .br + .br + + + + + + + + + + + .TP 4 .B Note: + + + + + + .TP 4 .B Warning: + + + + + + + + + .LP + + + + + + .LP + + + + + + + + + \fB + + \fR\& + + + + .br + + + + \fI\fR\& + + + + \fI\fR\& + + + + \fB\fR\& + + + + + .nf + + .fi + + + + + .nf + + .fi + + + + + + + + + + + + + + + + + + + + + + + + + .TH 3 " " "Ericsson AB" "Erlang Module Definition" + .SH MODULE + \- + + + + + + .TH 1 " " "Ericsson AB" "User Commands" + .SH NAME + \- + + + + + + .TH 3 " " "Ericsson AB" "C Library Functions" + .SH NAME + \- + + + + + + .TH 4 " " "Ericsson AB" "Files" + .SH NAME + \- + + + + + + .TH 6 " " "Ericsson AB" "Erlang Application Definition" + .SH NAME + \- + + + + + + + + + + + + + + .SH DESCRIPTION + + + + + + .SH EXPORTS + + + + + + .LP + + + + + .B + + .br + + + + + + .RS + .TP + Types + + .RE + + + + + + + .br + + + + + + .br + + + + + .RS + + .RE + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/xsl/db_pdf.xsl b/lib/erl_docgen/priv/xsl/db_pdf.xsl new file mode 100644 index 0000000000..bef86277ea --- /dev/null +++ b/lib/erl_docgen/priv/xsl/db_pdf.xsl @@ -0,0 +1,1129 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + | + : + + + + + + + : + + | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is + . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + User's Guide + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Reference Manual + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + () + + + () + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + / + + + + + + + + + + + + + + + + + + + + + +     + User's Guide + + + + + + + + + + + + + + + + + + + .   + + .   + + + + + + + + + + + + + + + + ..  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Note: + + + + + + + + + + + + + Warning: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Code listing .:  + + + + + + + + + + + + + + + + + + + Code listing .:  + + + + + + + + + + + + + + + + + + + + +     + Reference Manual + + + + + + + + + + + + + + + + + + + + + + + + + + + Erlang module + + + + + + + + + + + + + + + + + + + + + Command + + + + + + + + + + + + + + + + + + + + + C Library + + + + + + + + + + + + + + + + + + + + + Name + + + + + + + + + + + + + + + + + + + + + Application + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Exports + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Types: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Table + .: +   + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Figure + .: +   + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/lib/erl_docgen/priv/xsl/db_pdf_params.xsl b/lib/erl_docgen/priv/xsl/db_pdf_params.xsl new file mode 100644 index 0000000000..e2e264b90a --- /dev/null +++ b/lib/erl_docgen/priv/xsl/db_pdf_params.xsl @@ -0,0 +1,406 @@ + + + + + + + + + + + Copyright © - + + + + + + + + 10pt + + + 297mm + 210mm + + + + + + + + sans-serif + 0.8em + bold + always + 2.5em + 0em + + + + monospace + 0.8em + auto + preserve + 0em + + -1em + false + preserve + no-wrap + + + + 0.9em + end + + + + 130mm + retain + end + + + + solid + 10pt + #960003 + 2.3em + 0.5em + end + + + + 0.9em + end + + + + solid + 1pt + #960003 + bold + 0.5em + 200mm + retain + + + + 0.9em + bold + + + + 0.9em + bold + 2em + + + + 2em + + + + always + + + + 0.5em + 0.5em + + + + 1.8em + 1em + 0.25em + 0.25em + + + + 0.25em + + + + 0.25em + 0.25em + + + + always + + + + 2em + + + + + solid + 1pt + #960003 + page + sans-serif + 1.83em + normal + 1em + 2em + retain + + + + sans-serif + 1.5em + normal + always + 0.3em + 1em + + + + sans-serif + 1.33em + normal + always + 0.3em + 0.8em + + + + sans-serif + 1.17em + normal + always + 0.3em + 0.6em + + + + sans-serif + 1em + bold + always + 0.2em + 0.4em + + + + sans-serif + 0.83em + bold + always + 0em + 0.4em + + + + 1em + + 0.5em + 0.5em + justify + + + + solid + 2pt + #960003 + sans-serif + 0.9em + bold + + + + sans-serif + 0.9em + bold + + + + #e0e0ff + monospace + 0.8em + auto + preserve + 0em + 1em + 1em + 2em + false + preserve + no-wrap + + + + + + 1em + + + + #d0fed0 + 1em + 2em + justify + 1em + 0.3em + 1em + 1em + always + + + + #ffd6d6 + 1em + 2em + justify + 1em + 0.3em + 1em + 1em + always + + + + + 1.33em + + + + always + 2em + 1em + + + + solid + 1pt + sans-serif + 1.5em + normal + always + 0.3em + 1em + + + + bold + monospace + + always + 0.3em + 1.5em + + + + 1.8em + 1em + 0.25em + 0.25em + + + + 0.25em + + + + + + separate + 1em + 1em + fixed + + 100% + + + + solid + 0.5pt + before + 0.5em + 0.5em + 0.3em + 0.3em + start + + + + solid + 1pt + before + bold + 0.5em + 0.5em + 0.3em + 0.3em + center + + + + + + + before + + + center + + + after + + + + + + + + start + + + center + + + end + + + + + + 0.5em + 0.5em + + + + sans-serif + 0.8em + bold + always + 2.5em + 0em + + + diff --git a/lib/erl_docgen/vsn.mk b/lib/erl_docgen/vsn.mk new file mode 100644 index 0000000000..d0a1c79deb --- /dev/null +++ b/lib/erl_docgen/vsn.mk @@ -0,0 +1,22 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# + +ERL_DOCGEN_VSN = 0.1 + +TICKETS = -- cgit v1.2.3