antora

Author: jll63

doc/modules/ROOT/nav.adoc

@@ -1,28 +1,14 @@
-// * xref:quicklook.adoc[]
-// * xref:urls/index.adoc[]
-// ** xref:urls/parsing.adoc[]
-// ** xref:urls/containers.adoc[]
-// ** xref:urls/segments.adoc[]
-// ** xref:urls/params.adoc[]
-// ** xref:urls/normalization.adoc[]
-// ** xref:urls/stringtoken.adoc[]
-// ** xref:urls/percent-encoding.adoc[]
-// ** xref:urls/formatting.adoc[]
-// * xref:grammar/index.adoc[]
-// ** xref:grammar/rules.adoc[]
-// ** xref:grammar/charset.adoc[]
-// ** xref:grammar/combinators.adoc[]
-// ** xref:grammar/range.adoc[]
-// ** xref:grammar/rfc3986.adoc[]
-// * Examples
-// ** xref:examples/qrcode.adoc[]
-// ** xref:examples/finicky.adoc[]
-// ** xref:examples/mailto.adoc[]
-// ** xref:examples/magnet-link.adoc[]
-// ** xref:examples/file-router.adoc[]
-// ** xref:examples/router.adoc[]
-// ** xref:examples/sanitize.adoc[]
 * Tutorials
 ** xref:hello_world.adoc[Hello World]
-// * xref:HelpCard.adoc[]
+** xref:multiple_dispatch.adoc[Multiple Dispatch]
+** xref:headers_namespaces.adoc[Namespaces and Headers]
+** xref:friendship.adoc[Friendship]
+** xref:performance.adoc[Performance]
+** xref:smart_pointers.adoc[Smart Pointers]
+** xref:virtual_ptr_alt.adoc[Virtual Pointer Alternatives]
+** xref:core_api.adoc[Core API]
+** xref:policies.adoc[Registries and Policies]
+** xref:error_handling.adoc[Error Handling]
+** xref:custom_rtti.adoc[Custom RTTI]
+** xref:dynamic_loading.adoc[Dynamic Loading]
 * xref:reference:boost/openmethod.adoc[Reference]

doc/core_api.adoc doc/modules/ROOT/pages/core_api.adocdoc/core_api.adoc renamed to doc/modules/ROOT/pages/core_api.adoc

@@ -29,7 +29,7 @@ name can get tedious, so OpenMethod provides a macro for that:
 
 [source,c++]
 ----
-include::{exampledir}/core_api.cpp[tag=method]
+include::example$core_api.cpp[tag=method]
 ----
 
 NOTE: BOOST_OPENMETHOD and associated macros use `BOOST_OPENMETHOD_ID` in
@@ -48,7 +48,7 @@ Overriders are ordinary functions, added to a method using the nested template
 
 [source,c++]
 ----
-include::{exampledir}/core_api.cpp[tag=poke_cat]
+include::example$core_api.cpp[tag=poke_cat]
 ----
 
 NOTE: `override` can register multiple overriders.
@@ -58,14 +58,14 @@ identifier. In the meantime, OpenMethod provides a small convenience macro:
 
 [source,c++]
 ----
-include::{exampledir}/core_api.cpp[tag=poke_dog]
+include::example$core_api.cpp[tag=poke_dog]
 ----
 
 `next` is available from the method's nested `next` template:
 
 [source,c++]
 ----
-include::{exampledir}/core_api.cpp[tag=poke_bulldog]
+include::example$core_api.cpp[tag=poke_bulldog]
 ----
 
 NOTE: Since the function uses itself as a template argument in its body, its
@@ -81,12 +81,12 @@ We register the classes with `use_classes`:
 
 [source,c++]
 ----
-include::{exampledir}/core_api.cpp[tag=use_classes]
+include::example$core_api.cpp[tag=use_classes]
 ----
 
 Finally, we call the method via the static member of the method class `fn`:
 
 [source,c++]
 ----
-include::{exampledir}/core_api.cpp[tag=main]
+include::example$core_api.cpp[tag=main]
 ----

doc/custom_rtti.adoc doc/modules/ROOT/pages/custom_rtti.adocdoc/custom_rtti.adoc renamed to doc/modules/ROOT/pages/custom_rtti.adoc

@@ -101,7 +101,7 @@ Here is the facet implementation:
 
 [source,c++]
 ----
