taeluf/stories

v0.1.x-dev 2022-04-17 07:42 UTC

Requires

• taeluf/liaison: v0.5.x-dev
• taeluf/liaison.common-mark: v0.3.x-dev

Requires (Dev)

• taeluf/code-scrawl: v0.8.x-dev
• taeluf/tester: v0.3.x-dev

MIT

README

Backend software for writing journalistic stories & easily sharing your stories.

This is brand new, beta software & the documentation is poor & implementation details will change.

Install

composer require taeluf/stories v0.1.x-dev   

or in your composer.json

{"require":{ "taeluf/stories": "v0.1.x-dev"}}  

Getting Started

You make a Stories directory, then in that make a dir for each story you write. Then for each story, you'll need to instantiate a story object ... for now.

Sample deliver script

<?php  
  
require(__DIR__.'/../../vendor/autoload.php');  
  
$lia = new \Lia();  
  
$main = \Lia\Package\Server::main($lia);  
  
  
$cmark = new \Lia\Addon\CommonMark($main);  
$story = new \Tlf\Story(__DIR__.'/Stories/sample1/', $lia, '/sample1/');  
$story->cmark = $cmark;  
  
  
// $lia->dump();  
  
  
  
$story->setup();  
  
// $stories = new \Tlf\Stories();  
// $stories->enable_lia($lia, '/stories/');  
//  
// $stories->add_dir(__DIR__.'/Stories/');  
  
  
$lia->deliver();  

See the rest of the story files in test/Server/Stories/sample1/

Stories/sample1/story.php:

<?=$this->toc();?>  
  
<?=$this->story('main');?>  
  
<?=$this->story('background');?>  
  
<?=$this->story('inline-image');?>  
  
<?=$this->details('terms', 'Terminology');?>  
  
## File Downloads  
See [File Downloads](files/)  
  
<?=$this->sources()?>  

Stories/sample1/story/main.md:

# Title  
This story isn't about anything at all. It's literally not about anything.