OTP-8343 The documentation is now possible to build in an open source

          environment after a number of bugs are fixed and some features
          are added in the documentation build process.

          - The arity calculation is updated.

          - The module prefix used in the function names for bif's are
            removed in the generated links so the links will look like

            http://www.erlang.org/doc/man/erlang.html#append_element-2

            instead of

            http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2

          - Enhanced the menu positioning in the html documentation when a
            new page is loaded.
          - A number of corrections in the generation of man pages (thanks
            to Sergei Golovan)
          - Moved some man pages to more apropriate sections, pages in
            section 4 moved to 5 and pages in 6 moved to 7.
          - The legal notice is taken from the xml book file so OTP's
            build process can be used for non OTP applications.

3 files changed, 166 insertions, 13 deletions

diff --git a/lib/erl_docgen/priv/bin/Makefile b/lib/erl_docgen/priv/bin/Makefile
index bd59675003..95ad36216a 100644
--- a/lib/erl_docgen/priv/bin/Makefile
+++ b/lib/erl_docgen/priv/bin/Makefile
@@ -1,19 +1,19 @@
 #
 # %CopyrightBegin%
-# 
-# Copyright Ericsson AB 2009. All Rights Reserved.
-# 
+#
+# Copyright Ericsson AB 2009-2010. 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%
 #
 #
@@ -38,7 +38,8 @@ RELSYSDIR = $(RELEASE_PATH)/lib/erl_docgen-$(VSN)
 
 
 ESCRIPT_FILES= \
-	codeline_preprocessing.escript
+	codeline_preprocessing.escript \
+	xml_from_edoc.escript
 
 # ----------------------------------------------------
 # FLAGS
diff --git a/lib/erl_docgen/priv/bin/codeline_preprocessing.escript b/lib/erl_docgen/priv/bin/codeline_preprocessing.escript
index 33a678d3a4..592b3985e4 100755
--- a/lib/erl_docgen/priv/bin/codeline_preprocessing.escript
+++ b/lib/erl_docgen/priv/bin/codeline_preprocessing.escript
@@ -1,20 +1,20 @@
 #!/usr/bin/env escript
 %% -*- erlang -*-
 %% %CopyrightBegin%
-%% 
-%% Copyright Ericsson AB 2009. All Rights Reserved.
-%% 
+%%
+%% Copyright Ericsson AB 2009-2010. 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
@@ -54,13 +54,16 @@ main([InFile, OutFile]) ->
 main(_) ->
     usage().
         
+%%======================================================================
+%% Internal functions
+%%======================================================================
 
 %%----------------------------------------------------------------------
-%% Function: main/1
+%% Function: usage/0
 %% Description:
 %%----------------------------------------------------------------------
 usage() ->
-    io:format("usage:  codeline_preprocessing <infile> <outfile>\n"),
+    io:format("usage:  codeline_preprocessing.escript <infile> <outfile>\n"),
     halt(1).
 
 
