taverna-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gale Naylor <Ga...@noventussolutions.com>
Subject Re: Draft download pages
Date Thu, 12 May 2016 23:59:51 GMT
Thanks for the blast-from-your-past, Stian. Too bad I can't read Norwegian!
I speak a little German, so I'm familiar with compound-word-isms. ;-)

Deciding how to hyphenate and capitalize Command-line Tool turns out not to
be a trivial issue. I spent some time today looking into this. (If you're
really interested, I wrote a blog post, too: http://bit.ly/1TS7YXi)

------------------------------------
Documentation
------------------------------------
As Stian noted, both command line and command-line can be found. After some
thinking, this is what I propose for the documentation (README files and
website).

Use Taverna Command-line Tool when talking about the tool and in titles.
For example, Taverna Command-line Tool (as a title)
or “The Taverna Command-line Tool relies upon …” (in a sentence).

Use all lower case (command-line tool) when talking about generic
command-line tools.
For example, “The Taverna Command-line Tool is one of two command-line
tools…”

Other acceptable ways of referring to the Taverna Command-line Tool (and
variations) would be:
     Command-line Tool
     Apache Taverna Command-line Tool
     Apache Taverna Command-line product

Avoid:
    Taverna Command-line (always use “Tool”)
    Taverna Command line Tool (always hyphenate)
    Taverna Command Line Tool (always hyphenate and use lower case “l”)

------------------------------------
Changes to git repo/groupId?
------------------------------------
As far as the GIt repo and groupId names for the Command-line Tool are
concerned,
I agree that keeping "commandline" as one word in the repo, groupId, and
artifacts looks cleaner.

In looking at the repo names and pom.xml files, I wonder if it is
reasonable to change the following:

incubator-taverna-common-activities
     --> groupId to org.apache.taverna.common.activities

incubator-taverna-commandline
     -->   name to Apache Taverna Command-line

incubator-taverna-workbench-common-activities
     -->   groupId to org.apache.workbench.common.activities
     -->  artifact to apache-workbench-common-activity

I don't know how difficult it is to manage all the relationships, but it
would be nice if these were consistent.

------------------------------------
Question
------------------------------------
incubator-taverna-workbench-product has the same groupId as
incubator-taverna-workbench. Is this correct?

To quote Ian, Cheers!

Gale

On Thu, May 12, 2016 at 3:18 AM Stian Soiland-Reyes <stain@apache.org>
wrote:

> On 10 May 2016 at 01:03, Gale Naylor <GaleN@noventussolutions.com> wrote:
> > Is there a difference between "Taverna Command Line Tool" and "Taverna
> > Command Line"? It seems sometimes on the download page we use one term
> and
> > sometimes we use the other term. For example,
>
> No difference - just my Norwegian compound-word-ism sneaking in! We
> would say "Taverna Kommandolinjeverktøy" - rolls off the tongue..
>
> { https://wiki.ucl.ac.uk/display/ScanStuds/Norwegian+Compounds
>   And in fact in my teenage years I was an active campaigner to remind
> Norwegians to write compound words correctly and not pretend it's
> English - from a 1997 newspaper:
> http://soiland-reyes.com/stian/scrap/lausslept.png
>   (Sorry, we didn't have perma-urls back then..)
> }
>
>
> Notice that the git repository is "incubator-taverna-commandline", our
> groupID is "org.apache.taverna.commandline", artifactIds are
> "taverna-commandline-api" etc, and the download would be called
> apache-taverna-commandline-3.1.0-incubating.tar.gz  -- I thought it
> would be nice if those "code names" had consistent hyphenization --
> and for me this is good to avoid the hierarchically more confusing
> "taverna-command-line-api".
>
> However we also have "incubator-taverna-common-activities" with
> groupId org.apache.taverna.commonactivities!
>
> Changing git repo names I think CAN be done at this point - probably a
> bit of a hazzle for Infra to keep the GitHub link ; if we want to
> change group/artifactIds we should decide on now before we do the
> first release.
>
>
>
> However the English title we can be more liberal with (but yes,
> consistent) - just like
> https://taverna.incubator.apache.org/download/osgi/ describes the
> "Apache Taverna OSGi plugin system " rather than the misleading
> "Apache Taverna OSGi".
>
> https://en.wikipedia.org/wiki/Command-line_interface uses the spelling
> "command-line interface", but the spelling "Command line" is also ver
> common - but in my view does not read very well in further
> combinations, after all we don't provide a "Line tool".
>
>
> Which English title one should it have? Perhaps "Taverna Command-Line
> Tool" ? Weird?
>
> We've got several native English speakers here from 3 different
> continents - what are your views?
>
>
>
> > I made some minor edits to the three download pages. I changed the title
> of
> > the command line page to say "Download" and match the other two pages.
>
> Thanks!
>
>
> --
> Stian Soiland-Reyes
> Apache Taverna (incubating), Apache Commons RDF (incubating)
> http://orcid.org/0000-0001-9842-9718
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message