![]() ![]() ![]() |
RAMADDA User Guide
|
There is always some repository entry associated with wiki text. This might be a specific Wiki Entry, we might be treating the description of some arbitrary entry as wiki text using the <wiki> tag, or the wiki text might be coming from a Page Style.
A horizontal line:==Section Heading 1== ===Section Heading 2===
Lists:----
You can escape your wiki text and include raw, unprocessed text with the <nowiki> tag:* bullet 1 * bullet 2 ** sub bullet 1 ** sub bullet 2 * bullet 3
See the Wikipedia page on Wiki Markup for more information on basic Wiki markup. Note: RAMADDA does not support the Wikipedia HTML table format. For tables its best just to use HTML table markup.Some wiki text <nowiki> This is text that does not get formatted </nowiki> more wiki text
Some description here. <snippet>This is the snippet</snippet> More descriptionInset By default, a page has no margins on the left-side. If you have normal text layout you can make an inset with "+inset":
+inset ... -insetThis by default gives a 20px left and right margin. To change this you can add any of the attributes, e.g:
+inset top="100" left="50" right="50" bottom="100" ... -insetSections
+section ... -sectionIf you append a "#" then the row number is kept track of and an even/odd color scheme is applied.
+section # ... -section +section # ... -sectionIf you add label="..." then a header is added. The normal use is:
+section # label="section 1" ... -section +section # label="section 2" ... -section +section # label="section 3" ... -sectionYou can change the background color/image by specifying one of the classes:
+section class="ramadda-section-map" ... -section +section class="ramadda-section-lightpink" ... -section +section class="ramadda-section-lightblue" ... -section +section class="ramadda-section-lightgreen" ... -sectionYou can also add a CSS style descriptor
+section style="background: #888; border: 1px red solid;" ... -sectionGrid Layout
+jumbo This is some text and some more test. Lorem ipsum -jumboYou will get something like:
+mini <h2>Heading</h2> This is some text and some more test. Lorem ipsum -miniYou will get something like:
+row +col-md-4 Left column contents -col +col-md-4 Center column contents -col +col-md-4 Right column contents -col -rowResults in:
+row +col-md-2 Left column contents -col +col-md-10 Right column contents -col -rowResults in:
In RAMADDA you can use the name of another entry to create the link. You can use the Add entry link menu to select an entry. This produces wiki text of the form:[[Page name]]
e.g.:[[entry id|Label to show for link]]
You can also just specify an entry by name. Either an absolute path:[[7ca13e52-8efb-4d17-863f-e17027dbcc22|Earthquake data]]
Or relative to the wiki entry:[[Top entry/Some other entry]]
You can also set the output type for an entry using the hashtag (#) symbol after the entry id:[[Some entry]]
which will override the default display. If the entry with the given name does not exist then the link will take one to the create entry form.[[7ca13e52-8efb-4d17-863f-e17027dbcc22#html.table|Earthquake data as a table]]
e.g., if we wanted to show the information tabs for an entry we'd do:{{property}}
For example, if we want to import the information block with it open:{{information}}
This would give us: Normally, all property tags refer to the current entry. However, you can specify another entry:{{information open="true"}}
The entry value can be:{{information entry="some other entry id or name or 'parent' or 'grandparent'"}}
Some of the properties can result in an error message (e.g., image not found, entry not found, etc). You can specify a different message (or blank) with message attribute:
For example, you can set up a wiki template that shows an image attachment and a list of entries in a sub-folder called "Links". If you used the below wiki text then you would see displayed "Could not find image" and "Could not find entry" error messages.{{someproperty message="some message"}}
If, however, you specify a blank message then nothing will be shown:{{image src="::*"}} {{links entry="Links"}}
Note: you can specify a prefix and suffix attributes that are only used if the tag was successful. So for example you could specify a heading for the links:{{image src="::*" message=""}} {{links entry="Links" message=""}}
This would only show when there is a Links sub-folder.{{links entry="Links" message="" prefix="Here are the links:<br>}}
{{properties metadata.types="!project_pi" message="" }}Then if you wanted to just show the Project PI property then do:
{{properties metadata.types="project_pi" message="" }}
{{map listentries="true" listwidth="25%"}}If you have a Folder (or other group) and want to just show the Folder and nots it children then do:
{{map entries="this"}}
src="entry name"to show an entry. This is equivalent to using entry="...". You can also specify the name of a file attachment to an entry with:
entry="entryid" src="::attachment name"Or any attachment with:
entry="entryid" src="::*"If link is true, the image displayed will be linked to the entry page, if linkresource is true, it will be linked to the full sized image (the entry resource). height and width can be used to scale the image, the alt attribute will be used in place of the entry id as a label on the image for accessibility.
{{menu}}You can specify which menus to show with a comma separated list of menu names. Only show the file and view menu:
{{menu menus="file,view"}}Show the menu actions in a popup:
{{menu popup="true" title="Click here"}}
provider=google,arxiv,wolfram
layoutType=table layoutType=columns layoutType=rowsUsing the table layout you also specify a number of columns with the layoutColumns attibute. For the columns and rows layout type each child display can specify the column number of row number it should be placed in. For example, for the rows layout if you had:
{{group layoutType="rows"}} {{display display1 row="1"}} {{display display2 row="1"}} {{display display3 row="1"}} {{display display4 row="2"}} {{display display5 row="2"}} {{display display6 row="3"}}Would result in (without the border):
display1 | display2 | display3 |
display4 | display5 |
display6 |
When using the display tag you need to specify the type of display. {{display type="entrylist" layoutHere="true" orientation="vertical" showMetadata="false" showTypes="true" name="list1" innerHeight="200" divid="listdiv" formOpen="false"}}:<table width=100% border=0 cellpadding=10> <tr valign=top> <td width=50%><div id="listdiv"></div></td> <td width=50%><div id="mapdiv"></div></td> </table> <div id=maindiv></div> {{group layoutType="table" layoutColumns="1" divid="maindiv"}} {{display type="entrylist" divid="listdiv" }} {{display type="map" layoutHere="true" height="250" divid="mapdiv"}}
entryType="type_point_pbo_position_time_series" ramaddaBaseUrl="http://community.ramadda.org/repository/repos/data"
The entries attribute is a comma separated list of entry identifiers. They can be specific entry ids or they can be one of a set of relative descriptors:{{property entry="some other entry" entries="entryid1,entryid2,entryid3.." entries.filter="file|folder|image|type:some type|geo|suffix:file suffixes" exclude="entryid1,entryid2,entryid3.." first="entryid1,entryid2,entryid3.." last="entryid1,entryid2,entryid3.." sort="name|date" sortorder="up|down" max="number of entries to use" }}
descriptor:baseEntryIdSo, for example, if you had 2 different Folder entries - folder1 and folder2 and you wanted to list all of the children of each folder you could do:
{{tree entries="children:folder1_id,children:folder2_id"}}You can combine different relative descriptors, e.g.:
{{tree entries="children:folder1_id,grandchildren:folder2_id"}}
Here are some examples:
Find all entries with text 'climate':
{{tree search.text="climate" entries="search"}}Find all entries with file suffix 'pdf' that have been created in the last 2 days:
{{tree search.suffix="pdf" search.createdate.relative="-2 days" entries="search"}}
entries.filter=file|folder|image|type:some type|geo|suffix:file suffixesIf you specify suffix:file suffixes then this will only match entries that have files with the given suffix. This can be a comma separated list of suffixes, e.g.:
entries.filter="suffix:.ppt,.pptx,.pdf"Or negate them with "!":
entries.filter=!file|!folder|!image|!type:some type|!geoSo, you could show all of the georeferenced entries in a map and all of the non-georeferenced entries in a list:
{{map message="" prefix="==Map=="}} {{tree message="" prefix="==Non georeferenced entries==" entries.filter="!geo"}}You can also:
67259186-574e-4453-a2af-969e1cf658c8 f5ccdc47-62f7-481a-b67d-bf76e5b34359 ...If an entry id has a "+" prefix then the children entries of the specified entry is used
+67259186-574e-4453-a2af-969e1cf658c8 +f5ccdc47-62f7-481a-b67d-bf76e5b34359 ...You can also specify a search. This is a set of search terms followed by "search". You can specify text to search for, the entry type, spatial bounds and date based search.
search.text=text to search search.type=entry type search.bbox=north,west,south,east search.createdate.relative=-1 day search
The title attribute is used in place of "Children". If showtoggle="false" then the show/hide toggle link is not shown.{{tree title="Links" showtoggle="false" open="true" }}
{{grid entries="grandchildren"}}
If useAttachment is true then, if the entry's file is not an image but it has an attachment that is an image then use the attachment image.{{imageplayer loopdelay="500" loopstart="true"}}
Show a vertical listing of the children entry images:{{gallery columns="3"}}
Set the image width and only show up to 5 images:{{gallery columns="1"}}
{{gallery width="300" max="5"}}
Show only the 3 specified entries in tabs:{{tabs}}
Show only the children of type wikipage in tabs:{{tabs entries="0af4d166-5723-4775-88fc-b83b72ab47a4, 83539d5c-e9d9-408e-b0af-35f480000ae6, 49684d25-6af1-4188-a0ae-4d5302d22f2a" }}
Additional arguments:{{tabs entries="type:wikipage"}}
Uses the same arguments as tabs. If border is non-zero then show a border. If collapse is false then open the first section.{{accordian}}
{{slideshow}}
Uses the same arguments as tabs, plus:
A bulleted list with the links to the entry's file:<ul> {{links}} </ul>
If you wanted to make a vertical list do:<ul> {{links linkresource="true"}} </ul>
You can create a header with wiki text like:{{links tagopen="<div>" tagclose="</div>"}}
<center> {{links separator=" | " tagopen=""}} </center>
All of the arguments, including the entry argument are the same as described above but have the prefix "apply.". This way you can mix the arguments that control the apply function with the arguments that you are using for each entry. Say you have the following entries:{{apply apply.entry="the entry to find the children of" apply.tag="some tag to apply to the entries" apply.layout="table, accordian or tabs" apply.columns="number of columns in table" apply.header="text to go before can contain macros ${name} ${url}" apply.footer="text to go after" apply.border="border width - defaults to 0" apply.bordercolor="border color" apply.includeicon="true|false" ... <arguments for the apply tag> }}
parent entry1 sub-entry1 sub-entry2 entry2 sub-entry3 sub-entry4If you used the apply tag:
This applies the tag "links" to each main entry. It puts each result in a tab. This tag would make a 2 column table of maps with links to the entries show in the header.{{apply apply.entry="parent" apply.layout="tabs" apply.tag="links" linkresource="true" }}
{{apply apply.layout="table" apply.columns="2" apply.tag="map" apply.border="1" apply.header="${url}" <any map arguments*gt; }}
You can specify the toggle label title with:<block> any content here </block>
<block title="Click here to open">
any content here
</block>
You can specify whether the block is open or closed:
<block open="false">
any content here
</block>
You can specify whether to show the content or not:
You can also use the block tag to define a variable or macro that is used later.<block show="mobile" decorate="false"> this will only show for mobile users </block> <block show="!mobile" decorate="false"> this will only show for non-mobile users </block>
<block var="var_name">
any content here
</block>
This will not show the content in place. Rather you can reference and insert the content later with:
\${var_name} </block>
So, if you wanted to show the calendar view of an entry you would do:
To find the correct output identifier just navigate to the page you want to include and look at the url for the output=... url argument and use that.{{import output="calendar.calendar"}}