Wiki

This version (11 Mar 2016 16:28) was approved by rgetz.The Previously approved version (11 Mar 2016 16:14) is available.Diff

DokuWiki Test Page

This page is intended for verifying that upgrades of DokuWiki did not break our existing plugins and customizations. Every change that matters should be sampled on this page.

Remember that you have to edit this page in order to force a cache refresh.

amazon

just use the amazon tag providing an ASIN as shown below

{{amazon>0596529686}}

failed to fetch data: Signature check failed, did you set your Access Keys in config?

blockquote

Indeed, the purpose of an encyclopedia is to collect knowledge disseminated around the globe; to set forth its general system to the men with whom we live, and transmit it to those who will come after us, so that the work of preceding centuries will not become useless to the centuries to come; and so that our offspring, becoming better instructed, will at the same time become more virtuous and happy, and that we should not die without having rendered a service to the human race. Denis DiderotEncyclopédie, Vol. 5 (1755), pp. 635–648A

definitionlist

Definitions.

You can apply normal wiki syntax to the definition list.

Pizza
Food
Delicious
Mausi
Curry
Korma
kasmiri
fruity
ceylonese
coconutty
Bhoona

folded

If you want to make additional information available that is folded or hidden by default, you have two options

Inline:

This is example ~~text | with some of it only shown when you unfold it~~. And after that the text just continues to flow in the same paragraph.

Block:

This is example text.

~~~~ Title |

This table is only shown when you unfold the block
 
This table is only shown when you unfold the block

~~~~

graphviz

This can create directed and non-directed graph images from a textual description language called “dot” using the Graphviz program. graphviz.

include

Allows you to include different wiki pages in the current page. Simply enclose the ID of the page to be included in double curly brackets:

