diff --git a/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.html b/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.html index 7bc81bd19..031bde0ca 100644 --- a/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.html +++ b/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.html @@ -1,351 +1,43 @@ - - - - -Foundry Theming Engine for LibreCCM - Documentation - - - -
- Header -
- -
-
-

Overview

-

- Placeholder -

-
-
-

User Manual

-
-

About Foundry

-

- Placeholder -

-
-
-

Layout templates

-

- Placeholder -

-
-
-

CSS files

-

- Placeholder -

-
-
-

Templates Tags Reference

-

aside

-
-
- Description -
-
- Generates a HTML5 aside element. -
-
See also
-
- -
-
-

body

-
-
- Description -
-
- Generates the HTML body element. -
-
See also
-
-
    -
    -
    -

    div

    -
    -
    - Description -
    -
    - Generates a HTML div element. -
    -
    See also
    -
    -
      -
      -
      -

      divIfNotEmpty

      -
      -
      - Description -
      -
      - Generates a HTML div element, but only if the content is not empty. -
      -
      See also
      -
      -
        -
        -
        -

        footer

        -
        -
        - Description -
        -
        - Creates a HTML5 footer element. -
        -
        See also
        -
        -
          -
          -
          -

          head

          -
          -
          - Description -
          -
          - Creates the HTML head element which may contain meta data and stylesheets - etc. It also generates some meta data like the generator meta information or the - language meta information. -
          -
          See also
          -
          -
            -
            -
            -

            header

            -
            -
            - Description -
            -
            - Generates a HTML5 header element. -
            -
            See also
            -
            -
              -
              -
              -

              main

              -
              -
              - Description -
              -
              - Generates a HTML5 main element. -
              -
              See also
              -
              -
                -
                -
                -

                meta

                -
                -
                - Description -
                -
                - Generates a meta data field in in the head element. -
                -
                See also
                -
                -
                  -
                  -
                  -

                  nav

                  -
                  -
                  - Description -
                  -
                  - Generates a HTML5 nav element. -
                  -
                  See also
                  -
                  -
                    -
                    -
                    -

                    script

                    -
                    -
                    - Attributes -
                    -
                    -
                    -
                    -absolute -
                    -
                    - If set to true the path in the src is used as it is. -
                    -
                    -src -
                    -
                    - The path of the script to include. If the absolute> attribute is not - set (or not set to true the path is interpreted relative to the - theme directory. For example the path of a script included using -
                    -                <script type="text/javascript" src="scripts/example.js"/>
                    -                
                    - in the a theme named my-theme at the server - http://www.example.org is altered to the absolute path - http://www.example.org/themes/published-themedir/itb/scripts/example.js. - If the absolute attribute is set to true the path is not - altered. One usecase for an absolute path is to load an script from a content delivery - network. -
                    -
                    -type -
                    -
                    - The type of the script. Usally this is text/javascript. If the attribute - is not set in the layout template, it is automatically set to - text/javascript. -
                    -
                    -
                    -
                    - Description -
                    -
                    - Used to include a script (usally a JavaScript). The script is either provided - a content of the element or as an external file. Embedded scripts should only be used - for small parts of code, like the code for activating jQuery plugins for some elements. - Everything which is longer than five or six lines should be put into a external file - in the scripts directory of the theme. -
                    -
                    See also
                    -
                    -
                      -
                      -
                      -

                      section

                      -
                      -
                      - Description -
                      -
                      - Generates a HTML5 section element. -
                      -
                      See also
                      -
                      -
                        -
                        -
                        -

                        span

                        -
                        -
                        - Description -
                        -
                        - Generates a span element. -
                        -
                        See also
                        -
                        -
                          -
                          -
                          -

                          title

                          -
                          -
                          - Description -
                          -
                          - Generates the title in the HTML head. -
                          -
                          See also
                          -
                          -
                            -
                            -
                            -
                            -
                            -
                            -

                            Developer Manual

                            -
                            -

                            The overall structure of foundry

                            -

                            - Placeholder -

                            -
                            -
                            -

                            Foundry Coding Style

                            -

                            - This document describes the coding conventions for the Foundry theming engine. -

                            -

                            Naming

                            -

                            - The naming rules described here apply to all names: Names of layout elements, - XSL template names, EXSLT functions, files, ids and classes (in the - class attribute). -

                            -

                            - Use the dash "-" to separate parts of a name instead of camel case or the - underscore. For example: get-setting instead of getSetting or - set_setting. -

                            -

                            - Names should be lowercase. -

                            -

                            Namespace declarations

                            -

                            - In the XSL files, XML namespaces are only defined at the - <xsl:stylesheet> element. The XSL namespace is the first one is - declared first. The other namespace follow in alphabetic order (ordered by their - prefix). -

                            -

                            Indention, line length and formating

                            -

                            - Indention is done using spaces. Indention depth is four (4) spaces per level. -

                            -

                            - Try to keep the line length below 100 characters per line. Because of some restrictions - of XML this will be possible in every case. -

                            -

                            - Insert a line break after each attribute of an XML element. The first attribute - is on the same line as the element. For example write -

                            -
                            -<xsl:param name=example-param"
                            -           select="'example'"/>
                            -        
                            -

                            - instead of -

                            -
                            -<xsl:param name=example-param" select="'example'"/>
                            -        
                            -
                            -
                            -

                            The documentation system of Foundry

                            -

                            - Placeholder -

                            -
                            -
                            -
                            - - - + + + + + + Foundry Documentation + + + + + + Skip navigation +
                            +

                            + Foundry Documentation + +

                            +
                            + + \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.xml b/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.xml index 4776504b0..262957fb9 100644 --- a/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.xml +++ b/ccm-sci-bundle/web/themes/foundry/doc/foundry-documentation.xml @@ -2,24 +2,42 @@ - - + + - - - - + + + + - - - - + + + + \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib.xsl index ad388296a..1fbad161e 100644 --- a/ccm-sci-bundle/web/themes/foundry/foundry/lib.xsl +++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib.xsl @@ -20,7 +20,8 @@ --> + exclude-result-prefixes="xsl" + version="2.0"> diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/global-vars.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/global-vars.xsl index d432e8e93..c7ed6158a 100644 --- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/global-vars.xsl +++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/global-vars.xsl @@ -31,6 +31,7 @@ processor, some are read from the configuration files of Foundry and some are de xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" + exclude-result-prefixes="xsl bebop foundry ui" version="2.0"> @@ -85,6 +86,13 @@ processor, some are read from the configuration files of Foundry and some are de + + + This variables stores the XML definition of the Foundry documentation. + + + + @@ -111,11 +119,11 @@ processor, some are read from the configuration files of Foundry and some are de The language to use as negotiated by CCM. - + - + + diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl index 5b9b45655..7696c0bc8 100644 --- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl +++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/data-tags.xsl @@ -21,6 +21,7 @@ + + ]> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl index a735e7a62..b7104dd92 100644 --- a/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl +++ b/ccm-sci-bundle/web/themes/foundry/foundry/lib/template-tags/html-tags.xsl @@ -24,6 +24,7 @@ xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" + xmlns="http://www.w3.org/1999/xhtml" exclude-result-prefixes="xsl bebop foundry ui" version="2.0"> @@ -264,7 +265,7 @@ - + - + - + @@ -558,36 +587,50 @@ XSLT 2.0 functions. - + - + - + - + - + - + - + - + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/main.xsl b/ccm-sci-bundle/web/themes/foundry/foundry/main.xsl index 5a384f36d..d905e6821 100644 --- a/ccm-sci-bundle/web/themes/foundry/foundry/main.xsl +++ b/ccm-sci-bundle/web/themes/foundry/foundry/main.xsl @@ -24,7 +24,8 @@ + exclude-result-prefixes="xsl foundry bebop" + version="2.0"> @@ -82,7 +83,7 @@ - + + + \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-doc-chapter.xml b/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-doc-chapter.xml new file mode 100644 index 000000000..d5996919a --- /dev/null +++ b/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-doc-chapter.xml @@ -0,0 +1,10 @@ + + +
                            +

                            + +

                            + + +
                            +
                            \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-doc-section.xml b/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-doc-section.xml new file mode 100644 index 000000000..01dc3648a --- /dev/null +++ b/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-doc-section.xml @@ -0,0 +1,12 @@ + + + +
                            +

                            + +

                            + + +
                            + +
                            \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-documentation.xml b/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-documentation.xml new file mode 100644 index 000000000..a3ca7e463 --- /dev/null +++ b/ccm-sci-bundle/web/themes/foundry/foundry/templates/doc/foundry-documentation.xml @@ -0,0 +1,41 @@ + + + + + Foundry Documentation + + + + + +
                            +

                            + Foundry Documentation +

                            + +
                            + +
                            \ No newline at end of file diff --git a/ccm-sci-bundle/web/themes/foundry/start.xsl b/ccm-sci-bundle/web/themes/foundry/start.xsl index 9a84118d1..727a5eff2 100644 --- a/ccm-sci-bundle/web/themes/foundry/start.xsl +++ b/ccm-sci-bundle/web/themes/foundry/start.xsl @@ -30,7 +30,7 @@ + version="2.0"> diff --git a/ccm-sci-bundle/web/themes/foundry/templates/default-layout.xml b/ccm-sci-bundle/web/themes/foundry/templates/default-layout.xml index a0e111af3..0142d07a8 100644 --- a/ccm-sci-bundle/web/themes/foundry/templates/default-layout.xml +++ b/ccm-sci-bundle/web/themes/foundry/templates/default-layout.xml @@ -14,6 +14,7 @@ +

                            layout/page/head/title