-include::{exampledir}/custom_rtti.cpp[tag=facet]
+include::example$custom_rtti.cpp[tag=facet]
 ----
 
 This facet is quite minimal. It does not support virtual inheritance. It would
@@ -113,15 +113,15 @@ CRTP template:
 
 [source,c++]
 ----
-include::{exampledir}/custom_rtti.cpp[tag=policy]
+include::example$custom_rtti.cpp[tag=policy]
 ----
 
 Next, we include the main header. Because `BOOST_OPENMETHOD_DEFAULT_REGISTRY` is
 defined, its value is used for the default policy. Then comes the usual example.
 
 [source,c++]
 ----
-include::{exampledir}/custom_rtti.cpp[tag=example]
+include::example$custom_rtti.cpp[tag=example]
 ----
 
 This programs works even if standard RTTI is disabled.
@@ -141,7 +141,7 @@ This time let's support virtual inheritance as well. First the domain classes:
 
 [source,c++]
 ----
-include::{exampledir}/deferred_custom_rtti.cpp[tag=classes]
+include::example$deferred_custom_rtti.cpp[tag=classes]
 // ditto for Dog
 ----
 
@@ -152,7 +152,7 @@ The rtti facet is the same, with one more function:
 struct custom_rtti : bom::policies::rtti {
     // as before
 
-include::{exampledir}/deferred_custom_rtti.cpp[tag=dynamic_cast_ref]
+include::example$deferred_custom_rtti.cpp[tag=dynamic_cast_ref]
 };
 ----
 

doc/dynamic_loading.adoc …/modules/ROOT/pages/dynamic_loading.adocdoc/dynamic_loading.adoc renamed to doc/modules/ROOT/pages/dynamic_loading.adoc doc/dynamic_loading.adoc renamed to doc/modules/ROOT/pages/dynamic_loading.adoc

@@ -21,7 +21,7 @@ Here is an example:
 
 [source,c++]
 ----
-include::{exampledir}/dl.hpp[tag=header]
+include::example$dl.hpp[tag=header]
 ----
 
 NOTE: The policy must be passed to the method as well as the
@@ -35,34 +35,34 @@ We can now register the classes and and provide an overrider:
 
 [source,c++]
 ----
-include::{exampledir}/dl_main.cpp[tag=main]
+include::example$dl_main.cpp[tag=main]
 ----
 
 At this point we only have one overrider. Animals of all species ignore one
 another:
 
 [source,c++]
 ----
-include::{exampledir}/dl_main.cpp[tag=before_dlopen]
+include::example$dl_main.cpp[tag=before_dlopen]
 ----
 
 Let's load a dynamic library containing this code:
 
 [source,c++]
 ----
-include::{exampledir}/dl_shared.cpp[tag=dl_shared]
+include::example$dl_shared.cpp[tag=dl_shared]
 ----
 
 Now back to `main`:
 
 [source,c++]
 ----
-include::{exampledir}/dl_main.cpp[tag=dlopen]
+include::example$dl_main.cpp[tag=dlopen]
 ----
 
 After unloading the library, we must call `initialize` again:
 
 [source,c++]
 ----
-include::{exampledir}/dl_main.cpp[tag=after_dlclose]
+include::example$dl_main.cpp[tag=after_dlclose]
 ----

doc/error_handling.adoc …c/modules/ROOT/pages/error_handling.adocdoc/error_handling.adoc renamed to doc/modules/ROOT/pages/error_handling.adoc doc/error_handling.adoc renamed to doc/modules/ROOT/pages/error_handling.adoc

@@ -12,7 +12,7 @@ handler can be set with `set_error_handler`:
 
 [source,c++]
 ----
-include::{exampledir}/default_error_handler.cpp[tag=example]
+include::example$default_error_handler.cpp[tag=example]
 ----
 
 Output:
@@ -29,7 +29,7 @@ We can also replace the `error_handler` facet with our own. For example:
 
 [source,c++]
 ----
-include::{exampledir}/throw_error_handler.cpp[tag=example]
+include::example$throw_error_handler.cpp[tag=example]
 ----
 
 [source,console]

doc/friendship.adoc doc/modules/ROOT/pages/friendship.adocdoc/friendship.adoc renamed to doc/modules/ROOT/pages/friendship.adoc

@@ -17,7 +17,7 @@ We can thus grant friendship to all the overriders of `poke`:
 
 [source,c++]
 ----
-include::{exampledir}/friendship.cpp[tag=friend_all]
+include::example$friendship.cpp[tag=friend_all]
 ----
 
 Be aware, though, that the overriders of _any_ method called `poke` - with any
