From 0295e6350bc344ce443c80e7251c6e5fc48159ba Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Fri, 16 Nov 2012 11:12:07 +0100 Subject: Generate intra-document references --- lib/diameter/doc/src/.gitignore | 1 + lib/diameter/doc/src/Makefile | 8 +- lib/diameter/doc/src/diameter.ent | 196 ---------------------------- lib/diameter/doc/src/diameter.xml | 6 +- lib/diameter/doc/src/diameter_app.xml | 6 +- lib/diameter/doc/src/diameter_compile.xml | 6 +- lib/diameter/doc/src/diameter_dict.xml | 6 +- lib/diameter/doc/src/diameter_sctp.xml | 6 +- lib/diameter/doc/src/diameter_tcp.xml | 6 +- lib/diameter/doc/src/diameter_transport.xml | 6 +- lib/diameter/doc/src/files.mk | 3 - lib/diameter/doc/src/seealso.ent | 113 ++++++++++++++++ lib/diameter/doc/src/seehere.sed | 35 +++++ 13 files changed, 182 insertions(+), 216 deletions(-) delete mode 100644 lib/diameter/doc/src/diameter.ent create mode 100644 lib/diameter/doc/src/seealso.ent create mode 100644 lib/diameter/doc/src/seehere.sed (limited to 'lib/diameter/doc') diff --git a/lib/diameter/doc/src/.gitignore b/lib/diameter/doc/src/.gitignore index feeb378fd8..5776e1cc76 100644 --- a/lib/diameter/doc/src/.gitignore +++ b/lib/diameter/doc/src/.gitignore @@ -1,2 +1,3 @@ /depend.mk +/seehere.ent diff --git a/lib/diameter/doc/src/Makefile b/lib/diameter/doc/src/Makefile index 6e91181c6c..8ad38ba0d5 100644 --- a/lib/diameter/doc/src/Makefile +++ b/lib/diameter/doc/src/Makefile @@ -35,7 +35,7 @@ XML_REF_FILES = $(XML_REF1_FILES) $(XML_REF3_FILES) $(XML_REF4_FILES) XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) \ $(XML_REF_FILES) \ $(XML_PART_FILES) $(XML_CHAPTER_FILES) \ - $(XML_ENTITY_FILES) + seealso.ent INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) @@ -94,7 +94,7 @@ html: gifs $(HTML_REF_MAN_FILE) clean clean_docs: clean_pdf clean_html clean_man rm -f errs core *~ - rm -f depend.mk + rm -f depend.mk seehere.ent clean_pdf: rm -f $(PDFDIR)/* @@ -171,7 +171,9 @@ release_docs_spec: $(LOCAL)docs release_spec: -depend.mk: depend.sed $(XML_REF_FILES) $(XML_CHAPTER_FILES) Makefile +depend.mk: depend.sed Makefile seealso.ent \ + $(XML_REF_FILES) $(XML_CHAPTER_FILES) + sed -f seehere.sed seealso.ent > seehere.ent (for f in $(XML_REF_FILES) $(XML_CHAPTER_FILES); do \ sed -f $< $$f | sed "s@%FILE%@`basename $$f .xml`@g"; \ done) \ diff --git a/lib/diameter/doc/src/diameter.ent b/lib/diameter/doc/src/diameter.ent deleted file mode 100644 index fbfbe817a9..0000000000 --- a/lib/diameter/doc/src/diameter.ent +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - -add_transport/2'> -call/4'> -origin_state_id/0'> -remove_transport/2'> -service_info/2'> -services/0'> -start_service/2'> -stop_service/1'> -subscribe/1'> - -application_alias()'> -application_module()'> -application_opt()'> -call_opt()'> -capability()'> -evaluable()'> -peer_filter()'> -service_event()'> -service_name()'> -service_opt()'> -transport_opt()'> -transport_ref()'> - -application'> -capabilities_cb'> -capx_timeout'> -disconnect_cb'> -transport_config'> -transport_module'> -reconnect_timer'> -watchdog_timer'> - -diameter:add_transport/2'> -diameter:call/4'> -diameter:remove_transport/2'> -diameter:start_service/2'> - -diameter:call_opt()'> -diameter:application_opt()'> -diameter:evaluable()'> -diameter:service_name()'> -diameter:transport_opt()'> -diameter:transport_ref()'> - - - -handle_answer/4'> -handle_request/3'> -handle_error/4'> -peer_down/3'> -peer_up/3'> -pick_peer/4'> -prepare_retransmit/3'> -prepare_request/3'> - -capabilities()'> -message()'> -packet()'> -peer()'> -peer_ref()'> -state()'> - -handle_answer/4'> -handle_request/3'> -handle_error/4'> -peer_up/3'> -pick_peer/4'> -prepare_retransmit/3'> -prepare_request/3'> - -diameter_app:message()'> -diameter_app:peer()'> -diameter_app:peer_ref()'> - - - -diameter_dict(4)'> - -Address()'> -DiameterIdentity()'> -Grouped()'> -OctetString()'> -Time()'> -UTF8String()'> -Unsigned32()'> - - - -start/3'> - - - -diameterc(1)'> -diameter(3)'> -diameter_app(3)'> -diameter_dict(4)'> -diameter_transport(3)'> -diameter_sctp(3)'> -diameter_tcp(3)'> diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 2a2fff86a9..b47ca56b10 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml index 826b28aaac..304c69ebda 100644 --- a/lib/diameter/doc/src/diameter_app.xml +++ b/lib/diameter/doc/src/diameter_app.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml index 5ca8126b83..eb6de80c11 100644 --- a/lib/diameter/doc/src/diameter_compile.xml +++ b/lib/diameter/doc/src/diameter_compile.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/diameter_dict.xml b/lib/diameter/doc/src/diameter_dict.xml index 4956ff4be0..4a6cccc276 100644 --- a/lib/diameter/doc/src/diameter_dict.xml +++ b/lib/diameter/doc/src/diameter_dict.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index 053c305978..a023a9bc08 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index 1d4196ed61..be8a938115 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index a06d8a348b..0507af63a8 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -1,7 +1,9 @@ - %ents; + + + %also; + %here; ]> diff --git a/lib/diameter/doc/src/files.mk b/lib/diameter/doc/src/files.mk index 48f604c98f..89ec1031e6 100644 --- a/lib/diameter/doc/src/files.mk +++ b/lib/diameter/doc/src/files.mk @@ -17,9 +17,6 @@ # # %CopyrightEnd% -XML_ENTITY_FILES = \ - diameter.ent - XML_APPLICATION_FILES = \ ref_man.xml diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent new file mode 100644 index 0000000000..a0143fd6d6 --- /dev/null +++ b/lib/diameter/doc/src/seealso.ent @@ -0,0 +1,113 @@ + + + + + + + + +diameter:add_transport/2'> +diameter:call/4'> +diameter:origin_state_id/0'> +diameter:remove_transport/2'> +diameter:service_info/2'> +diameter:services/0'> +diameter:start_service/2'> +diameter:stop_service/1'> +diameter:subscribe/1'> + +diameter:application_alias()'> +diameter:application_module()'> +diameter:application_opt()'> +diameter:call_opt()'> +diameter:capability()'> +diameter:evaluable()'> +diameter:peer_filter()'> +diameter:service_event()'> +diameter:service_name()'> +diameter:service_opt()'> +diameter:transport_opt()'> +diameter:transport_ref()'> + +application'> +capabilities_cb'> +capx_timeout'> +disconnect_cb'> +transport_config'> +transport_module'> +reconnect_timer'> +watchdog_timer'> + + + +handle_answer/4'> +handle_request/3'> +handle_error/4'> +peer_up/3'> +peer_up/3'> +pick_peer/4'> +prepare_retransmit/3'> +prepare_request/3'> + +diameter_app:capabilities()'> +diameter_app:message()'> +diameter_app:packet()'> +diameter_app:peer()'> +diameter_app:peer_ref()'> +diameter_app:state()'> + + + +diameter_dict(4)'> + +Address()'> +DiameterIdentity()'> +Grouped()'> +OctetString()'> +Time()'> +UTF8String()'> +Unsigned32()'> + + + +start/3'> + + + +diameterc(1)'> +diameter(3)'> +diameter_app(3)'> +diameter_dict(4)'> +diameter_transport(3)'> +diameter_sctp(3)'> +diameter_tcp(3)'> diff --git a/lib/diameter/doc/src/seehere.sed b/lib/diameter/doc/src/seehere.sed new file mode 100644 index 0000000000..c62a783d40 --- /dev/null +++ b/lib/diameter/doc/src/seehere.sed @@ -0,0 +1,35 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2012. 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% + +# +# Map entities for inter-document references to ones for +# intra-document references like this: +# +# ccc:zzz'> +# +# ===> +# +# zzz'> +# + +/[^:]*:@>@ -- cgit v1.2.3