From f43c772109a2f012d64b3884a95bebb69cb8dc7e Mon Sep 17 00:00:00 2001 From: jfiat Date: Mon, 23 Jun 2014 15:50:07 +0000 Subject: [PATCH] Author:paolanto Date:2014-06-23T13:57:11.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1385 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- .../solutions/iron-eiffel-package-repository.wiki | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/documentation/current/solutions/iron-eiffel-package-repository.wiki b/documentation/current/solutions/iron-eiffel-package-repository.wiki index 7b9e9928..abe44828 100644 --- a/documentation/current/solutions/iron-eiffel-package-repository.wiki +++ b/documentation/current/solutions/iron-eiffel-package-repository.wiki @@ -318,15 +318,21 @@ See for instance, the package.iron for Eiffel Base package: end -Note: online version at https://svn.eiffel.com/eiffelstudio/trunk/Src/library/base/package.iron . +Note: The package iron file for the Eiffel Base package is available online at https://svn.eiffel.com/eiffelstudio/trunk/Src/library/base/package.iron . -Only the name of the package is required for now, but the section "project" list the various available .ecf projects, and the section "note" contains the title, description, tags, ... information. -The tag under the '''note''' section is free, and for now, only '''title, description, tags, link[...], and maps''' have semantic. For now the others are simply stored and never displayed, but the server will be improved later to support for more meta data. +Current status: +* only the '''name of the package is required''' +* the section "project" list the various available .ecf projects +* the section "note" contains title, description, tags, ... informations. The formation is similar to Eiffel indexing note, and in addition it supports bracket in the name of note, such as in ''link[doc]''. +** The "link" declaration: link[category]: "Optional Title" associated-url +* The following notes have semantic that are processed by Iron: '''title, description, tags, link[..], and maps''', for now mostly on the Iron server. +* It is possible to use any note name. Currently they are simply stored and never displayed. In the future, Iron may support additional semantic for those notes. -A few packages may require post installation operations, such as compiling C code, or others. +A few packages may require '''post installation operations''', such as compiling C code, or others. For that, use the section '''setup''', and in particular the '''compile_library''' information. During installation, '''iron''' will launch the compile_library tool delivered with EiffelStudio on the provided directory. Example at https://svn.eiffel.com/eiffelstudio/trunk/Src/library/cURL/package.iron : + package cURL setup