Contributing Guidelines
These are incomplete guidelines for contributing or improving articles on The Berean Archive.
Source Code
The entire site's source code, including all articles, is published on GitHub. If you'd like to correct, improve, or add new content, contact us and send a pull request.
Articles can be written in either html (with a little bit of php to help) or in Markdown, with the latter being the preferred format for new articles. Markdown files are
automatically converted to html on page load, via the .htaccess
and md2html.php
code
files in the root of the site. Typora is a decent and free editor for Markdown Files and supports most features used.
HTML tags can be embedded in the .md files to go beyond features supported by Markdown.
Examples
The HIV Evolution article is the most up-to-date example that conforms to this specification. Some other articles don't yet conform because they were written prior to this specification.
Article Format
Except where it otherwise doesn't make sense to do so, most articles should use the following layout:
Layout
- Large image header
- Meta info: authors, created, modified, history
- Summary with short list of key points.
- Detailed Points 1..N
- Common Objections
- Issues and Unanswered Questions (if applicable)
- Further Reading
- Related Articles
- Footnotes
More detailed sub-points can be summarized in one article with a link to a more detailed article. Likewise with large blocks of supplemental information.
Writing Guidelines:
- Make ample use of tables, lists, charts, and images to summarize information and to make article more readable.
- If possible, embed javascript tools to try out calculations or show adjustable graphs.
- Within articles, use either citations inline or shortened versions of quotes. Include or link to full quotes in sources.
- NRSV should be the first choice for bible citations, since it is most commonly cited in academia.
Citations
Berean Modified MLA Rules
The main goal of citations is to make it easy to find and very sources. The Berean Modified MLA citation format is based on MLA version 8, with modifications are made to replace less helpful information with the more helpful:
Omissions:
- Website name and publisher may be omitted if they are not significant.
- Access dates may be omitted for brevity.
- Since all journal articles names should be a link to their source, volume and issue numbers may be omitted.
- Words like "web" and "print" should be omitted--including page numbers indicates the source was originally in print.
- Long article names may be abbreviated, or subtitles omitted.
Dates:
- Format dates as Feb 7, 2005 since it's more conventional.
Links and Pages:
- Any online content should have its title link to it source. If page numbers, or audio/video seek time can be linked, they should be linked instead.
- All longer audio and video sources should include the minutes and seconds, linked if possible. E.g. "At 2:23 " or "2:34 to 4:36 and 8:15 to 8:39"
- Page numbers should be preceded by the word "Page" or "Pages".
- Page numbers can be suffxed with a parenthetical note to find the specific place on the page. E.g. (2nd column, top left).
- Closed-source journal article titles should link to the most official source available, such as the journal's website or ncbi.nlm.nih.gov, even if the source only includes the abstract. If arXiv.org or someone else has a full source PDF published on their blog, it can be listed in the mirrors.
Citing Sources:
- "Ibid." should be replaced with list sub-items with a page number and at least some of the relevant text quoted.
Miscellaneous:
- Use two spaces after each period to improve readability.
- Since sites sometimes shut down, include mirror links in the comments, such as archive.org, archive.is, a screenshot of the source, or a local copy of the source in its entirity, if fair use allows it.
Berean Modified MLA Examples
Here are several examples of what article citations should look like:
Website Examples:
Book Examples:
Journal Examples:
Video Examples:
Forum, blog, or newsgroup comment:
Based on the guidelines here.
Additional calculations without an external source:
TODO
File organization
Articles live in the articles
folder, which is organized by scholarly disciplein (biology, history, etc).
Naming conventions for locally mirrored sources (pdfs / images / html pages)
- lastname-article-title-year-pages-23-25.png
- username-forum-thread-title-website-year.html