Try the Demo

Magento

eCommerce Software for Online Growth

Formatting Syntax

Last modified by apollosan on Tue, January 31, 2012 12:53
Source|Old Revisions  

DokuWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the Edit this page button at the top of the page. If you want to try something, just use the **Welcome to the Playground, here we play** page. The simpler markup is easily accessible via Quickbuttons, too.

Basic text formatting

DokuWiki supports bold, italic, underlined and- monospaced texts. Of course you can combine all these.

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use subscript and superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as deleted as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks Note that the two backslashes are only recognized at the end of a line or followed by a whitespace this happens without it.

This is some text with some linebreaks Note that the
two backslashes are only recognized at the end of a line
or followed by a whitespace this happens without it.

You should use forced newlines only if really needed.

Links

DokuWiki supports multiple ways of creating links.

External

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: This Link points to google. Email addresses like this one: andi@splitbrain.org are recognized, too.

DokuWiki supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
Linknames, too: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <andi@splitbrain.org> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a pagename or use an additional Title Text. Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames
are converted to lowercase automatically, special chars are not allowed.

You can use Namespaces by using a colon in the pagename.

You can use [[wiki:namespaces]] by using a colon in the pagename.

For details about namespaces see Namespaces.

Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.

This links to [[syntax#internal|this Section]].

Notes:

  • Links to existing pages are shown in a different style from nonexisting ones.
  • DokuWiki does not use CamelCase to automatically create links by default, but this behaviour can be enabled in the wiki:config file. Hint: If DokuWiki is a link, then it’s enabled.
  • When a section’s heading is changed, its bookmark changes, too. So don’t rely on section linking too much.

Interwiki

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia’s page about Wikis: Wiki.

DokuWiki supports [[doku>wiki:interwiki|Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogenous user group like a corporate Intranet.

Windows Shares like [[servershare|this]] are recognized, too.

Notes:

  • For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
  • For Mozilla and Firefox it can be enabled through the config option security.checkloaduri but this is not recommended.
  • See 151 for more info.

Image Links

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes 1) by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

Headline Level 3

Headline Level 4

Headline Level 5
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

Images and other files

You can include external and internal images with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height:

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

This is the caption

{{ wiki:dokuwiki-128.png |This is the caption}}

If you specify a filename (external or internal) that is not an image (gif, jpeg, png), then it will be displayed as a link instead.

For linking an image to another page see Image Links above.

How to make YouTube videos play on product list view

Hey everyone,

Firstly, I want to say Magento is an amazing shopping cart. Props to them, this is the first piece of E-commerce software i’ve ever used that pushes MY limits as a business owner. This modification I decided to publish because there wasn’t anything like it. When I took on the task, it didn’t seem like TOO hard of a challenge (but then again I’m not too hot with PHP).

WHAT THIS MOD DOES

This mod was disigned to open videos in a shadowbox from the product list page, while allowing you to simply paste a URL into an add-products field. This means that customers are staying on one page, saving extra bandwidth, and creating a nice video player for your customers to review before induldging into the full product view. This can be modified in any way/shape/form as you wish, I request that you only include my name in the source code.

This tutorial will be as simple as I can make it. If I leave out details, please contact me so we can get them correccted (I just finished this script and was excited to share with everyone).

NOTE & DISCLAIMER

Please backup all your items before you begin this. I can’t stress this more! Don’t learn the hard way. THIS PRODUCT IS NOT SUPPORTED, I AM NOT A DEVELOPER .


Requirements

  • Magento ver. 1.3.2.4 (that is what I designed this tutorial from) - I cannot guarentee this will work on any other versions, sorry.
  • Moderate knowledge of Magento Software
  • Shadowbox.js (you can pick your opensource copy up at: http://www.shadowbox-js.com/ or use the API like in the below example)

Files

  • root/app/design/frontend/default/default/template/catalog/product/list.phtml
  • www/app/design/frontend/default/helloclean/template/page/html/head.phtml

Features

  • Add videos through the administrator panel
  • Paste link directly into plain-text-field and it will do the rest
  • Clean nice addition to any website
  • Must be used in “LIST” view only, not GRID.

—-

  1. Go to your Magento Administrator panel and manage your attributes (Catalog>Attributes>Manage Attributes)
  2. Add new attribute
  3. Set your attributes as they are in Figure[1] (click to enlarge).

2rq0bq9.jpg

  1. Click on “Manage Label / Options” on the left menu.
  2. Enter whatever settings you would like for “Admin” & “Default Store View”. Figure[2] below is what I have setup.

  1. Save Attribute
  2. Navigate to “Catalog>Attribute>Manage Attribute Sets”
  3. Click on “Default”. If you have a different one, please select your desired item.
  4. Drag “video_shadowbox_youtube” item in “Unassigned Attributes” to the “Groups” tree. Place “video_shadowbox_youtube” under General (Figure[3]). You can position it now which order you would like it to display in the administrator panel when adding products.

  1. Navigate to “Catalog>Manage Products”.
  2. For this example, we will be editing a product. So just select one of your items in your store that you would like to add a video to.
  3. Under the “General” part of the product, if you scroll down it should be displayed as “Youtube Video” similar to Figure[4].
  4. The portion of the YouTube URL is very important, we will only need a portion of the URL. A standard YouTube URL looks like “http://www.youtube.com/watch?v=TWaVbGGE6Yw“. What we need is the last bit after the “V=”. With that being noted, we can deduct that “TWaVbGGE6Yw” is the code.
  5. Take that code, and paste it into the “Youtube Video” field in the administrator panel.
  6. Move forward to the template edits :) - Assuming we haven’t ran into any issues.

Please review the source-code before we get into how to make any changes.

Template Edits: 1.) Open your “/www/app/design/frontend/default/helloclean/template/page/html/head.phtml” and add the below code under your <link rel”” /> tags. If you downloaded the Shadowbox.js for local use, please make sure you change the URL of the css/js files below. —

CODE:

<link rel="stylesheet" type="text/css" href="http://www.shadowbox-js.com/source/shadowbox.css"> 
<script type="text/javascript" src="http://www.shadowbox-js.com/source/shadowbox.js"></script> 
<script type="text/javascript"> 
Shadowbox.init({
    language: 'en',
    players:  ['img', 'iframe', 'qt', 'wmp', 'swf', 'flv', 'wmv']
});
</script>

I have included all the ‘player’ versions that the Shadowbox.js tool offers through its API. Browse their site to see all the capabilities of Shadowbox.js (http://www.shadowbox-js.com/).

2.) Open your “/root/app/design/frontend/default/default/template/catalog/product/list.phtml” and find where you want to add the below code. I noted the code as best as I could, please see the end for sources so you can modify it and undesrtand whats going on.

CODE:

<?php
// ALEX HESS MOD  START //

$moo = $_product->getvideo_shadowbox_youtube();

if (empty($moo))
    echo '';
else
    echo "<a href="http://www.youtube.com/v/$moo&hl=en_US&fs=1&rel=0&color1=0x5d1719&color2=0xcd311b;autoplay=1" rel="shadowbox;width=650;height=320">VIDEO HERE</a>n";

// ALEX HESS MOD END //
?>

I chose to place my PHP code right above the “Learn More” text. Below was what I added the shadowbox-code ABOVE.

CODE:

  1. <a href="<?php echo $_product->getProductUrl() ?>" title="<?php echo $this->htmlEscape($_product->getName()) ?>"><?php echo $this->__('Learn More') ?></a>

With that known, we can see that the code should be:

CODE:

  1. <?php
  2. // ALEX HESS MOD  START //
  3. // Not sure why, but I had to set the variable "$exo" = $_product->getvideo_shadowbox_youtube() because the fucntion was not working in the if else statement.
  4. // The $_product->getvideo_shadowbox_youtube() (aka $exo) is your code that is entered in the text field attribute.
  5. $exo = $_product->getvideo_shadowbox_youtube();
  6.  
  7. // If there is no link , the echo/display nothing.
  8. if (empty($exo))
  9.     echo '';
  10.    
  11. // If there is data, echo/display below code   
  12. else
  13.     echo "<a href="http://www.youtube.com/v/$exo&hl=en_US&fs=1&rel=0&color1=0x5d1719&color2=0xcd311b;autoplay=1" rel="shadowbox;width=650;height=320">VIDEO HERE</a>n";
  14. // The above Youtube code can be modified however you would like. These are set to my preferences. In my sources, I cite a good HTML to PHP converter for you to convert your HTML code if you don't know syntax. Just make sure you stay within the two "".
  15. // ALEX HESS MOD END //
  16. ?>
  17. <a href="<?php echo $_product->getProductUrl() ?>" title="<?php echo $this->htmlEscape($_product->getName()) ?>"><?php echo $this->__('Learn More') ?></a>

That should wrap things up, go to your homepage after uploading these files via FTP. See if things are working. If not, please review the instructions. If you find an error please contact me alex[at]ExoMagic.com . Please keep in mind, I am not a developer, so if I don’t explain things very clear in the code, or things seem ‘wrong’ or not correct syntax, I apologize. Let me know and I will fix them, time permitting.

Cheers,

Sources:

http://www.w3schools.com/php/php_if_else.asp

http://tools.devshed.com/webmaster-tools/html2php/

http://www.shadowbox-js.com/usage.html

Smileys

DokuWiki converts commonly used emoticons to their graphical equivalents. More smileys can be placed in the smiley directory and configured in the conf/smileys.conf file. Here is an overview of Smileys included in DokuWiki.

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :- :-
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Typography

DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought ‘It’s a man’s world’...”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Please note: These conversions can be turned off through a config option and a pattern file.

Quoting

Some times you want to mark some text to show it’s a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn’t
Well, I say we should
Really?
Yes!
Then lets do it!

Tables

DokuWiki supports a simple syntax to create tables.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 2 Col 2 Row 2 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

As you can see, it’s the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Note: Vertical spans (rowspan) are not possible.

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

Table with alignment
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Non-parsed Blocks

You can include non-parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags code or file.

This is preformatted code all spaces are preserved: like              <-this
This is pretty much the same, but you could use it to show that you quoted a file.  

To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with nowiki tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.

See the source of this page to see how to use these blocks.

Syntax Highlighting

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <code java>.

  1. /**
  2. * The HelloWorldApp class implements an application that
  3. * simply displays "Hello World!" to the standard output.
  4. */
  5. class HelloWorldApp {
  6.     public static void main(String[] args) {
  7.         System.out.println("Hello World!"); //Display the string.
  8.     }
  9. }

The following language strings are currently recognized: abap actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, gml, groovy, haskell, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, m68k, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80

RSS/ATOM Feed Aggregation

DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:

Parameter Description
any number will be used as maximum number items to show, defaults to 8
reverse display the last items in the feed first
author show item authors names
date show item dates
description show the item description. If HTML is disabled all tags will be stripped
n[dhm] refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. DokuWiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Embedding HTML and PHP

You can embed raw HTML or PHP code into your documents by using the html or php tags like this:

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some inline HTML <HTML> <p style=”border:2px dashed red;”>And this is some block HTML</p> </HTML>

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(inline HTML)';

<PHP> echo ‘<table class=”inline”><tr><td>The same, but inside a block level element:</td>’; echo ‘<td><img src=”’ . $_SERVER[’PHP_SELF’] . ‘?=’ . php_logo_guid() . ‘” alt=”PHP Logo !” /></td>’; echo ‘</tr></table>’; </PHP>

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

Syntax Plugins

DokuWiki’s syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

1) This is a footnote



 

Introducing Magento Go

Magento Job Board - Some sort of tag line goes here

Latest Posts| View all Jobs
© Copyright 2012 Magento Inc.
Privacy Policy|Terms of Service
Magento Community Count
704132 users|1184 users currently online|497558 forum posts