reddaiahece / asciidoc

Automatically exported from code.google.com/p/asciidoc
GNU General Public License v2.0
0 stars 0 forks source link

Added mention of other file extensions #13

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
As discussed on the mailing list .. adding .adoc, .asc and .asciidoc as 
supported by github.

Original issue reported on code.google.com by mosa...@gmail.com on 27 Nov 2012 at 10:34

Attachments:

GoogleCodeExporter commented 9 years ago
I'd also like to throw in my vote for .ad, which I hope becomes the defacto 
standard extension (for those not using .txt). I think .ad is a good choice for 
these reasons:

* it parallels the extension of Markdown (.md), arguably the most widely used 
lightweight markup language
* it's short (unlike .asciidoc, which is just absurdly long)
* it doesn't conflict with known extensions (.asc for instance is used for 
several file types, one of which is a PGP armored file)

I understand the arguments for recommending the .txt extension, because just 
about any OS knows that's a text file. However, I would augment that point by 
recommending the use of a double extension (e.g., *.ad.txt or *.adoc.txt). That 
way, at least there is *some* indication that it's an AsciiDoc file. Otherwise, 
it's *really* hard to search for AsciiDoc files (which is often necessary in 
code repositories).

Original comment by dan.j.allen on 7 Jan 2013 at 11:50

GoogleCodeExporter commented 9 years ago
Also, I think it's important that we narrow down the options a bit or else, 
again, it becomes hard to find AsciiDoc files.

If we had to stick with two recommendations, I'd go with .ad and .adoc (with or 
without the .txt suffix).

(Personally, I find .txt alone to be way too vague).

Original comment by dan.j.allen on 7 Jan 2013 at 11:53

GoogleCodeExporter commented 9 years ago
To be clear, I don't think we should recommend the .asc extension. On Linux, at 
least, it identifies itself as a PGP file.

Original comment by dan.j.allen on 7 Jan 2013 at 11:55

GoogleCodeExporter commented 9 years ago
I do like asciidoc personally because it is about as explicit (and therefore 
obvious to ANY users) as it gets and these days a long filename (or extension 
.. remember 8.3 ;-) should not be a problem. Whatever we decide I think we need 
more than txt and the project should suggest a limited number of preferred 
options. I quite like ad as a short version as well. Maybe we end up with .ad, 
adoc and .asciidoc. That would be fine imho.

Original comment by mosa...@gmail.com on 10 Jan 2013 at 5:27

GoogleCodeExporter commented 9 years ago
I'm in favor of .ad, .adoc and .asciidoc. That seems like a really good set 
that appeals to the preferences of authors at each end of the spectrum. (Now we 
just need to get GitHub to honor .ad).

Original comment by dan.j.allen on 10 Feb 2013 at 10:06

GoogleCodeExporter commented 9 years ago
It seems we agree Dan ;-)  Luckily github rendering is working again. Now we 
just need to send a pull request for .ad support. But I assume you did that 
already.

Original comment by mosa...@gmail.com on 12 Feb 2013 at 7:21