Implemented issue #148: Website with basic user guide.

2025-06-14 23:44:58 +02:00 · 2015-10-28 10:10:36 +01:00
parent 3dc0142244
commit 57a06ba3b1
39 changed files with 4815 additions and 2923 deletions
--- a/doc/lib/BackRestDoc/Html/DocHtmlElement.pm
+++ b/doc/lib/BackRestDoc/Html/DocHtmlElement.pm
@ -0,0 +1,152 @@
+####################################################################################################################################
+# DOC HTML ELEMENT MODULE
+####################################################################################################################################
+package BackRestDoc::Html::DocHtmlElement;
+
+use strict;
+use warnings FATAL => qw(all);
+use Carp qw(confess);
+
+use Exporter qw(import);
+    our @EXPORT = qw();
+use File::Basename qw(dirname);
+use File::Copy;
+use Scalar::Util qw(blessed);
+
+use lib dirname($0) . '/../lib';
+use BackRest::Common::Log;
+
+####################################################################################################################################
+# Operation constants
+####################################################################################################################################
+use constant OP_DOC_HTML_ELEMENT                                    => 'DocHtmlElement';
+
+use constant OP_DOC_HTML_ELEMENT_ADD                                => OP_DOC_HTML_ELEMENT . '->add';
+use constant OP_DOC_HTML_ELEMENT_ADD_NEW                            => OP_DOC_HTML_ELEMENT . '->addNew';
+use constant OP_DOC_HTML_ELEMENT_NEW                                => OP_DOC_HTML_ELEMENT . '->new';
+
+####################################################################################################################################
+# Html Element Types
+####################################################################################################################################
+use constant HTML_A                                                 => 'a';
+    push @EXPORT, qw(HTML_A);
+use constant HTML_BODY                                              => 'body';
+    push @EXPORT, qw(HTML_BODY);
+use constant HTML_DIV                                               => 'div';
+    push @EXPORT, qw(HTML_DIV);
+use constant HTML_SPAN                                              => 'span';
+    push @EXPORT, qw(HTML_SPAN);
+
+####################################################################################################################################
+# CONSTRUCTOR
+####################################################################################################################################
+sub new
+{
+    my $class = shift;       # Class name
+
+    # Create the class hash
+    my $self = {};
+    bless $self, $class;
+
+    $self->{strClass} = $class;
+
+    # Assign function parameters, defaults, and log debug info
+    (
+        my $strOperation,
+        $self->{strType},
+        $self->{strClass},
+        my $oParam
+    ) =
+        logDebugParam
+        (
+            OP_DOC_HTML_ELEMENT_NEW, \@_,
+            {name => 'strType', trace => true},
+            {name => 'strClass', required => false, trace => true},
+            {name => 'oParam', required => false, trace => true}
+        );
+
+    $self->{oyElement} = [];
+    $self->{strContent} = $$oParam{strContent};
+    $self->{strId} = $$oParam{strId};
+    $self->{strRef} = $$oParam{strRef};
+
+    # Return from function and log return values if any
+    return logDebugReturn
+    (
+        $strOperation,
+        {name => 'self', value => $self}
+    );
+}
+
+####################################################################################################################################
+# addNew
+#
+# Create a new element and add it.
+####################################################################################################################################
+sub addNew
+{
+    my $self = shift;
+
+    # Assign function parameters, defaults, and log debug info
+    my (
+        $strOperation,
+        $strType,
+        $strClass,
+        $oParam
+    ) =
+        logDebugParam
+        (
+            OP_DOC_HTML_ELEMENT_ADD_NEW, \@_,
+            {name => 'strType', trace => true},
+            {name => 'strClass', required => false, trace => true},
+            {name => 'oParam', required => false, trace => true}
+        );
+
+    my $oElement = new BackRestDoc::Html::DocHtmlElement($strType, $strClass, $oParam);
+
+    $self->add($oElement);
+
+    # Return from function and log return values if any
+    return logDebugReturn
+    (
+        $strOperation,
+        {name => 'oElement', value => $oElement, trace => true}
+    );
+}
+
+####################################################################################################################################
+# add
+#
+# Add an element.
+####################################################################################################################################
+sub add
+{
+    my $self = shift;
+
+    # Assign function parameters, defaults, and log debug info
+    my (
+        $strOperation,
+        $oElement
+    ) =
+        logDebugParam
+        (
+            OP_DOC_HTML_ELEMENT_ADD, \@_,
+            {name => 'oElement', trace => true}
+        );
+
+    if (!(blessed($oElement) && $oElement->isa('BackRestDoc::Html::DocHtmlElement')))
+    {
+        confess &log(ASSERT, 'oElement must be a valid element object');
+    }
+
+    push(@{$self->{oyElement}}, $oElement);
+
+    # Return from function and log return values if any
+    return logDebugReturn
+    (
+        $strOperation,
+        {name => 'oElement', value => $oElement, trace => true}
+    );
+}
+
+1;