search

asciidoctor / asciidoclet

:clipboard: A Javadoc Doclet based on Asciidoctor that lets you write Javadoc in the AsciiDoc syntax.
https://github.com/asciidoctor/asciidoclet
Apache License 2.0
133 stars 40 forks source link

Renamed package and other updates #2

Closed johncarl81 closed 11 years ago

johncarl81 commented 11 years ago

@mojavelinux, can you review this? Is this what you expected package wise (both java and maven). Also, should we spell AsciiDoclet with capital A and D?

johncarl81 commented 11 years ago

Thinking about it more, Im thinking "Asciidoclet" with just a capital A may be more in line with Asciidoctor's naming.

mojavelinux commented 11 years ago

I just spoke with my in-house content strategist (i.e., Sarah) and here's what she proposes:

Project name: Asciidoclet Group Id: org.asciidoctor Artifact Id: asciidoclet Java package name: org.asciidoctor.doclet Java class name: Asciidoclet

By using the lowercase "d", we preserve "AsciiDoc" as a proper noun so it's very clear when we are talking about the syntax and when we are talking about the applications in the pipeline.

The last one might be the most surprising. Her reasoning here was that "doclet" describes the function of the package. There is already a brand name in the org.asciidoctor, so having the secondary brand name in the java package is too heavy.

However, if you like org.asciidoctor.asciidoclet for the package name better, I won't push back on it.

mojavelinux commented 11 years ago

Once this issue is resolved, let's move forward with moving the repo and cutting a release. If you need assistance, don't hesitate to ask. Also, we're hanging in the #asciidoctor channel on freenode IRC if you need a real time chat.