add introduction to UA to documentation. reset doxygen style until a more complete reskin is ready

README.md

@@ -11,8 +11,8 @@ The project is in an early stage but already usable. See below for a simple serv
 [![Coverity Scan Build Status](https://scan.coverity.com/projects/1864/badge.svg)](https://scan.coverity.com/projects/1864)
 
 ### Documentation
-The developer documentation is generated from Doxygen annotations in the source code: http://open62541.org/doc.
-Build instruction can be found under https://github.com/acplt/open62541/wiki/Building-open62541.
+A general introduction to OPC UA and the open62541 documentation can be found at http://open62541.org/doc.
+Build instruction are here: https://github.com/acplt/open62541/wiki/Building-open62541.
 
 For discussion and help, you can use
 - the [mailing list](https://groups.google.com/d/forum/open62541)

doc/Doxyfile.in

@@ -672,7 +672,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            =
+LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/doc/DoxygenLayout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
 # the reference definitions. This must be a list of .bib files. The .bib
@@ -1046,7 +1046,7 @@ HTML_FILE_EXTENSION    = .html
 # of the possible markers and block names see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_HEADER            = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/header.html
+#HTML_HEADER            = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/header.html
 
 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1056,7 +1056,7 @@ HTML_HEADER            = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/footer.html
+#HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1068,7 +1068,7 @@ HTML_FOOTER            = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/footer.html
 # obsolete.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_STYLESHEET        = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/doxygen.css
+#HTML_STYLESHEET        = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/doxygen.css
 
 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
 # defined cascading style sheet that is included after the standard style sheets
@@ -1089,8 +1089,8 @@ HTML_EXTRA_STYLESHEET  =
 # files will be copied as-is; there are no commands or markers available.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_FILES       = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/jquery-1.11.1.min.js \
-                         @CMAKE_CURRENT_SOURCE_DIR@/doc/style/load-style.js
+#HTML_EXTRA_FILES       = @CMAKE_CURRENT_SOURCE_DIR@/doc/style/jquery-1.11.1.min.js \
+#                         @CMAKE_CURRENT_SOURCE_DIR@/doc/style/load-style.js
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the stylesheet and background images according to
@@ -1925,7 +1925,7 @@ SEARCH_INCLUDES        = YES
 # preprocessor.
 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
 
-INCLUDE_PATH           = src
+INCLUDE_PATH           = 
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
 # patterns (like *.h and *.hpp) to filter out the header-files in the

doc/Makefile.am

@@ -1,19 +0,0 @@
-if ENABLE_DOXYGEN
-directory = $(top_srcdir)/doc/man/man3/
-
-dist_man_MANS = $(directory)/man_page_1.3 $(directory)/man_page_2.3
-$(directory)/man_page_1.3: doxyfile.stamp
-$(directory)/man_page_2.3: doxyfile.stamp
-
-doxyfile.stamp:
-	$(DOXYGEN) Doxyfile
-	echo Timestamp > doxyfile.stamp
-
-CLEANFILES = doxyfile.stamp
-
-all-local: doxyfile.stamp
-clean-local:
-	rm -rf $(top_srcdir)/docs/man
-	rm -rf html
-	rm -rf latex
-endif

doc/mainpage.dox

@@ -1,6 +1,29 @@
 /**
 \mainpage Open62541 Developer Documentation
 
-This file should contain some high-level description and pointers for further reading.
+<a href="http://en.wikipedia.org/wiki/OPC_Unified_Architecture">OPC UA</a>
+(short for OPC Universal Architecture) is a communication protocol originally
+developed in the context of industrial automation. OPC UA has been released as
+an “open” standard (meaning everybody can buy the document) in the IEC 62541
+series. As of late, it is marketed as the one standard for non-realtime
+industrial communication.
+
+Remote clients can interact with a \ref server by calling remote \ref services.
+(The services are different from a remote procedure call that is provided via
+the "Call" service.) The server contains a rich information model that defines
+an object system on top of an ontology-like set of nodes and references between
+nodes. The data and its "meta model" can be inspected to discover variables,
+objects, object types, methods, data types, and so on. Roughly, the \ref
+services provide access to
+
+- Session management
+- CRUD operations on the node level
+- Remote procedure calls to methods defined in the address space
+- Subscriptions to events and variable changes where clients are notified via push messages.
+
+The data structures the services process as in- and output can be encoded either
+as a binary stream or in XML. They are transported via a TCP-based custom
+protocol or via Webservices. Currently, open62541 supports only the binary
+encoding and TCP-based transport.
 
 */