diff --git a/lib/erl_docgen/priv/bin/xml_from_edoc.escript b/lib/erl_docgen/priv/bin/xml_from_edoc.escript
new file mode 100755
index 0000000000..ee79e82c3a
--- /dev/null
+++ b/lib/erl_docgen/priv/bin/xml_from_edoc.escript
@@ -0,0 +1,149 @@
+#!/usr/bin/env escript
+%% -*- erlang -*-
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2010. 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    : xml_from_edoc.escript
+%%
+%% Created : 12 Dec 2009 by Lars Thorsen 
+%%----------------------------------------------------------------------
+
+
+%%======================================================================
+%% Records 
+%%======================================================================
+-record(args, {suffix=".xml",
+	       layout=docb_edoc_xml_cb,
+	       def=[],
+	       includes=[],
+	       preprocess=false,
+	       sort_functions=true}).
+
+
+%%======================================================================
+%% External functions
+%%======================================================================
+%%----------------------------------------------------------------------
+%% Function: main/1
+%% Description:
+%%----------------------------------------------------------------------
+main(RawOpts) ->
+    case catch parse(RawOpts, erlref, #args{}) of
+	{ok, File, Type, Args} ->
+	    case Type of
+		erlref ->
+		    module(File, Args);
+		chapter ->
+		    users_guide(File, Args) 
+	    end;
+	{error, Msg} ->
+	    io:format("~p\n", [Msg]),
+	    usage()
+    end;
+main(_) ->
+    usage().
+        
+%%======================================================================
+%% Internal functions
+%%======================================================================
+
+%%----------------------------------------------------------------------
+%% Function: usage/0
+%% Description:
+%%----------------------------------------------------------------------
+usage() ->
+    io:format("usage:  xml_from_edoc.escript [<options>] <file> \n"),
+    halt(1).
+
+
+%%----------------------------------------------------------------------
+%% Function: module/2
+%% Description:
+%%----------------------------------------------------------------------
+module(File, Args) ->
+    case filelib:is_regular(File) of
+	true ->
+	    Opts = [{def,         Args#args.def},
+		    {includes,    Args#args.includes},
+		    {preprocess,  Args#args.preprocess},
+		    {sort_functions, Args#args.sort_functions},
+		    
+		    {app_default, "OTPROOT"},
+		    {file_suffix, Args#args.suffix},
+		    {dir,         "."},
+		    {layout,      Args#args.layout}],
+	    edoc:file(File, Opts);
+	false ->
+	    io:format("~s: not a regular file\n", [File]),
+	    usage()
+    end.
+
+
+%%----------------------------------------------------------------------
+%% Function: users_guide/2
+%% Description:
+%%----------------------------------------------------------------------
+users_guide(File, Args) ->
+    case filelib:is_regular(File) of
+	true ->
+	    Opts = [{def,         Args#args.def},
+		    {app_default, "OTPROOT"},
+		    {file_suffix, Args#args.suffix},
+		    {layout,      Args#args.layout}],
+	    
+	    Env = edoc_lib:get_doc_env(Opts),
+	    
+	    {ok, Tags} =
+		edoc_extract:file(File, overview, Env, Opts),
+	    Data =
+		edoc_data:overview("Overview", Tags, Env, Opts),
+	    F = fun(M) -> M:overview(Data, Opts) end,
+	    Text = edoc_lib:run_layout(F, Opts),
+	    
+	    OutFile = "chapter" ++ Args#args.suffix,
+	    edoc_lib:write_file(Text, ".", OutFile);
+	false ->
+	    io:format("~s: not a regular file\n", [File]),
+	    usage()
+    end.
+
+
+
+parse(["-xml" |RawOpts], Type, Args) ->
+    parse(RawOpts, Type, Args); % default, no update of record necessary
+parse(["-sgml" |RawOpts], Type, Args) ->
+    parse(RawOpts, Type, Args#args{suffix=".sgml", layout=docb_edoc_sgml_cb});
+parse(["-chapter" |RawOpts], _Type, Args) ->
+    parse(RawOpts, chapter, Args);
+parse(["-def", Key, Val |RawOpts], Type, Args) ->
+    Args2 = Args#args{def=Args#args.def++[{list_to_atom(Key), Val}]},
+    parse(RawOpts, Type, Args2);
+
+parse(["-i", Dir |RawOpts], Type, Args) ->
+    Args2 = Args#args{includes=Args#args.includes++[Dir]},
+    parse(RawOpts, Type, Args2);
+parse(["-preprocess", Bool |RawOpts], Type, Args) when Bool == "true";
+						       Bool == "false" ->
+    parse(RawOpts, Type, Args#args{preprocess=list_to_atom(Bool)});
+parse(["-sort_functions", Bool |RawOpts], Type, Args) when Bool == "true";
+							   Bool == "false" ->
+    parse(RawOpts, Type, Args#args{sort_functions=list_to_atom(Bool)});
+parse([File], Type, Args) ->
+    {ok, File, Type, Args};
+parse([Opt | _RawOpts], _Type, _Args) ->
+    {error, io_lib:format("Bad option: ~p", [Opt])}.
+