@@ -27,5 +27,5 @@ We can also befriend individual overriders:
 
 [source,c++]
 ----
-include::{exampledir}/friendship.cpp[tag=friend]
+include::example$friendship.cpp[tag=friend]
 ----

doc/headers_namespaces.adoc …dules/ROOT/pages/headers_namespaces.adocdoc/headers_namespaces.adoc renamed to doc/modules/ROOT/pages/headers_namespaces.adoc doc/headers_namespaces.adoc renamed to doc/modules/ROOT/pages/headers_namespaces.adoc

@@ -11,7 +11,7 @@ Let's break the Animals example into headers and namespaces. First we put
 
 [source,c++]
 ----
-include::{exampledir}/headers_namespaces/animal.hpp[]
+include::example$headers_namespaces/animal.hpp[]
 ----
 
 `BOOST_OPENMETHOD` can be placed in a header file. It adds several constructs to
@@ -32,12 +32,12 @@ Next, let's implement the `Cat` class, and a derived class, `Cheetah`, in the
 
 [source,c++]
 ----
-include::{exampledir}/headers_namespaces/cat.hpp[]
+include::example$headers_namespaces/cat.hpp[]
 ----
 
 [source,c++]
 ----
-include::{exampledir}/headers_namespaces/cat.cpp[]
+include::example$headers_namespaces/cat.cpp[]
 ----
 
 `BOOST_OPENMETHOD_CLASSES` should be placed in an implementation file. It can
@@ -83,7 +83,7 @@ the static function `fn` just yet.
 
 [source,c++]
 ----
-include::{exampledir}/headers_namespaces/dog.hpp[]
+include::example$headers_namespaces/dog.hpp[]
 ----
 
 Unlike function declarations, which can occur multiple times in a TU, an
@@ -101,15 +101,15 @@ Now we use `BOOST_OPENMETHOD_DEFINE_OVERRIDER` to define the overrider:
 
 [source,c++]
 ----
-include::{exampledir}/headers_namespaces/dog.cpp[]
+include::example$headers_namespaces/dog.cpp[]
 ----
 
 Let's look at the main program now. It derived `Bulldog` from `Dog` and provides
 an overrider for the new class:
 
 [source,c++]
 ----
-include::{exampledir}/headers_namespaces/main.cpp[]
+include::example$headers_namespaces/main.cpp[]
 ----
 
 Again ADL plays a role: it helps the overrider (and `main`) to locate the `poke`

doc/multiple_dispatch.adoc …odules/ROOT/pages/multiple_dispatch.adocdoc/multiple_dispatch.adoc renamed to doc/modules/ROOT/pages/multiple_dispatch.adoc doc/multiple_dispatch.adoc renamed to doc/modules/ROOT/pages/multiple_dispatch.adoc

@@ -5,12 +5,12 @@ A method can have more than one `virtual_ptr` parameter. For example:
 
 [source,c++]
 ----
-include::{exampledir}/hello_world.cpp[tag=multi]
+include::example$hello_world.cpp[tag=multi]
 ----
 
 [source,c++]
 ----
-include::{exampledir}/hello_world.cpp[tag=multi_call,indent=0]
+include::example$hello_world.cpp[tag=multi_call,indent=0]
 ----
 
 The appropriate overrider is selected using a process similar to overload

doc/performance.adoc doc/modules/ROOT/pages/performance.adocdoc/performance.adoc renamed to doc/modules/ROOT/pages/performance.adoc

@@ -8,7 +8,7 @@ clang compiles the following code:
 
 [source,c++]
 ----
-include::{exampledir}/hello_world.cpp[tag=call_poke_via_ref]
+include::example$hello_world.cpp[tag=call_poke_via_ref]
 ----
 
 ...to this on the x64 architecture (variable names have been shortened for
@@ -48,7 +48,7 @@ Let's look at another example: an AST for an arithmetic calculator:
 
 [source,c++]
 ----
-include::{exampledir}/ast.cpp[tag=ast]
+include::example$ast.cpp[tag=ast]
 ----
 
 The `Negate` overrider compiles to:
@@ -79,7 +79,7 @@ instruction. For example:
 
 [source,c++]
 ----
-include::{exampledir}/ast.cpp[tag=final,indent=0]
+include::example$ast.cpp[tag=final,indent=0]
 ----
 
 ...compiles to: