Documenting

You can add your own documentation file (contains CodKep's special markup language) under the doc/SECTION location with the HOOK_documentation hook:

// Makes mymodule.mdoc available under "doc/mysection"
//  with image path '/site/mymoduledoc/images'
function hook_mymodule_documentation($section)
{
    $docs = [];
    if($section == "mysection")
    {
        $docs[] = [
                'doc' => ['path' => 'site/mymodule.mdoc',
                          'index' => false,
                          'imagepath' => '/site/mymoduledoc/images'
                         ]
                  ];
    }
    return $docs;
}

My mark language

Highlights

In raw textLooks like in the document

the *sample* text

the sample text

the _sample_ text

the sample text

the **sample** text

the sample text

the __sample__ text

the sample text

the ***sample*** text

the sample text

the ___sample___ text

the sample text

the @@@sample@@@ text

the sample text
In raw textLooks like in the document

This is a _sample_ text __with__
some ___special___ marks.

This is an *another* way of **highlight** the ***special*** words.

You can also @@@use this@@@ or *****even this***** combined ****version****

This is a sample text with some special marks.

This is an another way of highlight the special words.

You can also use this or even this combined version

Headings

In raw textLooks like in the document Table of contents

= One heading =

One heading

Added

== Two heading ==

Two heading

Added

=== Three heading ===

Three heading

Added

==== Four heading ====

Four heading

No

Other elements

Horizontal line:

In raw textLooks like in the document

---


Line feed:
In raw textHtml code

 .

<br/>

Tables

In raw textLooks like in the document

| One   | Two   | Three |
| ---   | ---   | ---   |
| Red   | Green | Blue  |
| Apple | Pear  | Plum  |

OneTwoThree
RedGreenBlue
ApplePearPlum

Lists

In raw textLooks like in the document

 - One
 - Two
  - Two-Sub 1
  - Two-Sub 2
 - Three

  • One
  • Two
    • Two-Sub 1
    • Two-Sub 2
  • Three

In raw textLooks like in the document

# One
# Two
 # Two Sub 1
 # Two Sub 2
  - Low 1
  - Low 2
# Three

  1. One
  2. Two
    1. Two Sub 1
    2. Two Sub 2
      • Low 1
      • Low 2
  3. Three

In raw textLooks like in the document

- One
- Two
 - Two Sub 1
 - Two Sub 2 which
 \ is longer and
 \ wrapped to more line
 - Two Sub 3
- Three

  • One
  • Two
    • Two Sub 1
    • Two Sub 2 which is longer and wrapped to more line
    • Two Sub 3
  • Three

Codes

In raw textLooks like in the document

 ~~~code
  This is a source code
 ~~~

This is a source code

In raw textLooks like in the document

 ~~~php
  function this_is_a_php_code($var)
  {
    //do something
  }
 ~~~

function this_is_a_php_code($var)
{
  //do something
}

Links

In raw textLooks like in the document

The [sample|url:#somwhere] link

The sample link

Another [site|url:http://www.kernel.org] link

Another site link

Another [site|url:start|css:background-color:#ff4444;] link

Another style="background-color:#ff4444; ">site link

Another [site|url:start|title:Title text] link

Another site link

Images

In raw textLooks like in the document

An image {file:cklogo_big.png} here

An image cklogo_big.png here

{file:cklogo_big.png|width:50|title:Smaller codkep logo}

cklogo_big.png

{file:cklogo_big.png|height:80|alt:Some text}

Some text

{file:cklogo_big.png|height:80|css:opacity: 0.5;}

cklogo_big.png

Page generated in 0.0138 seconds.