Download the PHP package 8fold/commonmark-abbreviations without Composer

On this page you can find all versions of the php package 8fold/commonmark-abbreviations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package commonmark-abbreviations

8fold Abbreviations for CommonMark

This library is an extension for the CommonMark parser from the PHP League adding abbreviation syntax and rendering to Markdown.

Warning: This text is written using that syntax enabling extension testing; therefore, it will most likely not render as intended without a rendering extension using this syntax.

Installation

Usage

2.1.0 to 3.0.0

Becomes:

You MAY also use the syntax prior to 2.1.0.

2.0.0 and before

Becomes:

The syntax

Inspired by the link syntax - []() - and the footnote syntax in the extension from MultiMarkdown - [^].

The syntax is a square bracket followed by a period or dot: [.]().

Just like the footnote indicates superscript, the abbreviation syntax was found to indicate shortening to more people than previously proposed options. Placing the dot inside the opening square bracket allows the abbreviation to exist next to other glyphs as opposed to forcing empty space. (A conversation in the CommonMark .Spec board was also referenced, and informative.)

Given the traditional use of the abbr tag commonly combined with the title attribute, the link syntax makes sense as the a tag combines inner text with href and the img tag uses two attributes, src and alt to be valid and accessible.

Replace-all .vs. inline

We decided to go with inline, single instance over footer, replace-all.

Two main options exist for implementing this capability.

The first is to place the abbreviation and definition at the bottom of the document and render all occurrences of the abbreviation with the abbr element and title. The drawback here is possible impact to readers using [.AT](Assistive Technology) like screen readers; potentially being read the full abbreviation each time.

The second option is to have the abbreviation be inline with the surrounding text. The drawback here is the need to write more each time an author uses the abbreviation.

This library looks at Markdown as being a way of writing potentially rich-text documents first, which can be transformed into [.US](United States) Plain Language Guidelines is to avoid abbreviations and acronyms in general and specifically to:

As a document editor and author, I tend to recommend defining "first use" as "first use per section," where "section" is further defined as beginning with a header; so, if writing a 20 page document and an abbreviation is defined on page one, it's poor [.UX](user experience) to require a reader on page 20 to turn back to page one to jog their memory of the abbreviation's definition. This also speaks to the definitions being at the end of the document, similar to a glossary.


All versions of commonmark-abbreviations with dependencies

PHP Build Version
Package Version
Requires php Version ^7.2|^8.0
league/commonmark Version ^2.0.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package 8fold/commonmark-abbreviations contains the following files

Loading the files please wait ....