Extension:ComplexList

From MediaWiki.org
Jump to: navigation, search


MediaWiki extensions manual - list
Crystal Clear action run.png
ComplexList

Release status: experimental
Implementation Tag
Description Remove the need to use HTML in order to create complex lists
Last version 0.019
License No license specified
Download No link

Check usage (experimental)

Contents

[edit] What can this extension do?

This extension allows you to create complex lists more easily than does the existing MediaWiki syntax that I'm currently aware of from m:Help:List

This copies the technique of other wikis, for example, MoinMoin http://moinmo.in/HelpOnMoinWikiSyntax#Lists

Disclaimer: this is my first extension, so probably fraught with error and weaknesses. Help welcome. Also, I have no idea how this would work in conjunction with the textarea toolbar - I never use it. (And this page alone—my effort to fill out the template—probably has a few issues. Sorry.)

[edit] Usage

Some examples.

NOTICE: after a * there must be a space.

[edit] Example A

Unordered lists

Using syntax described at m:Help:List

* Lists are easy to do:
** start every line
* with a star
** more stars mean
*** deeper levels

results in

  • Lists are easy to do:
    • start every line
  • with a star
    • more stars mean
      • deeper levels

Using the cl tag

<cl>
* Lists are easy to do:
 * start every line
* with a star
 * or an indented star
  * more indents mean deeper levels
</cl>

results (or should result) in

  • Lists are easy to do:

    • start every line

  • with a star

    • or an indented star

      • more indents mean deeper levels

[edit] Example B

Ordered lists of different list-style-type

Using syntax described at m:Help:List

We must resort to HTML

<ol style="list-style-type:lower-latin">
  <li>About the author</li>
  <li>Foreword to the first edition</li>
    <ol style="list-style-type:lower-roman">
      <li>About the author</li>
      <li>Foreword to the first edition</li>
      <li>Foreword to the second edition</li>
    </ol>
  <li>Foreword to the second edition</li>
</ol>

results in

  1. About the author
  2. Foreword to the first edition
    1. About the co-author
    2. Foreword to the first sub-edition
    3. Foreword to the second sub-edition
  3. Foreword to the second edition

Using the cl tag

<cl>
a. About the author
* Foreword to the first edition
 i. About the co-author
 * Foreword to the first sub-edition
 * Foreword to the second sub-edition
* Foreword to the second edition
</cl>

results (or should result) in

  1. About the author

  2. Foreword to the first edition

    1. About the co-author

    2. Foreword to the first sub-edition

    3. Foreword to the second sub-edition

  3. Foreword to the second edition

[edit] Example C

Much-text list-items separated by blank lines to make them easy to read (and edit) in the editing view

Using syntax described at m:Help:List

# Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed 
do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut 
enim ad minim veniam, quis nostrud exercitation ullamco laboris 
nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in 
reprehenderit in voluptate velit esse cillum dolore eu fugiat 
nulla pariatur. Excepteur sint occaecat cupidatat non proident, 
sunt in culpa qui officia deserunt mollit anim id est laboru

# Sed ut perspiciatis unde omnis iste natus error sit voluptatem 
accusantium doloremque laudantium, totam rem aperiam, eaque ipsa 
quae ab illo inventore veritatis et quasi architecto beatae vitae 
dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit 
aspernatur aut odit aut fugit, sed quia consequuntur magni dolores 
eos qui ratione voluptatem sequi nesciunt.

# Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, 
consectetur, adipisci velit, sed quia non numquam eius modi tempora 
incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut 
enim ad minima veniam, quis nostrum exercitationem ullam corporis 
suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur?

results in

  1. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laboru
  1. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.
  1. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur?

Using the cl tag

<cl>
1. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed 
do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut 
enim ad minim veniam, quis nostrud exercitation ullamco laboris 
nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in 
reprehenderit in voluptate velit esse cillum dolore eu fugiat 
nulla pariatur. Excepteur sint occaecat cupidatat non proident, 
sunt in culpa qui officia deserunt mollit anim id est laboru

