[OPEN-ILS-DOCUMENTATION] New Docs file extension? (.asciidoc or .adoc)

[Lynn Floyd]

+1 for the use of .adoc.

 

I use the .adoc extension as it is a reminder to me what language I am
writing in.  As a Windows Notepad++ user this also allows the syntax to
show, which is very valuable when writing.

 

 

 

Lynn Floyd 
 <mailto:lfloyd at andersonlibrary.org> lfloyd at andersonlibrary.org 
Anderson County Library 
864-260-4500 x181 
 <http://www.andersonlibrary.org/> http://www.andersonlibrary.org 
  

 

From: OPEN-ILS-DOCUMENTATION
[mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf
Of Remington Steed
Sent: Friday, June 19, 2015 9:35 AM
To: Documentation discussion for Evergreen software
Subject: [OPEN-ILS-DOCUMENTATION] New Docs file extension? (.asciidoc or
.adoc)

 

Hi DIG,

 

At a DIG meeting on March 5th in IRC, we discussed changing all of our doc
files from "NAME.txt" to "NAME.asciidoc" (or "NAME.adoc").  The main benefit
of this would be that GitHub would recognize these as AsciiDoc files and
would auto-render them as HTML in the browser.  Hopefully this would make it
easier for editors to check their work before submitting it.  Here is a
summary of our discussion from that meeting:

 

.         Pro: Would make editing/writing docs on GitHub more friendly

.         Con: Would make editing files on local computer less friendly (if
text editor doesn't know .adoc extension, but most editors can be easily
configured for this)

.         Shouldn't cause any problems with the automatic HTML conversion

 

Do you support this change?  Which extension: .asciidoc or .adoc?  Do you
have any questions or concerns?  If we decide to move forward, the change
could be made easily, any time, and as a single Git commit.  And we could
test the nightly conversion process using the master (i.e. dev) branch
before applying the change to the 2.8 and 2.7 docs.

 

Please voice your opinions!

 

Remington

 

--

Remington Steed

Electronic Resources Specialist

Hekman Library, Calvin College

http://library.calvin.edu/

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20150623/40d207b8/attachment.html>