Add link to RTD index

[ric-plt/lib/rmr.git] / doc / src / library / user.xfm

diff --git a/doc/src/library/user.xfm b/doc/src/library/user.xfm
index ce3e5dd..3fe3e12 100644 (file)
--- a/doc/src/library/user.xfm
+++ b/doc/src/library/user.xfm
@@ -1,7 +1,7 @@
 .if false
 ==================================================================================
-       Copyright (c) 2019 Nokia
-       Copyright (c) 2018-2019 AT&T Intellectual Property.
+       Copyright (c) 2019-2020 Nokia
+       Copyright (c) 2018-2020 AT&T Intellectual Property.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -24,61 +24,30 @@
        Author:         E. Scott Daniels
 .fi
 
+.dv textfont Helvetica
+.dv textsize 10p
+.gv e XFM_PASS pass
+
+.** vars picked up by front_junk or gen_title as it's a generic module
+.dv doc_title RIC Message Router -- RMR
+.dv doc_subtitle User's Guide
+.dv orig_date 30 July 2019
+.** must reverse titles when generating rst to disambiguate in the doc list
+.dv reverse_titles 1
+
 .** setup will do the right thing with the index configuration
 .dv index_snare_file index_snatch.im
 .im ./setup.im
 
-.** func is a bit odd; if punct needs to be added, it must be supplied as the second
-.** parm because we add () to the first. E.g. &func(foo_bar:.) will add a parm
-.**
-.dv func .ix force ${1} ^:  ^&cw(${1}()$2 )
-
 .dv mtsid message type and subscription ID
 .dv Mtsid Message type and subscription ID
 .dv mt message type
 .dv Mt Message type
 .dv mts message types
 
-.dv textfont Helvetica
-.dv textsize 10p
-.hn off
-
-
-.gv e XFM_PASS pass
-.if &pass 2 =
-       .** two pass mode -- pull in variables captured during pass 1 for forward references
-       .im p1var_setup.ca
-.fi
-
-.** vars picked up by front_junk as it's a generic module
-.dv doc_title RIC Message Router -- RMR
-.dv doc_subtitle User's Manual
-
-.if pfm
-       .** add licence,  a title page, and table of contents
-       .im front_junk.im
-.ei
-       .** for text based things, nothing more than license
-       .im license.im
-.fi
-
-.if pfm
-       .pn on noline center f=%d 0
-.fi
-
-&mult_space( 5 )
-.st 18
-&center_start
-.sf &bold_font
-&doc_title
-.br
-.st 12
-&doc_subtitle
-&center_end
-.sf &textfont
-&mult_space( 2 )
-.st &textsize
+.** --------------------------------------------------------------------------------------
 
+&line_len( &line_size )
 &h1(Overview)
 
 The RIC Message Router (RMR) is a library for peer-to-peer
@@ -178,6 +147,7 @@ document.
 
 .if tfm
        .** show all column/foot notes
+       &h1(Notes)
        .cn showend
        &mult_space( 3 )
 .fi
@@ -186,7 +156,14 @@ document.
 
 .dv qr_appendix A
 .pa
-.im api_qref.im
+.if "&ot" "rst" =
+&h1(Appendix &qr_appendix -- Quick Reference)
+       Please refer to the RMR manual pages on the Read the Docs site
+       &space
+       https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/latest/index.html
+.ei
+       .im api_qref.im
+.fi
 
 .dv mbuf_appendix B
 .pa