* Sed ut perspiciatis unde omnis iste natus error sit voluptatem 
accusantium doloremque laudantium, totam rem aperiam, eaque ipsa 
quae ab illo inventore veritatis et quasi architecto beatae vitae 
dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit 
aspernatur aut odit aut fugit, sed quia consequuntur magni dolores 
eos qui ratione voluptatem sequi nesciunt.

* Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, 
consectetur, adipisci velit, sed quia non numquam eius modi tempora 
incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut 
enim ad minima veniam, quis nostrum exercitationem ullam corporis 
suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur?
</cl>

results (or should result) in

  1. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laboru

  2. Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.

  3. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur?

[edit] Example D

To put multiple paragraphs into a single list item:

Using syntax described at m:Help:List

#list item A1
#list item A2
#:continuing list item A2
#:further continuing list item A2
#list item A3

results in

  1. list item A1
  2. list item A2
    continuing list item A2
    further continuing list item A2
  3. list item A3

Using the cl tag

<cl>
1. list item A1

* list item A2

continuing list item A2

further continuing list item A2

* list item A3
</cl>

results (or should result) in

  1. list item A1

  2. list item A2

    continuing list item A2

    further continuing list item A2

  3. list item A3


[edit] Example E

To include a single-line pre block in a list item

Using syntax described at m:Help:List

#list item A1
#<pre>list item A2</pre>
#list item A3

results in

  1. list item A1
  2. list item A2
  3. list item A3

Using the cl tag

<cl>
1. list item A1
* <pre>list item A2</pre>
* list item A3
</cl>

results (or should result) in

  1. list item A1

  2. list item A2

  3. list item A3

[edit] Example F

To include a multi-line pre block in a list item

Using syntax described at m:Help:List

# list item A1
# <pre>list item A2
is 

some

pre text</pre>
# list item A3

results in

  1. list item A1
  2. list item A2

is some pre text

  1. list item A3

So we have to resort to HTML

<ol>
    <li>list item A1</li>
    <li><pre>list item A2
is 

some

pre text</pre></li>
    <li>list item A3</li>
</ol>

to get

  1. list item A1
  2. list item A2
is 

some

pre text
  3. list item A3

Using the cl tag

<cl>
1. list item A1
* <pre>list item A2
is 

some

pre text</pre>
* list item A3
</cl>

results (or should result) in

  1. list item A1

  2. list item A2
is 

some

pre text

  3. list item A3

[edit] Example G

To include a WikiText table in a list

Using syntax described at m:Help:List, I don't think we can do this

#list item A1
#{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
#list item A3

results in

  1. list item A1
  2. {|

|Orange |Apple |- |Bread |Pie |- |Butter |Ice cream |}

  1. list item A3

Use the cl tag

