Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhanced and localized description #226

Open
tristanlins opened this issue Oct 12, 2014 · 2 comments
Open

Enhanced and localized description #226

tristanlins opened this issue Oct 12, 2014 · 2 comments
Assignees

Comments

@tristanlins
Copy link
Contributor

Currently there is only an english short description in the composer.json. We need the ability to define a complex description and localize it.

I would prefer to write docs in the repository, like:

README.de.md
README.de_DE.md
README.md

We could search for the language specific file, render it and show it in the backend.
The path/file could be configurable within the composer.json:

{
  "extra": {
    "contao": {
      "detailed-description": "README.{language}.md"
    }
  }
}

The pattern README.{language}.md could be the implicit default, an alternative pattern could be:

{
  "extra": {
    "contao": {
      "detailed-description": "docs/description.{language}.md"
    }
  }
}

As file formats we could support:

  • *.md rendered as GFM
  • *.rst rendered as standard reStructuredText (rendered with an online renderer or a PHP Library)
  • *.html rendered as plain HTML
  • *.txt rendered as plain text

We should also rethink about composer/composer#1954

@tristanlins tristanlins self-assigned this Oct 12, 2014
@tristanlins tristanlins added this to the 1.3 stable "details view" milestone Oct 12, 2014
@leofeyer
Copy link
Contributor

+1

I'd prefer *.md, because we can render GFM via PHP in the back end.

@tristanlins tristanlins modified the milestones: 1.8 stable "localisation", 1.3 stable "details view" Oct 12, 2014
@tristanlins
Copy link
Contributor Author

Conflict with #41

@discordier discordier removed this from the 1.8 stable "localisation" milestone Feb 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants