jEdit / Plugin Central Submission / #1055 TEI

Eric Le Lay - 2020-05-31

Thanks for the plugin! It seems to work nicely.

It can't be released because it doesn't use the plugin-build.xml defined task from build-support, resulting in missing package task (that produces binary only and full (with source code) archives that are then uploaded to plugin central).

Also, if you don't mind bumping to jdk 1.8 and jEdit 5.5, it would be great (jEdit 5.0 / java 1.6 looks too old to me and I have no means to test it).

It's quite a mouthful to take in the build-support infrastructure, but have a look at the XML plugin for inspiration and don't hesitate to ask for help.

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- Dale Anson - 2020-06-01
  
  Hi Eric,
  
  As far as I know, it's not a requirement to use plugin-build.xml. The build
  file just has to produce a complete jar file by running "ant dist". There
  are a lot of plugins that were written before plugin-build.xml was written,
  and there are some since that don't use it. I know the jEdit docs don't say
  that anymore, but I think that is still the minimum requirement for a build
  file.
  
  Also, Java 11 is the minimum now, yes?
  
  Dale
  
  On Sun, May 31, 2020 at 7:59 PM Eric Le Lay via jEdit-devel jedit-devel@lists.sourceforge.net wrote:
  
  Thanks for the plugin! It seems to work nicely.
  
  It can't be released because it doesn't use the plugin-build.xml defined
  task from build-support, resulting in missing package task (that produces
  binary only and full (with source code) archives that are then uploaded to
  plugin central).
  
  Also, if you don't mind bumping to jdk 1.8 and jEdit 5.5, it would be
  great (jEdit 5.0 / java 1.6 looks too old to me and I have no means to test
  it).
  
  It's quite a mouthful to take in the build-support
  https://sourceforge.net/p/jedit/svn/HEAD/tree/build-support/trunk/
  infrastructure, but have a look at the XML plugin for inspiration and don't
  hesitate to ask for help.
  
  [plugin-central-submission:#1055]
  https://sourceforge.net/p/jedit/plugin-central-submission/1055/ TEI*
  
  Status: open
  Group: None
  Created: Tue May 26, 2020 07:03 AM UTC by Conal Tuohy
  Last Updated: Tue May 26, 2020 07:03 AM UTC
  Owner: nobody
  
  {{{ TEI 1.4
  Source: Source code is at
  https://github.com/Conal-Tuohy/jEdit-TEIPlugin.git with tag 1.4
  Announcement: Initial Plugin Central release
  Requires Java 1.6
  Requires jEdit 05.00.99.00
  Required plugins:
  EclipseIcons 1.0 (eclipseicons.EclipseIconsPlugin)
  SaxonPlugin 9.5.1.1 (saxon.SaxonPlugin)
  SideKick 1.8 (sidekick.SideKickPlugin)
  XML 3.0.6 (xml.XmlPlugin)
  Optional plugins:
  BufferTabs 1.2.4 (buffertabs.BufferTabsPlugin)
  
  Short Description: This plugin provides tooling for working with Text Encoding for Interchange (TEI) XML. Development of the initial version of the plugin was funded by DARIAH-EU in 2018/2019.
  Long Description:
  
  This plugin provides tools for text encoding using TEI XML
  
  A template menu provides starting points for creating new TEI
  documents
  
  Schemas, templates, catalogs, and stylesheets are updated
  automatically from the TEI Consortium's website
  
  }}}
  
  Sent from sourceforge.net because jedit-devel@lists.sourceforge.net is
  subscribed to https://sourceforge.net/p/jedit/plugin-central-submission/
  
  To unsubscribe from further messages, a project admin can change settings
  at
  https://sourceforge.net/p/jedit/admin/plugin-central-submission/options.
  Or, if this is a mailing list, you can unsubscribe from the mailing list.
  --
  
  jEdit Developers' List
  jEdit-devel@lists.sourceforge.net
  https://lists.sourceforge.net/lists/listinfo/jedit-devel
  
  Related
  
  Plugin Central Submission: ~~#1055~~
  
  alternate
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
  - Conal Tuohy - 2020-06-01
    
    Thanks Dale!
    
    Earlier I had used the build-support infrastructure but then later I
    eliminated it in order to reduce the complexity of the build process. Right
    now, the plugin can simply be cloned from the git repo, and built,
    requiring nothing but Ant. The build.xml file is quite small and simple
    since it isn't coupled with build-support at all. The reason I did this is
    because I want to make the plugin maximally accessible to multiple
    developers in the TEI community, almost none of whom know anything about
    jEdit. I'd like to make it as easy as possible for these developers to
    contribute small changes and additions to the plugin without knowing much
    about jEdit or its custom build tools. Especially so because I hope and
    expect that the plugin will grow to include more functionality which may be
    implemented in XPath, XSLT, XQuery, etc, which are common programming
    languages in the TEI community (more so than Java), and I don't want
    potential contributors to be excluded by a steep learning curve.
    
    So if I can meet the practical requirements for deployment to Plugin
    Central without build-support, I'd like to continue with that approach
    
    I take it from Eric's comment that I need to implement another target to
    package a source distribution as well. I will have a look at this and if
    it's obvious I'll add it. If anyone can give me some practical advice
    quickly though, that would be much appreciated! Is there anything else the
    build needs to do?
    
    Conal
    
    On Mon, 1 Jun 2020 at 10:22, Dale Anson dale@daleanson.com wrote:
    
    Hi Eric,
    
    As far as I know, it's not a requirement to use plugin-build.xml. The
    build file just has to produce a complete jar file by running "ant dist".
    There are a lot of plugins that were written before plugin-build.xml was
    written, and there are some since that don't use it. I know the jEdit docs
    don't say that anymore, but I think that is still the minimum requirement
    for a build file.
    
    Also, Java 11 is the minimum now, yes?
    
    Dale
    
    On Sun, May 31, 2020 at 7:59 PM Eric Le Lay via jEdit-devel jedit-devel@lists.sourceforge.net wrote:
    
    Thanks for the plugin! It seems to work nicely.
    
    It can't be released because it doesn't use the plugin-build.xml defined
    task from build-support, resulting in missing package task (that produces
    binary only and full (with source code) archives that are then uploaded to
    plugin central).
    
    Also, if you don't mind bumping to jdk 1.8 and jEdit 5.5, it would be
    great (jEdit 5.0 / java 1.6 looks too old to me and I have no means to test
    it).
    
    It's quite a mouthful to take in the build-support
    https://sourceforge.net/p/jedit/svn/HEAD/tree/build-support/trunk/
    infrastructure, but have a look at the XML plugin for inspiration and don't
    hesitate to ask for help.
    
    [plugin-central-submission:#1055]
    https://sourceforge.net/p/jedit/plugin-central-submission/1055/ TEI*
    
    Status: open
    Group: None
    Created: Tue May 26, 2020 07:03 AM UTC by Conal Tuohy
    Last Updated: Tue May 26, 2020 07:03 AM UTC
    Owner: nobody
    
    {{{ TEI 1.4
    Source: Source code is at
    https://github.com/Conal-Tuohy/jEdit-TEIPlugin.git with tag 1.4
    Announcement: Initial Plugin Central release
    Requires Java 1.6
    Requires jEdit 05.00.99.00
    Required plugins:
    EclipseIcons 1.0 (eclipseicons.EclipseIconsPlugin)
    SaxonPlugin 9.5.1.1 (saxon.SaxonPlugin)
    SideKick 1.8 (sidekick.SideKickPlugin)
    XML 3.0.6 (xml.XmlPlugin)
    Optional plugins:
    BufferTabs 1.2.4 (buffertabs.BufferTabsPlugin)
    
    Short Description: This plugin provides tooling for working with Text Encoding for Interchange (TEI) XML. Development of the initial version of the plugin was funded by DARIAH-EU in 2018/2019.
    Long Description:
    
    This plugin provides tools for text encoding using TEI XML
    
    A template menu provides starting points for creating new TEI
    documents
    
    Schemas, templates, catalogs, and stylesheets are updated
    automatically from the TEI Consortium's website
    
    }}}
    
    Sent from sourceforge.net because jedit-devel@lists.sourceforge.net is
    subscribed to https://sourceforge.net/p/jedit/plugin-central-submission/
    
    To unsubscribe from further messages, a project admin can change settings
    at
    https://sourceforge.net/p/jedit/admin/plugin-central-submission/options.
    Or, if this is a mailing list, you can unsubscribe from the mailing list.
    --
    
    jEdit Developers' List
    jEdit-devel@lists.sourceforge.net
    https://lists.sourceforge.net/lists/listinfo/jedit-devel
    
    --
    
    jEdit Developers' List
    jEdit-devel@lists.sourceforge.net
    https://lists.sourceforge.net/lists/listinfo/jedit-devel
    
    --
    Conal Tuohy
    http://conaltuohy.com/
    @conal_tuohy
    +61-466-324297
    
    Related
    
    Plugin Central Submission: ~~#1055~~
    
    alternate
    
    If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Eric Le Lay - 2020-05-31

assigned_to: Eric Le Lay
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Hi Conal, Dale,

here is what I need to release, taking the small Geo plugin as an example:

packages> tar tf Geo-1.0.0-bin.tgz 
Geo.jar
simplify.jar
wktparser.jar
packages> tar tf Geo-1.0.0.tgz 
Geo/docs/
Geo/lib/
Geo/src/
Geo/src/com/
Geo/src/com/kpouer/
Geo/src/com/kpouer/jedit/
Geo/src/com/kpouer/jedit/geo/
Geo/src/com/kpouer/jedit/geo/wkt/
Geo/Geo.props
Geo/actions.xml
Geo/build.xml
Geo/description.html
Geo/docs/Geo.html
Geo/ivy.xml
Geo/lib/wktparser-1.0.0.jar
Geo/services.xml
Geo/src/com/kpouer/jedit/geo/GeoPlugin.java
Geo/src/com/kpouer/jedit/geo/wkt/DoublePoint.java
Geo/src/com/kpouer/jedit/geo/wkt/WellKnownTextSidekickParser.java
Geo/src/com/kpouer/jedit/geo/wkt/WktPointExtractor.java
Geo/src/com/kpouer/jedit/geo/wkt/WktTools.java
Geo.jar
simplify.jar
wktparser.jar
packages> unzip -l Geo-1.0.0.zip 
Archive:  Geo-1.0.0.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
        0  2020-04-22 19:15   Geo/
        0  2020-04-22 19:14   Geo/docs/
        0  2020-04-22 19:14   Geo/lib/
        0  2020-04-22 19:14   Geo/src/
        0  2020-04-22 19:14   Geo/src/com/
        0  2020-04-22 19:14   Geo/src/com/kpouer/
        0  2020-04-22 19:14   Geo/src/com/kpouer/jedit/
        0  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/
        0  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/wkt/
     1014  2020-04-22 19:14   Geo/Geo.props
      202  2020-04-22 19:14   Geo/actions.xml
     1085  2020-04-22 19:14   Geo/build.xml
       61  2020-04-22 19:14   Geo/description.html
     1163  2020-04-22 19:14   Geo/docs/Geo.html
      420  2020-04-22 19:14   Geo/ivy.xml
    33546  2020-04-22 19:14   Geo/lib/wktparser-1.0.0.jar
      237  2020-04-22 19:14   Geo/services.xml
     1472  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/GeoPlugin.java
     1047  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/wkt/DoublePoint.java
     3879  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/wkt/WellKnownTextSidekickParser.java
     1446  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/wkt/WktPointExtractor.java
     2505  2020-04-22 19:14   Geo/src/com/kpouer/jedit/geo/wkt/WktTools.java
     9558  2020-04-22 19:14   Geo.jar
    10482  2020-04-13 15:55   simplify.jar
    33546  2020-04-22 19:14   wktparser.jar
---------                     -------
   101663                     25 files
packages> unzip -l Geo-1.0.0-bin.zip 
Archive:  Geo-1.0.0-bin.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
     9558  2020-04-22 19:14   Geo.jar
    10482  2020-04-13 15:55   simplify.jar
    33546  2020-04-22 19:14   wktparser.jar
---------                     -------
    53586                     3 files

Any way to produce them automatically would be nice

Last edit: Eric Le Lay 2020-06-01

Conal Tuohy - 2020-06-17

Hi Eric!

I've tried to follow the point of your example.

I am assuming that the actual requirements for deployment to Plugin Central are:

A tgz file containing the source code tree, named {plugin-name}-{version}.tgz

A zip file containing the source code tree, named {plugin-name}-{version}.zip

A tgz file containing the binaries, named {plugin-name}-{version}-bin.tgz

A tgz file containing the binaries, named {plugin-name}-{version}-bin.tgz

I only put only 1 jar file (i.e. TEI.jar) into the binary packages, since the only jars which the TEI jar depends on are themselves jEdit plugins which the TEI plugin is marked as depending on.

To generate the four package files, I have added a 'package' target to the TEI plugin's build.xml file which writes the 4 archive files into a 'dist' directory.

Do I have that right?

I also took your advice to update the required jEdit version to 5.5, and the required Java version to 8.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Eric Le Lay - 2020-06-17

Yes: I can release it now (tried your latest master).
Just make a tag (doesn't have to be = to the the version)...
Thanks,

Last edit: Eric Le Lay 2020-06-17

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- Conal Tuohy - 2020-06-19
  
  Thanks Eric!
  
  I've added the tag 1.4.1
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
  - Eric Le Lay - 2020-06-21
    
    Thanks,
    released to plugin central (will show up soon in jEdit plugin manager).
    It'll be in the HTML&XML category.
    http://plugins.jedit.org/plugins/?TEI
    
    If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Conal Tuohy - 2020-06-19

Last edit: Conal Tuohy 2020-06-19

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Eric Le Lay - 2020-06-21

status: open --> closed-accepted
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

TEI

jEdit is a programmer's text editor written in Java.

Group

Searches

Help

#1055 TEI

Related

Discussion

Related

Related