<cl>
1. list item A1
* {|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
* list item A3
</cl>

results in

  1. list item A1

  2. Orange Apple
    Bread Pie
    Butter Ice cream

  3. list item A3

[edit] Download instructions

Please cut and paste the code found below and place it in $IP/extensions/cl/cl.php. Note: $IP stands for the root directory of your MediaWiki installation, the same directory that holds LocalSettings.php.

[edit] Installation

To install this extension, add the following to LocalSettings.php:

require_once("$IP/extensions/cl/cl.php");

[edit] Configuration parameters

None.

[edit] User rights

Not applicable

[edit] Code

of the extensions/cl/cl.php file:

<?php
/**
* 2010.11.02.
* 
* The purpose of the cl tag is to provide an easier syntax than HTML for
* creating lists with such things as: multiple paragraphs per list item;
* list items containing pre blocks; list items containing tables; list items
* containing tables containing lists; and so on.
*/
 
/**
* Add the hook function call to an array defined earlier in the wiki code 
* execution.
*/
$wgExtensionFunctions[] = "efCl";
 
/**
* Add extension credits to the Special:Version
*/
$wgExtensionCredits['parserhook'][] = array(
        'path' => __FILE__,
        'name' => 'ComplexList',
        'author' => 'Emufarmers',
        'description' => 'Adds <nowiki><cl></nowiki> tags for complex lists',
        'descriptionmsg' => 'Adds <nowiki><cl></nowiki> tags for complex lists',
        'url' => 'http://www.mediawiki.org/wiki/Extension:ComplexList'
);
 
/**
* This is the hook function. It adds the "cl" tag to the wiki parser and 
* tells it which callback function (namely, "efClRender") to use for the 
* tag.
*/
function efCl() {
    global $wgParser;
    # register the extension with the WikiText parser
    $wgParser->setHook( "cl", "efClRender" );
}
 
/**
* The callback function.
*
*/
function efClRender( $input, $attribs ) {
 
    global $wgParser;
 
    // copied this line from another extension
    // seems to be necessary.
    $content = StringUtils::delimiterReplace( '<nowiki>', '</nowiki>', '$1', $input, 'i' );
 
    $attribs = Sanitizer::validateTagAttributes( $attribs, 'pre' );
 
    // Set some flags with initial values;
    $indent_count = 0;
    $indent_count_preceding = 0;
    $prefix = '';
    $new_content = '';
    $name_of_the_first_opening_tag = '';
    $count_of_instances_of_elements_matching_first_opening_tag = 0;
    $skip_this_line = 0;  // ie, false
    $skip_next_line = 0;  // ie, false
 
    // A trip-wire to get the WikiText parser to put each new line into an 
    // HTML p element.  ...which seems to work only if the line does not 
    // contain an HTML block-level opening tag (eg <blockquote> or <pre>).
    $paragraph_trip_wire = '<p style="display:none;"></p>';
 
    // Create an array of the lines of text between the <cl> opening tag and the </cl> closing tag.
    $cl_lines = explode("\n", $content);
 
    // Define a list of (HTML) elements an opening tag of which in one line 
    // should prevent subsequent lines from being prefixed with list tags 
    // (<ol>, <ul>, <li>) until a line is reached with a corresponding closing 
    // tag.
 
    // Still have to add this to the regex: <!-- ... -->
 
    // Because we want to be able to allow (ie, not interpret) any old 
    // string between angle brackets, <like this>, we should instead 
    // match only the mediawiki-allowed HTML tags, and match them only
    // if we are not in a nowiki element - as is the behaviour of mediawiki.
 
    // Should it be all mediawiki-acceptable HTML elements . . . 
    /*
    $array_of_tags_to_match = array(
            'abbr',         'h1',           's',
            'b',            'h2',           'small',
            'big',          'h3',           'span',
            'blockquote',   'h4',           'strike',
            'br',           'h5',           'strong',
            'caption',      'h6',           'sub',
            'center',       'hr',           'sup',
            'cite',         'i',            'table',
            'code',         'ins',          'td',
            'dd',           'li',           'th',
            'del',          'ol',           'tr',
            'div',          'p',            'tt',
            'dl',           'pre',          'u',
            'dt',           'rb',           'ul',
            'em',           'rp',           'var',
            'font',         'rt',           'ruby'      
            );
    */
    // . . . or just pre?
    $array_of_tags_to_match = array('pre');
    $array_of_all_tags_to_match = array_merge($array_of_tags_to_match, $wgParser->getTags());
 
    // Tried other ways (eg, unset() and 
    // $my_new_array = array_diff_assoc($my_array,array(”key1″=> $my_array["key1"]));
    // ) to get rid of "cl" tag introduced by $wgParser->getTags() but had 
    // no success until I tried this:
    foreach($array_of_all_tags_to_match as $this_tag) {
        if($this_tag != 'cl') $tag_list_without_cl[] = $this_tag;
    }
    $tag_list_without_duplicates = array_unique($tag_list_without_cl); // Just in case there are duplicates.
    $tags_to_match = implode("|", $tag_list_without_duplicates);
 
    foreach($cl_lines as $cl_line) {
 
        // Skip blank lines.
        if(strlen(trim($cl_line)) == 0) {
            $new_content .= $prefix . trim($cl_line) . "\n";
            continue; 
        }
 
        // Assign the value of the skip_next_line flag, set in the preceding
        // iteration of this foreach loop, this the skip_this_line flag.
        $skip_this_line = $skip_next_line;
 
        // Count the number of spaces by which this line is indented (indicating
        // to which one of possibly many nested lists it belongs.
        $cl_line_split = preg_split('/^[ ]+/', $cl_line, -1, PREG_SPLIT_OFFSET_CAPTURE);
        // $cl_line_split is an array of two-element arrays: split out chunk of 
        // text is element [0], position of chunk is element [1].  This position 
        // of the second chunk (the text after the spaces indent) is number of 
        // spaces and, therefore, the number that we will call the indent_count.
        $indent_count = $cl_line_split[count($cl_line_split)-1][1];
 
        // Trim the indent from the line of content.
        $new_line = $cl_line_split[count($cl_line_split)-1][0];
 
        // Find out if this line opens an HTML element and doesn't close it.  
        // In which case, add any necessary prefix to this line, but skip (the 
        // prefix-determining and prefix-adding process for) every following
        // this line until the first line after the line in which the element is 
        // closed by a corresponding closing tag.
        if($name_of_the_first_opening_tag == '') {
            $blah = preg_match('/<('.$tags_to_match.')( +|>)/i', $new_line, $matches_first, PREG_OFFSET_CAPTURE); 
            $name_of_the_first_opening_tag = $matches_first[1][0];
        }
 
        // Add one to the count of the tag-name for each matching opening 
        // tag-found.
        // Why? Because if we have, for example, an X within an X, we then 
        // will want to know that there are two Xs, not just one, that 
        // need to be closed.
        $unneeded_value_01 = preg_match_all('/<('.$name_of_the_first_opening_tag.')[ *|>]/i', $new_line, $matches_of_opening_tag, PREG_OFFSET_CAPTURE);
        $count_of_instances_of_elements_matching_first_opening_tag += count($matches_of_opening_tag[1]);  // 1 is for match in the *1st* pair of brackets
 
        // Subtract one from the count of the tag-name for each matching 
        // closing tag found.
        $unneeded_value_02 = preg_match_all('/<\/('.$name_of_the_first_opening_tag.')>/i', $new_line, $matches_of_closing_tag, PREG_OFFSET_CAPTURE);
        $count_of_instances_of_elements_matching_first_opening_tag -= count($matches_of_closing_tag[1]);  // 1 is for match in the *1st* pair of brackets
 
        // If this line leaves us within an element (because there was one or 
        // more opening tag(s) with no accompanying closing tag(s)), then
        // we'll add a prefix to this line, but not the next (in order to not 
        // start adding opening and closing list tags in the middle of the 
        // still-unclosed user-entered element).
        if($count_of_instances_of_elements_matching_first_opening_tag > 0) {
            // Raise skip-next-line flag.
            $skip_next_line = 1;  // true
        }
        else {
            $skip_next_line = 0;  // false
            $name_of_the_first_opening_tag = '';
        }
 
        if($skip_this_line == 1) {
            // Leave this line as-is because we have found that it is in the 
            // middle of a still-unclosed user-entered element.
            $new_line = $cl_line;  
        }
        else {
            // Determine and add a prefix for this line . . .
 
            // If indent count of this line is greater than that of the previous
            // line, and if the first non-white-space character is one of the 
            // recognised new-line-item character-sets ("*", "1.", "a.", 
            // "A.", "i.", "I."), then we start a new list.
            if($indent_count > $indent_count_preceding || count($list_stack) == 0) {
                if(
                        substr($new_line, 0, 2) == '* '  ||
                        substr($new_line, 0, 3) == '1. ' ||
                        substr($new_line, 0, 3) == 'a. ' ||
                        substr($new_line, 0, 3) == 'A. ' ||
                        substr($new_line, 0, 3) == 'i. ' ||
                        substr($new_line, 0, 3) == 'I. '
                        ) {
                    if(substr($new_line, 0, 2) == '* ') {
                        $list_name = 'ul';
                        $list_item_token_length = 2;
                        $list_style = '';
                    }
                    elseif(
                            substr($new_line, 0, 3) == '1. ' ||
                            substr($new_line, 0, 3) == 'a. ' ||
                            substr($new_line, 0, 3) == 'A. ' ||
                            substr($new_line, 0, 3) == 'i. ' ||
                            substr($new_line, 0, 3) == 'I. '
                            ) {
                        $list_name = 'ol';
                        $list_item_token_length = 3;
                        if(substr($new_line, 0, 3) == '1. ') $list_style = ' style="list-style-type: decimal;"';
                        if(substr($new_line, 0, 3) == 'a. ') $list_style = ' style="list-style-type: lower-latin;"';
                        if(substr($new_line, 0, 3) == 'A. ') $list_style = ' style="list-style-type: upper-latin;"';
                        if(substr($new_line, 0, 3) == 'i. ') $list_style = ' style="list-style-type: lower-roman;"';
                        if(substr($new_line, 0, 3) == 'I. ') $list_style = ' style="list-style-type: upper-roman;"';
                    }
                    $list_stack[] = array($list_name, $indent_count); // Add this new list to the stack of lists
                    $new_line = substr($new_line, $list_item_token_length);  // Trim the new-list-item token from the line of content.
                    $prefix = '<'.$list_name.$list_style.'><li>'.$paragraph_trip_wire."\n";
                    $indent_count_preceding = $indent_count;
                }
                else {
                    // If this line is indented, but not prefixed with a
                    // list-item token, put the additional indent back and move on.
                    $new_line = substr($cl_line, $indent_count_preceding);
                }
            }
            elseif($indent_count == $indent_count_preceding && substr($new_line, 0, 2) == '* ' && count($list_stack) > 0) {
                $new_line = substr($new_line, 2);  // Trim the new-line-item token from the line of content.
                $prefix .= '</li><li>'.$paragraph_trip_wire."\n";
                $indent_count_preceding = $indent_count;
            }
            elseif($indent_count < $indent_count_preceding && count($list_stack) > 0) {
 
                // If the indent of this line less than the indent of this 
                // (nested) list, close the list.  Repeat for all lists until 
                // we find a list whose indent matches this line's indent.
                $list_at_the_top_of_the_stack = end($list_stack);
                $indent_of_list_at_the_top_of_stack = $list_at_the_top_of_the_stack[1];
                while($indent_count < $indent_of_list_at_the_top_of_stack) {
                    $list_popped_off_the_top_of_the_stack = array_pop($list_stack);
                    $list_at_the_top_of_the_stack = end($list_stack);
                    $indent_of_list_at_the_top_of_stack = $list_at_the_top_of_the_stack[1]; // Re-set for next while test
                    $prefix .= '</li></'.$list_popped_off_the_top_of_the_stack[0].'>';
                }
 
                if(substr($new_line, 0, 2) == '* ' && count($list_stack) > 0) {
                    $new_line = substr($new_line, 2);
                    $prefix .= '</li><li>'.$paragraph_trip_wire."\n";
                }
                $indent_count_preceding = $indent_count;
            }
 
        } // End of: don't skip this line.
 
        $new_content .= $prefix . $new_line . "\n";
        $prefix = '';
    }// End of: foreach line.
 
    // Close any unclosed lists.
    while(count($list_stack) > 0) {
        $list_popped_off_the_top_of_the_stack = array_pop($list_stack);
        $list_name = $list_popped_off_the_top_of_the_stack[0];
        $new_content .= '</li></'.$list_name.'>';
    }
 
    // Pass the contents to the parser to parse the wikitext etc as per usual.    
    return $wgParser->internalParse($new_content);
 
}

[edit] See also

Retrieved from "http://www.mediawiki.org/w/index.php?title=Extension:ComplexList&oldid=475006"
Personal tools
Namespaces

Variants
Actions
Navigation
Support
Download
Development
Communication
Print/export
Toolbox