{{page>[id]#[section]&[flags]}}
[id] page ID of the page to include; some macros are possible; shortcuts are resolved (:, ., ..) required
[section] limits the included page to a specific section and its subsections optional; default is the whole page
[flags] flags delimited by &, see flags optional
flags Default Alternative
firstseconly fullpage includes the whole page firstseconly includes only the first section of a wiki page
showfooter footer shows a footer below the page with info about the included page nofooter hides the page info footer
showeditbtn editbtn shows a button to edit (or create) the included page noeditbtn hides the edit (or create) button
etc etc etc noheader strips the title from the included page

Example:

  
{{page>:start&firstseconly&footer}}

provides the first section of the start page

Analog Devices Wiki

This wiki provides developers using Analog Devices products with software and documentation, including HDL interface code, software drivers, and reference project examples for FPGA connectivity. It also contains user guides for some Analog Devices evaluation boards to help developers get up and running fast.

University students can find lab exercises built around the use of the Analog Devices Active Learning Modules, such as the ADALM1000, ADALM2000, ADALM-PLUTO.

To find content on the Wiki, search for keywords or browse one of the categories below.

→ Read more...

04 Sep 2017 12:15

analog devices
blackfin.uclinux.org
digikey
O'Reilly
docs.blackfin.uclinux.org

There are some special internal links which have icons associated with them:

math

<m size>...mathematical formulae...</m>

size (optional) the base glyph size in pixels - default value: 12.

alignment can be controlled in the same way as DokuWiki images, one space to the left to right align, one to the right to left align, one on each side to centre.

  • S(f)(t)=a_{0}+sum{n=1}{+infty}{a_{n} cos(n omega t)+b_{n} sin(n omega t)}
  • delim{lbrace}{matrix{3}{1}{{3x-5y+z=0} {sqrt{2}x-7y+8z=0} {x-8y+9z=0}}}{ }
  • delim{|}{{1/N} sum{n=1}{N}{gamma(u_n)} - 1/{2 pi} int{0}{2 pi}{gamma(t) dt}}{|} <= epsilon/3

syntax can be found in the math page.

note

Notes have changed recently -- please use the new format. With the new format, comes new options! You can control the corners (square [default] or round), if it has an icon or not, and the width. See the examples below.

<WRAP info>
text which you want in the box
</WRAP>
<WRAP tip>text which you want in the box</WRAP>
<WRAP important>text which you want in the box</WRAP>
<WRAP alert>text which you want in the box</WRAP>
<WRAP round help>text which you want in the box</WRAP>
<WRAP round 50% download>
  * list of files to download
</WRAP>
<WRAP todo>
  * list of things todo, or that are in progress
</WRAP>

Safety Notes:

danger - normal text is white.

<WRAP danger>
//**DANGER**// - normal text is white.
</WRAP>

warning - normal text is black.

<WRAP warning>
//**warning**// - normal text is black.
</WRAP>

caution - normal text is black.

<WRAP caution>
//**caution**// - normal text is black.
</WRAP>

notice - normal text is white

<WRAP round notice>
//**notice**// - normal text is white
</WRAP>

safety - normal text is white

<WRAP round safety>
//**safety**// - normal text is white
/WRAP>

You can use notes and boxes also inside text with paragraphs like this (the key thing to notice is the case of the WRAP or wrap keyword): <wrap info>info</wrap>, text between help, text between alert, text between important, text between tip, text between download, text betweentodo and round box and danger, warning, caution, notice, safety.

<wrap info>info</wrap>, <wrap help>help</wrap>, ...

skill

shows a number of stars to represent the level of skill needed to understand and use the page content. plugin:skill

You should see 5 out of 7 stars here:

search?q=5%2F7&amp;btnI=lucky

source

source is used to grap source code from the svn or git repositories. Since you may want to grab different parts of the file, it accepts lots of different options, but the main flavour is:

<source path:part language repository>

where part can be, numeric, two regular expressions (no spaces - it's a bug I haven't cared about - complain if it is a big deal to you), or function names.

 /1-3/         : captures from lines 1 to 3
 /foo/-/bar/   : captures from the first occurrence of "foo",
                  to the next occurrence of "bar"
 /foo/2-/bar/  : captures from the 2nd occurrence of "foo,
                  to the next occurrence of "bar"
 /foo/12-3/^$/ : captures from the 12th occurrence of "foo",
                  to the 3rd next blanks line
 /foo/-EOF     : captures from the first occurrence of "foo",
                  to the end of file
 foo{}         : functions
 foo[]         : arrays
 foo()         : scopes

If your regular expressions are a little rusty - check out a short reference

path can also have globs in it - it help pick the latest version in a branch. for example, this uses latest busybox version in trunk (sometimes there is more than one)

<source master/cf_lib/edk/pcores/axi_adc_2c_v1_00_a/regmap.txt:/REGISTER/-/0x02/ txt fpgahdl_xilinx> 

<source master/cf_lib/edk/pcores/axi_adc_2c_v1_00_a/regmap.txt:/REGISTER/-/0x02/ txt fpgahdl_xilinx>

For example:

<source trunk/README:0-5 text linux-kernel>

<source trunk/README:0-5 text linux-kernel>

<source trunk/arch/blackfin/mm/isram-driver.c:IADDR2DTEST() c linux-kernel>

<source trunk/arch/blackfin/mm/isram-driver.c:IADDR2DTEST() c linux-kernel>

xterm

$ this is a shell prompt

xterms within <WRAP box> tags, to give things different colours/titles:

root user on the host, or development computer

test:~ #> whoami
root
test:~ #>

This specifies any shell prompt running on the target

Linux:~ $> whoami
username
Linux:~ $>

wrap

Examples for the Wrap Plugin

Basic syntax

An uppercase <WRAP> (or alternatively <block> or <div>) creates a div and should be used for “big” containers, surrounding paragraphs, lists, tables, etc.

<WRAP classes width :language>
"big" content
</WRAP>

or
<block classes width :language>
"big" content
</block>

or
<div classes width :language>
"big" content
</div>

A lowercase <wrap> (or alternatively <inline> or <span>) creates a span and should be used for “small” containers, inside paragraphs, lists, tables, etc.

<wrap classes width :language>"small" content</wrap>

or
<inline classes width :language>"small" content</inline>

or
<span classes width :language>"small" content</span>

:!: Please note, some things won't work with lowercase spans:

  • alignments (including alignments generated by changing the text direction)
  • multi-columns
  • and widths

if the according wrap isn't floated as well.

Classes and Styles

Columns and Floats

You can have columns easily by adding the class column and a width, e.g.

<WRAP column 30%>...content...</WRAP>

Emulated Big Headline

You can emulate a big headline with italic, bold and underlined text, e.g.

//**__Emulated Big Headline__**//

Emulated Small Headline

A smaller headline uses no underlining, e.g.

//**Emulated Small Headline**//

If you need text that is bold and italic, simply use it the other way around:

**//No Headline//**

Different Floating Options

Normally you would only need the class column, but for more sophisticated uses (not only for columns, but for any other classes, like boxes and notes as well) you can have several kinds of “floats”:

  • column is the same as left in LTR languages and the same as right in RTL languages
  • left will let you float your wrap on the left
  • right will let the wrap float right
  • center will position the wrap in the horizontal center of the page

Widths

You can set any valid widths (but only on divs): %, px, em, ex, pt, pc, cm, mm, in, but most of the time you'd only want either

typee.g.note
%30%makes sense in a liquid layout
px420pxmakes sense if your layout has a fixed pixel width or if your container contains images with a certain width
em20emmakes sense if you like your wrap container to grow and shrink with the font size or if your layout is em-based

A table inside a column or box will always be 100% wide. This makes positioning and sizing tables possible.

After using any of the float classes, you might come across something like this, where the following text protrudes into the space where only the floating containers should be …

… to prevent that, you should simply add

<WRAP clear></WRAP>

after your last column.

You can use the same options with spans (as each element that floats is automatically a block level element), but it probably doesn't make too much sense. :!: Widths on spans normally do not work (by design), but can make sense, when it is floating.

:!: Attention: Widths can cause problems and will often look different and break in some browsers. If you're not a web developer, you might not understand any problems regarding the box model. Just try to test your columns in all major browsers and make your widths smaller than you initially think they should be.

All of those options will also work in the boxes and notes wraps (see below).

Multi-columns

For modern browsers (Firefox, Chrome and Safari) you can use multi-columns. Just use col2 for 2 columns, col3 for 3 columns, col4 for 4 columns and col5 for 5 columns.

:!: Note: Multi-columns don't make sense for spans.

Alignments

You can use these different text alignments:

  • leftalign
  • rightalign
  • centeralign
  • justify

Center aligned text …

… and right aligned.

<WRAP centeralign>
Center aligned text ...
</WRAP>

<WRAP rightalign>
... and right aligned.
</WRAP>

:!: You cannot add alignments to spans.

Boxes and Notes

round box 570px center

  • box creates a box around the container and uses the colours from the template's style.ini as default colours (__background_alt__ and __text__)
  • any of the classes info, tip, important, alert, help, download, todo will add a special note container with a corresponding icon
  • the classes danger, warning, caution, notice, safety use safety colours (and no icons)
  • round can be added to anything with a background colour or a border and will only work in modern browsers (no Internet Explorer)

Info

<WRAP info></WRAP>

Tip

<WRAP tip></WRAP>

Important

<WRAP important></WRAP>

Alert

<WRAP alert></WRAP>

Help

<WRAP round help></WRAP>

Download

<WRAP download></WRAP>

Todo

<WRAP todo></WRAP>

Safety Notes:

Danger

<WRAP danger></WRAP>

Warning

<WRAP warning></WRAP>

Caution

<WRAP caution></WRAP>

Notice

<WRAP round notice></WRAP>

Safety

<WRAP round safety></WRAP>

You can use notes and boxes also inside text with spans like this: info, help, alert, important, tip, download, todo and round box and danger, warning, caution, notice, safety.

<wrap info>info</wrap>, <wrap help>help</wrap>, ...

Marks

You can mark text as highlighted, less significant and especially emphasised.

You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>.

:!: This might look ugly in some templates and should be adjusted accordingly.

Miscellaneous

Indent

This text will appear indented.

<wrap indent>This text will appear indented.</wrap>

Outdent

This text will appear “outdented”.

<wrap outdent>This text will appear "outdented".</wrap>

Prewrap

Inside this code block the words will wrap to a new line although they are all in one line.
<WRAP prewrap 250px>
<code>
Inside this code block the words will wrap to a new line although they are all in one line.
</code>
</WRAP>

Spoiler

Here follows a spoiler: Darth Vader is Luke's father.

Here follows a spoiler: <wrap spoiler>Darth Vader is Luke's father.</wrap>

Just select the text in the spoiler box to be able to read its content.

Hide

The following text is hidden: John, please revise that sentence.

The following text is hidden: <wrap hide>John, please revise that sentence.</wrap>

:!: Warning: The text will still appear in the source code, in non-modern browsers and is searchable. Do not hide any security risky secrets with it!

Pagebreak

The following will add a pagebreak:

The following will add a pagebreak: <WRAP pagebreak></WRAP>

This has no effect on the browser screen. A pagebreak will force a new page in printouts.

Nopagebreak

The following will try to avoid a pagebreak:

much content, belonging together (like a long table)

The following will try to avoid a pagebreak: <WRAP nopagebreak>much content, belonging together (like a long table)</WRAP>

This also has no effect on the browser screen. It will try to avoid a page break in printouts.

Noprint

This text appears on the screen, but not in print.

<wrap noprint>This text appears on the screen, but not in print.</wrap>

Onlyprint

This text does not appear on the screen, but only in print.

<wrap onlyprint>This text does not appear on the screen, but only in print.</wrap>

Typography

I advise against using the following typography classes. It's better to create semantic classes that reflect their meaning instead.

  • font family: sansserif, serif, monospace
  • font size: bigger, muchbigger, smaller
  • font colour: fgred, fggreen, fgblue, fgcyan, fgviolet, fgyellow, fggrey, fgwhite, fgblack
  • background colour: bgred, bggreen, bgblue, bgcyan, bgviolet, bgyellow, bggrey, bgwhite, bgblack

Combining and Nesting

You can combine and nest all classes and types of boxes, e.g.

Outer green box floats right

Inner nested box floats left and is partly emphasized and highlighted with nested bigger text inside.

Text inside outer right box, but beneath inner left box.

Round tip box underneath, after a clear.

<WRAP box bggreen fgblack 350px right :en>
//**__Outer green box floats right__**//

<WRAP 165px left>
Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with nested <wrap bigger>__bigger__ text</wrap> inside</wrap>.
</WRAP>

Text inside outer right box, but beneath inner left box.

<WRAP clear></WRAP>

<WRAP round tip>
Round tip box underneath, after a ''clear''.
</WRAP>

</WRAP>

Language and Text Direction

You can change the language and the reading direction of a wrap container by simply adding a colon followed by the language code, like this:

<WRAP :he>
זוהי עברית. ((<wrap :en>This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].</wrap>))
</WRAP>

זוהי עברית. 1)

The text direction (rtl, right to left or ltr, left to right) will get inserted automatically and is solely dependent on the language. The list of currently supported languages is taken from: http://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code (If you specify a language not listed there, it simply won't do anything.)

Analog TV

 {{analogTV>983688886001}}

To find this magic number, search on www.analog.com for the video that you want to include in the wiki. In this case, when I search for Automotive Safety Systems and Radar (words from the title), search provides : http://www.analog.com/en/education/education-library/videos/983688886001.html. Just use the number, without the .html at the end of the url.

If you goto the videos section, it is a little more difficult. Just click on the get code button, near the bottom of the players. This will bring up something that says embed code. In the <object id=… string, there will be a portion which is the videoId=983688886001. Just use this number.

Any video on www.analog.com will work this way.

The Adobe Flash Plugin is needed to display this content.
1)
This means “This is Hebrew.”, at least according to Google Translate.
wiki/more_syntax.txt · Last modified: 11 Mar 2016 16:28 by rgetz