aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/priv
diff options
context:
space:
mode:
Diffstat (limited to 'lib/edoc/priv')
-rw-r--r--lib/edoc/priv/Makefile54
-rw-r--r--lib/edoc/priv/edoc.dtd139
-rw-r--r--lib/edoc/priv/edoc_generate.src76
-rw-r--r--lib/edoc/priv/erlang.pngbin0 -> 2109 bytes
-rw-r--r--lib/edoc/priv/stylesheet.css55
5 files changed, 324 insertions, 0 deletions
diff --git a/lib/edoc/priv/Makefile b/lib/edoc/priv/Makefile
new file mode 100644
index 0000000000..13225e6d1a
--- /dev/null
+++ b/lib/edoc/priv/Makefile
@@ -0,0 +1,54 @@
+#
+# Copyright (C) 2004, Ericsson Telecommunications
+# Author: Richard Carlsson, Bertil Karlsson
+#
+include $(ERL_TOP)/make/target.mk
+include $(ERL_TOP)/make/$(TARGET)/otp.mk
+
+# ----------------------------------------------------
+# Application version
+# ----------------------------------------------------
+include ../vsn.mk
+include ../../xmerl/vsn.mk
+include ../../syntax_tools/vsn.mk
+
+
+# ----------------------------------------------------
+# Release directory specification
+# ----------------------------------------------------
+RELSYSDIR = $(RELEASE_PATH)/lib/edoc-$(EDOC_VSN)
+
+
+#
+# Common Macros
+#
+
+GEN_SCRIPT_SRC = edoc_generate.src
+GEN_SCRIPT = edoc_generate
+PRIV_FILES = stylesheet.css erlang.png edoc.dtd
+
+debug opt:
+ sed -e "s/%EDOC_VSN%/$(EDOC_VSN)/g" \
+ -e "s/%XMERL_VSN%/$(XMERL_VSN)/g" \
+ -e "s/%SYNTAX_TOOLS_VSN%/$(SYNTAX_TOOLS_VSN)/g" \
+ $(GEN_SCRIPT_SRC) > $(GEN_SCRIPT)
+
+clean:
+ rm -f $(GEN_SCRIPT)
+ rm -f core *~
+
+docs:
+
+# ----------------------------------------------------
+# Release Target
+# ----------------------------------------------------
+include $(ERL_TOP)/make/otp_release_targets.mk
+
+release_spec: opt
+ $(INSTALL_DIR) $(RELSYSDIR)/priv
+ $(INSTALL_DATA) $(PRIV_FILES) $(RELSYSDIR)/priv
+ $(INSTALL_SCRIPT) $(GEN_SCRIPT) $(RELSYSDIR)/priv
+
+
+release_docs_spec:
+
diff --git a/lib/edoc/priv/edoc.dtd b/lib/edoc/priv/edoc.dtd
new file mode 100644
index 0000000000..6a332cf22f
--- /dev/null
+++ b/lib/edoc/priv/edoc.dtd
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- EDoc DTD Version 0.3 -->
+
+<!ELEMENT overview (title, description?, author*, copyright?, version?,
+ since?, see*, reference*, todo?, packages, modules)>
+<!ATTLIST overview
+ root CDATA #IMPLIED>
+
+<!ELEMENT title (#PCDATA)>
+
+<!ELEMENT package (description?, author*, copyright?, version?,
+ since?, deprecated?, see*, reference*, todo?,
+ modules)>
+<!ATTLIST package
+ name CDATA #REQUIRED
+ root CDATA #IMPLIED>
+
+<!ELEMENT modules (module+)>
+
+
+<!ELEMENT module (args?, description?, author*, copyright?, version?,
+ since?, deprecated?, see*, reference*, todo?,
+ behaviour*, callbacks?, typedecls?, functions)>
+<!ATTLIST module
+ name CDATA #REQUIRED
+ private (yes | no) #IMPLIED
+ hidden (yes | no) #IMPLIED
+ root CDATA #IMPLIED>
+
+<!ELEMENT description (briefDescription, fullDescription?)>
+<!ELEMENT briefDescription (#PCDATA)>
+<!ELEMENT fullDescription (#PCDATA)>
+
+<!ELEMENT author EMPTY>
+<!ATTLIST author
+ name CDATA #REQUIRED
+ email CDATA #IMPLIED
+ website CDATA #IMPLIED>
+
+<!ELEMENT copyright (#PCDATA)>
+<!ELEMENT version (#PCDATA)>
+<!ELEMENT since (#PCDATA)>
+<!ELEMENT deprecated (description)>
+
+<!ELEMENT see (#PCDATA)>
+<!ATTLIST see
+ name CDATA #REQUIRED
+ href CDATA #IMPLIED>
+
+<!ELEMENT reference (#PCDATA)>
+
+<!ELEMENT todo (#PCDATA)>
+
+<!ELEMENT behaviour (#PCDATA)>
+<!ATTLIST behaviour
+ href CDATA #IMPLIED>
+
+<!ELEMENT callbacks (callback+)>
+<!ELEMENT callback EMPTY>
+<!ATTLIST callback
+ name CDATA #REQUIRED
+ arity CDATA #REQUIRED>
+
+<!ELEMENT typedecls (typedecl+)>
+<!ELEMENT typedecl (typedef, description?)>
+<!ATTLIST typedecl
+ label CDATA #IMPLIED>
+
+<!ELEMENT functions (function+)>
+<!ELEMENT function (args, typespec?, returns?, throws?, equiv?,
+ description?, since?, deprecated?, see*, todo?)>
+<!ATTLIST function
+ name CDATA #REQUIRED
+ arity CDATA #REQUIRED
+ exported (yes | no) #IMPLIED
+ label CDATA #IMPLIED>
+
+<!ELEMENT args (arg*)>
+<!ELEMENT arg (argName, description?)>
+<!ELEMENT argName (#PCDATA)>
+
+<!ELEMENT throws (type, localdef*)>
+<!ELEMENT returns (description)>
+
+<!ELEMENT equiv (expr, see?)>
+<!ELEMENT expr (#PCDATA)>
+
+<!ELEMENT erlangName EMPTY>
+<!ATTLIST erlangName
+ app CDATA #IMPLIED
+ module CDATA #IMPLIED
+ name CDATA #REQUIRED>
+
+
+<!-- Data type specifications -->
+
+<!ELEMENT typedef (erlangName, argtypes, type?, localdef*)>
+
+<!ELEMENT typespec (erlangName, type, localdef*)>
+
+<!ELEMENT localdef ((typevar | abstype), type)>
+<!ATTLIST localdef label CDATA #IMPLIED>
+
+<!ELEMENT argtypes (type*)>
+
+<!ELEMENT type (typevar | atom | integer | float | nil | list | tuple |
+ fun | record | abstype | union)>
+<!ATTLIST type name CDATA #IMPLIED>
+
+<!ELEMENT union (typevar | atom | integer | float | nil | list | tuple |
+ fun | record | abstype)+>
+
+<!ELEMENT typevar EMPTY>
+<!ATTLIST typevar name CDATA #REQUIRED>
+
+<!ELEMENT atom EMPTY>
+<!ATTLIST atom value CDATA #REQUIRED>
+
+<!ELEMENT integer EMPTY>
+<!ATTLIST integer value CDATA #REQUIRED>
+
+<!ELEMENT float EMPTY>
+<!ATTLIST float value CDATA #REQUIRED>
+
+<!ELEMENT nil EMPTY>
+
+<!ELEMENT list (type)>
+
+<!ELEMENT tuple (type*)>
+
+<!ELEMENT fun (argtypes, type)>
+
+<!ELEMENT record (atom, field*)>
+
+<!ELEMENT field (atom, type)>
+
+<!ELEMENT abstype (erlangName, type*)>
+<!ATTLIST abstype
+ href CDATA #IMPLIED>
diff --git a/lib/edoc/priv/edoc_generate.src b/lib/edoc/priv/edoc_generate.src
new file mode 100644
index 0000000000..e87fdbc902
--- /dev/null
+++ b/lib/edoc/priv/edoc_generate.src
@@ -0,0 +1,76 @@
+#!/bin/sh
+# ``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 expressed 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-2000, Ericsson
+# Utvecklings AB. All Rights Reserved.''
+#
+# $Id$
+#
+#
+
+#EDOC_DIR=/clearcase/otp/internal_tools/edoc
+EDOC_DIR=/home/otp/sgml/edoc-%EDOC_VSN%
+SYNTAX_TOOLS_DIR=/home/otp/sgml/syntax_tools-%SYNTAX_TOOLS_VSN%
+XMERL_DIR=/home/otp/sgml/xmerl-%XMERL_VSN%
+
+FILE=
+APP=
+TITLE=
+VSN=
+
+while [ $# -gt 0 ]; do
+ case $1 in
+ -file)
+ FILE=$2;
+ shift;
+ shift;;
+ -app)
+ APP=$2;
+ shift;
+ shift;;
+ -title)
+ TITLE=$2;
+ shift;
+ shift;;
+ -vsn)
+ VSN=$2;
+ shift;
+ shift;;
+ esac
+done
+
+if [ -n "$FILE" ] ; then
+ EDOC_ARGS="[{layout,otpsgml_layout},{dir,\".\"},{file_suffix,\".sgml\"},{preprocess,true},{includes,[\"$XMERL_DIR/include\"]}]"
+ erl -boot start_clean -noshell \
+ -pa $EDOC_DIR/ebin \
+ -pa $SYNTAX_TOOLS_DIR/ebin \
+ -pa $XMERL_DIR/ebin \
+ -run edoc_run file $FILE $EDOC_ARGS \
+ -s erlang halt
+elif [ -n "$APP" -a -n "$TITLE" ] ; then
+ erl -boot start_clean -noshell \
+ -pa $EDOC_DIR/ebin \
+ -pa $SYNTAX_TOOLS_DIR/ebin \
+ -pa $XMERL_DIR/ebin \
+ -run edoc_run application $APP "\".\"" "[{title,$TITLE}]" \
+ -s erlang halt
+elif [ -n "$APP" -a -n "$VSN" ] ; then
+ erl -boot start_clean -noshell \
+ -pa $EDOC_DIR/ebin \
+ -pa $SYNTAX_TOOLS_DIR/ebin \
+ -pa $XMERL_DIR/ebin \
+ -run edoc_run application $APP "\".\"" "[{def,{vsn,\"$VSN\"}}]" \
+ -s erlang halt
+else
+ echo "Usage: docb_edoc [-file Filename] | [-app Appname [-title Title |-vsn Vsn]]"
+fi
diff --git a/lib/edoc/priv/erlang.png b/lib/edoc/priv/erlang.png
new file mode 100644
index 0000000000..987a618e24
--- /dev/null
+++ b/lib/edoc/priv/erlang.png
Binary files differ
diff --git a/lib/edoc/priv/stylesheet.css b/lib/edoc/priv/stylesheet.css
new file mode 100644
index 0000000000..e426a90483
--- /dev/null
+++ b/lib/edoc/priv/stylesheet.css
@@ -0,0 +1,55 @@
+/* standard EDoc style sheet */
+body {
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ margin-left: .25in;
+ margin-right: .2in;
+ margin-top: 0.2in;
+ margin-bottom: 0.2in;
+ color: #000000;
+ background-color: #ffffff;
+}
+h1,h2 {
+ margin-left: -0.2in;
+}
+div.navbar {
+ background-color: #add8e6;
+ padding: 0.2em;
+}
+h2.indextitle {
+ padding: 0.4em;
+ background-color: #add8e6;
+}
+h3.function,h3.typedecl {
+ background-color: #add8e6;
+ padding-left: 1em;
+}
+div.spec {
+ margin-left: 2em;
+ background-color: #eeeeee;
+}
+a.module,a.package {
+ text-decoration:none
+}
+a.module:hover,a.package:hover {
+ background-color: #eeeeee;
+}
+ul.definitions {
+ list-style-type: none;
+}
+ul.index {
+ list-style-type: none;
+ background-color: #eeeeee;
+}
+
+/*
+ * Minor style tweaks
+ */
+ul {
+ list-style-type: square;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 3
+}
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 02:50:39 +0000