Resource Menu

LibreSource Help


1-Macros

1.1-Examples

  • {table}
Create an array with muliple columns and lines. The syntax is the following : 
{table} line 1: column 1 | line 1: column 2 | line 1: column 3…
 line 2: column 1 | line 2: column 2 | line 2: column 3…
…
{table}
  • {box}
Create a box in the content windows as a frame. It allows to have different frames inside the main windows. 
{box:title=name of the box|width=45%|float=left|height=350px}
 content of the box 
{box}
  • {image}
Insert a picture in a text. The file containing the file has to be already be loaded on the server, for instance creating a resource file and upload the file. The following example give a very andy way of inserting an image in the text. 
[URI|{image:URI|align=center}]
  • {resource}
Enable to include the content of an URI, for instance a download area, doing a simple link to it. The noaction flags enables to display the ressource without user interface.

{resource:URI|noaction}
  • {children}
This macro give the list of childrens (sub-nodes) at the present node. The interest is that the list depend on the visibility that is defined in the security. Thus login users can see another list that guest user. Furthermore, one can specify the type of ressource that should be listed. The keywords are:
  • Project
  • Synchronizer
  • Template
  • Timeline
  • Page
  • Repository
  • File
  • Forum
  • Group
  • Queue
  • BugTracker
  • Survey
It is specialy usefull for handling menu. For instance, you can give the list of wiki pages. 
{children:type=Page}

1.2 List of macros

MacroDescriptionParameters
apiGenerates links to Java or Ruby API documentation.1: class name, e.g. java.lang.Object or java.lang.Object@Java131
2: mode, e.g. Java12, Ruby, defaults to Java (optional)
asinGenerates links to DVD/CD dealers or comparison services. Configuration is read from conf/asinservices.txt1: asin number
blinkBlink a text.the text
bookmarksDisplay the user bookmarks.none
boxCreate a box in order to change the basic disposition.1. the box title (optional)
2. the floating behaviour (left or right) (optional)
3. the height of the box (px,%) (optional)
4. the width of the box (px,%) (optional)
childrenDisplay the current children list.1. uri= ...(optional) where you list the resources, the default uri is the current
2. groupby=… (optional) to group resources.The following value are available : type or owner or uri or creation or update or name
3. sort=… (optional) to sort resources. The values available are : type or owner or uri or creation or update or name
4. creation=...(optional) allows you to filter on the creation date. The values available are: Date (dd/MM/yyyy) or '+'/'-'/'!' followed by a Date(dd/MM/yyyy): allows to keep superior/inferior/exclude date
5. update=...(optional) allows you to filter on the modification date. The values available are: Date (dd/MM/yyyy) or '+'/'-'/'!' followed by a Date(dd/MM/yyyy): allows to keep superior/inferior/exclude date
6. type=...(optional) :allows you to filter resources with its type. The values available are : Project, Template, Timeline, Page, Repository, File, Forum, Thread, Message, Group, Synchronizer, BugTracker, Issue, Site, Survey, Form, DropBox
7. owner=...(optional):allows you to show only resources belonging to one user or many users.
8. limit=...(optional): allows you to limit the displayed resources
9. depth=...(optional): allows you to fix the depth of listed ressources
10. view=...(optional): to fix the view of displayed resources. The view available are : flat (default view) or count(to display the number of listed ressources) or tree(display resource following tree viewer)
codeDisplays a chunk of code with syntax highlighting, for example Java, XML and SQL. The none type will do nothing and is useful for unknown code types.1: syntax highlighter to use, defaults to java (optional)
helloSay hello example macro.1: name to print
htmlBy pass wiki engine to allow HTML code in contentthe html block
api-docsDisplays a list of known online API documentations and mappings.none
file-pathDisplays a file system path. The file path should use slashes. Defaults to windows.1: file path
imageDisplay an image.1. the image URI
2. align (right ,left or center) (optional)
3. width (optional)
4. height (optional)
inter-wikiDisplays a list of known InterWiki mappings.none
isbnGenerates links to book dealers or comparison services. Configuration is read from conf/bookservices.txt.1: isbn number
linkGenerate a weblink.unexplained, lazy programmer, probably
list-of-macrosDisplays a list of available macros.unexplained, lazy programmer, probably
loginBoxDisplay a login box.none
mailtoDisplays an email address.1: mail address
menuInclude the menu of the specified URI1. The uri for the menu to be include
newsDisplay a message thread as news.1. the thread URI
2. Max (optional)
preAllow rigid text style. (Keep text formating)none
printFieldDisplay a node forms fields values.1. (uri=) The uri on which you want to get the form value (Optional, by default=.)
2. (print=) Print or not the field label and the field value (Optional, by default=label, value, edit)
3. (field=) Print or not the specified field (Optional, by default will print all)
quoteDisplay quotations.1: source (optional)
2: displayed description, default is Source (optional)
quoteMessageQuote a message in another message by referencing only the message URI.1. The message URI to quote.
resourceInclude the view of a LibreSource resource.1. the uri of the resource (mandatory)
2. the view (optional)
3. the action (optional)
4. noaction (optional)
rfcGenerates links to RFCs.unexplained, lazy programmer, probably
rssInclude an RSS feed.1. the url of the rss feed (mandatory)
searchBoxDisplay a search box.1. the URI pattern
subProjectsDisplay the current subProjects list.none
summaryCreate the summary of a wiki page.1. the page URI (optional)
surveyDisplay results of a survey.the survey URI
tableDisplays a table.none
tableFormDisplay a table listing form results.1. (uri=) The uri on which you want to get the form value (Optional, by default use the local path)
2. (print=) Print additinal features such as a link to the data (goLink) or a link to get a CSV file (csvExport) (Optional, by default print all)
3. (field=) The list of field to show (Optional by default all)
timelineDisplay the first items of a timeline.1. the timeline URI
2. Max items (optional)
userGenerate a link to the current user page, according 'action'.1. the action (optional)
2. the link label (optional)
workspacesDisplay the user workspaces.none
xrefGenerates links to Java Xref source code.1: class name, e.g. java.lang.Object or java.lang.Object@Nanning
2: line number (optional)

2-So6 synchronizer

The synchronizer is used to write any document with multiple users.

For each user/computer

  • A symbolic link between a local folder on a computer and the server has to be built using CREATE WORKSPACE
  • When the synchronizer is loaded, please define :
  • Workspace Name : to tell who and where the files come from. A typical input can be : username@localmachinename, thus you can work on different computers by changing the localmachinename.
  • Base Path: to give the location on the local machine of the folder which contains the files that you want to synchronize. Do not change the name of the files and folder. Furthermore, since the synchroniser work recursively, do not ask to synchronize the root folder of your hard drive !!
  • give your login and password, then press SET
  • COMMIT your request, and refresh your browser
  • when you cannot commit, you have to UPDATE and refresh your browser
This synchroniser can update/merge/modify all ascii files. This means that people can work at the same time on files using these following file formats : latex, native text code (*.for, *.c, *.html...)

Requirement: A java environnement sdk1.4.x (http://www.sun.com)



Last edited by Mathieu Gisselbrecht at May 16, 2007 11:34 AM - Edit content - View source