- Notifications
You must be signed in to change notification settings - Fork1
A pages collection engine for the Pippo Java Micro Framework. It is loosely inspired by Poet.
License
NotificationsYou must be signed in to change notification settings
rygel/fragments
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A pages collection engine for thePippo Java Micro Framework. It is loosely inspired byPoet.
- Markdown files with JSON or YAML Front Matter
- Global or local (per file) template definitions
- Global and local (per file) Context
- Invisible Pages (e.g. drafts)
- Generation of preview texts
- Support of multiple languages
- Categories and Tags
- Expiring files
- Save the access statistics of the Fragments into a DB
- Supports obfuscation of email addresses viaflexmark-java (in the Markdown files) as well as directly via the default context.
- Has a dynamic context, which is used to dynamically inject information during each call to a route.
I have often the case that I want to display collections of data with Pippo, e.g. a list of articles, a list of events, etc.For this I have created Fragments. It holds all markdown files and creates routes for them in Pippo.
Configure fragments.
Fragmentsfroot =newFragments(this,"Root","/",currentPath +"/data/fragments/root","","static_page",defaultContext,configuration);
Example of an Markdown file.
---title : My First Eventslug : first-eventtemplate : eventdate : 2017-01-12T12:12preview : order : visible : false---This is the first event using Fragments.| Property | Type | Default value | Description |
|---|---|---|---|
| content | String | "" | The textual content of the fragment. If the fragment contains multiple languages, it contains the content of the current language. |
| date | String | "" | The date(time) of the Fragment. It's pattern is "yyyy-MM-dd['T'HH:mm]". So either 2018-01-02 or 2018-01-02T10:11. |
| defaultLanguage | String | "" | The default language of the fragment. |
| fullUrl | String | The full URL. | The full URL of the fragment, the concatenation of protocol, domain, fragments.baseURL and fragment.url. |
| fullUrlEncoded | String | The full encoded URL. | The full URL of the fragment, the concatenation of protocol, domain, fragments.baseURL and frgment.url encoded to be used as a parameter for Facebook or Whatsapp sharing. |
| languages | TreeMap | The list of languages as defined in Pippo. | |
| languagesPreview | TreeMap | The list of all preview texts of the contents in the different languages. | |
| languagesTitles | TreeMap | The list of all content texts in the different languages. | |
| name | String | The Fragments name | The name of the Fragments class this Fragment belongs to. |
| order | int | autoincrement | The order of the fragments. Can be defined via front matter. If not defined via front matter, than it is autogenerated based on alphabetic ordering of the fragment's titles. |
| preview | String | "" | The preview of the textual content of the fragment. If the fragment contains multiple languages, it contains the preview of the current language. |
| previewTextOnly | String | "" | The preview of the textual content of the fragment (in the current language) without HTML tags. |
| slug | String | The slug. | The slug of the fragment. Either defined via the front matter or autogenerated. |
| template | String | via front matter | The template for the fragment. Defined via front matter. Can overwrite the definition via Fragments on a per fragment basis. |
| title | String | via front matter | The title as defined via front matter. If the fragment contains multiple languages, it contains the title of the current language. To be implemented! |
| url | String | The baseUrl + the slug. | The base URL + the slug of the fragment. |
| visible | boolean | true | Defines if the fragment is visible or not. Default value in Java is false, which will automatically overwritten with true, if it is not defined in the front matter. For usability purposes it can be seen as defaulting to true. |
- preview tag inside of front matter
<!--more-->tag inside the content. Can be written as either<!--more-->, <!-- more -->, <!-- more-->, <!--more -->.
Is used to configure the following properties of a Fragment:
| Property | Type | Default value | Description |
|---|---|---|---|
| domain | String | "" | The domain of the website, e.g. example.com |
| dynamicContext | DynamicContext | null | Accepts a class implementing the DynamicContext interface. Is intented to be used to update the context during the execution of a program. Otherwise the context will be static over the runtime of the application. |
| extension | String | ".md" | The extension of the markdown files. |
| protocol | String | "https://" | The protocol of the website. Used for constructing the fully encoded URL. |
| registerOverviewRoute | boolean | true | When set to false the route for the baseURL will not be automatically be registered. This allows to create that route manually with total control. |
| routeType | RouteType | RouteType.ARTICLES | The route type of the Fragments object. Defaults to ARTICLES, but can be changed to Blog, which will include the date into the URL, e.g. /2017/01/14/slug. |
Rationale: Imagine you want to display the current date on the website. For this you have to include it in the context of theroute which is displayed. For routes created by Fragments you have to define a DynamicContext and add it to the Configuration class.Then the Dynamic Context will always be executed once one of the routes of this fragment is requested.
- pippo-core to be able to automatically generate the routes.
- flexmark-java as a markdown parser.
- SnakeYaml as a YAML (front matter) parser.
- Fast JSON as a JSON (front matter) parser.
- Apache Commons IO for convenience file name handling.
- SLF4J as a logging adapter.
- Logback as the logger implementation.
About
A pages collection engine for the Pippo Java Micro Framework. It is loosely inspired by Poet.
Topics
Resources
License
Stars
Watchers
Forks
Packages0
No packages published