CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site

This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Discussion »
  • Extensions (Moderators: mathieu, totten, kasiawaka) »
  • Documentation tag?
Pages: [1]

Author Topic: Documentation tag?  (Read 420 times)

CatorgHans

  • I post frequently
  • ***
  • Posts: 157
  • Karma: 5
  • CiviCRM version: 4.4
  • CMS version: drupal
Documentation tag?
November 28, 2014, 12:20:50 am
I tried to publish an extension yesterday.

This morning I received a message from the automated release system from civicrm.org.

One thing puzzled me, it said:
 - In info.xml, the element ("documentation") is missing or invalid.

Civix does not generate a documentation element and it is not mentioned in:
http://wiki.civicrm.org/confluence/display/CRMDOC/Publish+an+Extension

If I look at the info.xml of others I do see the "urls" tag, for example:
Code: [Select]
<urls>
  <url desc="Main Extension Page">http://github.com/TechToThePeople/noverwrite</url>
  <url desc="Documentation">http://github.com/TechToThePeople/noverwrite</url>
  <url desc="Support">http://forum.civicrm.org</url>
  <url desc="Licensing">http://civicrm.org/licensing</url>
</urls>

Is this:
Code: [Select]
<url desc="Documentation"> the Documentation described in the email?

Erik Hommel

  • Forum Godess / God
  • I live on this forum
  • *****
  • Posts: 1773
  • Karma: 59
    • EE-atWork
  • CiviCRM version: all sorts
  • CMS version: Drupal
  • MySQL version: Ubuntu's latest LTS version
  • PHP version: Ubuntu's latest LTS version
Re: Documentation tag?
November 28, 2014, 03:34:15 am
Yes, I think they are....I keep bumping into this one every time I publish one :-)
Consultant/project manager at EEatWork and CiviCooP (http://www.civicoop.org/)

totten

  • Administrator
  • Ask me questions
  • *****
  • Posts: 695
  • Karma: 64
Re: Documentation tag?
November 28, 2014, 11:08:45 am
Yup, agree that it's talking about <url desc="Documentation">. For existing modules, one should add the tags manually.

FWIW, beginning with the September update to civix (v14.09.1), new extensions will include example <url> tags by default, e.g.

Code: [Select]
$ civix generate:module org.example.mymodule
License set to GPL-2.0+ (authored by Tim Otten <xxxxxx@xxxxxx.org>)
If this is in error, please correct info.xml and LICENSE.txt
Initalize module org.example.mymodule
Write org.example.mymodule/info.xml
Write org.example.mymodule/mymodule.php
Write org.example.mymodule/mymodule.civix.php
Write org.example.mymodule/LICENSE.txt
Refresh extension list for "http://dmaster.l/"
Enable extension (org.example.mymodule) in "http://dmaster.l/"? [Y/n]

The info.xml file looks like:

Code: [Select]
<?xml version="1.0"?>
<extension key="org.example.mymodule" type="module">
  <file>mymodule</file>
  <name>FIXME</name>
  <description>FIXME</description>
  <license>GPL-2.0+</license>
  <maintainer>
    <author>Tim Otten</author>
    <email>xxxxx@xxxxxxx.org</email>
  </maintainer>
  <urls>
    <url desc="Main Extension Page">http://FIXME</url>
    <url desc="Documentation">http://FIXME</url>
    <url desc="Support">http://FIXME</url>
    <url desc="Licensing">http://www.gnu.org/licenses/gpl-2.0.html</url>
  </urls>
  <releaseDate>2014-11-28</releaseDate>
  <version>1.0</version>
  <develStage>alpha</develStage>
  <compatibility>
    <ver>4.2</ver>
  </compatibility>
  <comments>This is a new, undeveloped module</comments>
  <civix>
    <namespace>CRM/Mymodule</namespace>
  </civix>
</extension>

The documentation for info.xml is at http://wiki.civicrm.org/confluence/display/CRMDOC/Extension+Reference

Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Discussion »
  • Extensions (Moderators: mathieu, totten, kasiawaka) »
  • Documentation tag?

This forum was archived on 2017-11-26.