Differences

This shows you the differences between two versions of the page.

--- plugin:projects [2012-11-06 10:13] – [Installation] 24.108.94.90
+++ plugin:projects [2023-12-21 17:15] (current) – new download url Aleksandr
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: A plugin that allows wiki pages to represent files, and to generate files basing on some recipe (rules). This empowers a dokuwiki to become a collaboration tool on project management and content creation.
+description: A plugin that allows wiki pages to represent files, and to generate files basing on some recipe (rules). This empowers a DokuWiki to become a collaboration tool on project management and content creation.
 author     : Junling Ma
 email      : junlingm@gmail.com
 type       : action, admin, syntax
-lastupdate : 2011-04-29
+lastupdate : 2013-01-21
-compatible : 2010-11-07, 2011-05-25, 2011-11-10, 2012-10-13
+compatible : 2012-10-13, 2012-01-25, 2011-11-10, 2011-05-25, 2010-11-07
 depends    :
 conflicts  :
@@ Line 14: / Line 14: @@
 tags       : collaboration file source generate make recipe projects
+downloadurl: https://trello.com/1/cards/5d51a96f443d032cd41b9eb5/attachments/5d51a97a80955466ade38ce6/download/projects.zip
-downloadurl: http://rsv.math.uvic.ca/projects.php
+bugtracker :
-bugtracker : # eg. http://github.com//dokuwiki-plugin-projects/issues
+sourcerepo : # http://rsv.math.uvic.ca/dokuwiki/doku.php/development FIXME
-sourcerepo : http://rsv.math.uvic.ca/dokuwiki/doku.php/development
 donationurl:
+screenshot_img:
 ----
 ===== Installation =====
-__**SECURITY WARNING**__: There is a huge security risk enabling this plugin on an publicly editable wiki, just as enabling the php embedding in wiki pages, i.e., it is equivalent of opening up access to the user and group that the apache process is running with. To mitigate this risk, you need to restrict the editing privilege to only trusted user to the ":projects" namespace.
+**SECURITY WARNING:** There is a huge security risk enabling this plugin on a publicly editable wiki, just as enabling the php embedding in wiki pages, i.e., it is equivalent of opening up access to the user and group that the apache process is running with. To mitigate this risk, you need to restrict the editing privilege to only trusted user to the '':projects'' namespace.
-The newest version is 2012-11-06, which is compatible with the "Adora Belle" release. See the changelog below.
+The newest version is 2013-01-21, which is compatible with the [[changes#release_2012-10-13_adora_belle|“Adora Belle” release]]. See the [[#change log]] below.
-Installation instructions:
+==== Installation instructions ====
-  * Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to the latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+  * Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
   * Then create a ":projects" namespace.
   * Any page under the ":projects" namespace and its sub-namepaces are managed by projects wiki.
@@ Line 35: / Line 37: @@
 ===== Examples/Usage =====
-See the [[http://rsv.math.uvic.ca/dokuwiki/doku.php/development|development page]]:
+See the [[plugin:projects:development|development page]]:
-  * See [[http://rsv.math.uvic.ca/dokuwiki/doku.php/projects_wiki_documentation|documentation]] for a tutorial.
+  * See [[plugin:projects:documentation|documentation]] for a tutorial.
-  * See [[http://rsv.math.uvic.ca/dokuwiki/doku.php/projects:projects:projects|projects wiki development]] page for an example, which self hosts the projects plugin.
+  * See [[https://web.archive.org/web/20161104180420/http://rsv.math.uvic.ca/dokuwiki/doku.php/projects:projects:projects|[a web.archive.org copy of] projects wiki development]] page for an example, which self hosts the projects plugin.
 ===== Syntax =====
 Basic syntax:
-  * Declaring a page as a file with the page name as file name: <project-file type="TYPE"/>
+  * Declaring a page as a file with the page name as file name: ''%%<project-file type="TYPE"/>%%''
     * TYPE can be one of
       * source
       * generated
       * crosslink
-  * Dependency: <use name="some file name"/>
+  * Dependency: ''%%<use name="some file name"/>%%''
-  * The content of a source file: <source>whatever content you want to put here</content>
+  * The content of a source file: ''<source>whatever content you want to put here</content>''
-  * The recipe for a generated file: <recipe>some unix sh shell commands to generate a file</recipe>
+  * The recipe for a generated file: ''<recipe>some unix sh shell commands to generate a file</recipe>''
 ===== Configuration and Settings =====
@@ Line 56: / Line 59: @@
 ===== Development =====
-See [[http://rsv.math.uvic.ca/dokuwiki/doku.php/development]].
+See [[plugin:projects:development]].
 === Involvement ===
 If you would like to contribute to the development, please email [[junlingm@gmail.com|Junling Ma]].
 === Change Log ===
+  * 2013-01-21:
+    * Fixed the link on the target file page to download/display the content of the target file.
+    * The default rule for linking to a media file was broken in the previous version. Now fixed.
   * 2012-11-06:
-    * Fixed crosslinks. It was completely broken before.
+    * Fixed cross-links. It was completely broken before.
     * Source and target files are uploaded to the media folder, so they can be retreated as a media file. File information are thus available for source and target files in media links.
     * Fixed the CodeMirror editor for "Adora Belle".
@@ Line 71: / Line 79: @@
   * 2012-08-13:
-    * Use CodeMirror (http://codemirror.net) as the code editor for projects wiki represented source files and scripts for generated files. **Note however this is not compatible with Javascript and CSS compression!**
+    * Use [[http://codemirror.net/|CodeMirror]] as the code editor for projects wiki represented source files and scripts for generated files. **Note however this is not compatible with JavaScript and CSS compression!**
   * 2011-11-24:
@@ Line 125: / Line 133: @@
 Please post your comments and suggestions, bug reports, etc, here.
-===Bug Reports===
+=== Bug Reports ===
   * conflicts with plugin [[plugin:bookcreator|bookcreator]]: pictures (PNGs / JPGs) are generated within the projects directory, but don't show up in wiki.
@@ Line 131: / Line 139: @@
   * "clear project" function can delete whole wiki: restrict access of the plugin to certain configured namespaces.
-===Comments and suggestions===
+=== Comments and suggestions ===
   * thanks for this AMAZING plugin!!
   * Further Development idea: \\ check for (new / updated) files of a certain filetype (scripts) in project directory and display them as sources page in wiki.
     * Technically, these are generated files. So they should have a proper generated file page. The main need for this automatic detection mechanism that I can see is if a recipe for a generated file A actually generates two files A and B simultaneously. In this case, a common work around (as least common in the makefile world) is to make file B depend on file A, in our case, with a simple recipe as "touch B".
+  * Feature request: \\ Regarding latex, it would be great if the plugin could use the CLSI api (https://github.com/jpallen/clsi/wiki), so that one doesn't need a local Latex installation. Perhaps there could be an option in the Admin page, where the administrator can choose between using the local installation, or the CLSI api. Then one would not need to install Latex in the servers, just Dokuwiki and this plugin, and done.