search

sile-typesetter / sile-typesetter.github.io

Github Pages source code for https://sile-typesetter.org
Creative Commons Zero v1.0 Universal
3 stars 4 forks source link

Suggest more examples on SILE homepage #2

Open shreevatsa opened 7 years ago

shreevatsa commented 7 years ago

This is my first time looking at SILE, and I am excited, because of this line in the manual:

it contains a slavish port of the TeX line-breaking algorithm which has been tested to produce exactly the same output as TeX given equivalent input

(and more importantly I even see the box-glue-penalty model with similar parameters like penalty=-10000).

Knuth always intended others to take his ideas and programs and write new programs (that's why he published all his TeX work as papers, and even the entire source code as a book in readable form), and it's nice to see that someone's actually doing it seriously finally.

But what are some purposes that SILE has been used for (other than by its author), or examples of what SILE could be used for? I wasn't able to satisfy my curiosity about this from the homepage. Looking around in the Github repo, I was able to find a few examples at https://github.com/simoncozens/sile/tree/master/examples . For example, this one is quite interesting to me: https://github.com/simoncozens/sile/blob/master/examples/parallel.pdf

Most people grasp things best by examples, so my humble suggestion would be to put as many examples as possible (images and SILE source code) on the homepage. It might attract more users…

shreevatsa commented 7 years ago

(BTW it seems that sile-typesetter.org is served via Github pages. Note that Github now lets you serve pages from a docs/ directory in the master branch (instead a separate gh-pages branch), so this should be even easier to do than it would have been earlier…)

simoncozens commented 7 years ago

Nice, I did not know what - thank you! I will try to work on this.

In general book design isn't very showy and that's kind of the point; I think that if the layout engine is drawing attention to itself, it's failing. So for me boring examples are good examples! I'm not actually very good at coming up with examples that might draw in users.

But I agree that the parallel (and even the triglot) examples are compelling and I'll put them up. If people can suggest other compelling examples, I'll be glad to add them.

alerque commented 7 years ago

I agree more examples would be a good thing, but exhibiting specific features and full spectrum ones that show how it can be all brought together. For example book layouts may be boring but having an example of everything pulled together could be good.

On the website note, I'm not a big fan of hosting website code inside the code repository. Git offers advantages to granular repository layouts that get lost whet you just shovel everything under one roof. The /docs folder thing could work if we were offering Markdown formatted API documentation (such as a replacement for documentation/sile.sil) that should track the versions (so that when you checkout a version of the source you get matching docs. Github's hosting can be useful for rendering something like that, but I don't think the SILE website fits this model. It should be developed independently from SILE itself.

If having access to it while still having a SILE development branch checked out is an issue, git worktree can check out a branch into a folder. There should already be no excuse for it being "hard" to do on account of being in an independent branch.

the42 commented 7 years ago

related sile-typesetter/sile#343

alerque commented 2 years ago

Just a note, it is now much easier to add new examples. They no longer need to be in the SILE source repository, they just live in this website code repository. There is also no need to build the PDFs or generate thumbnail images for them, this is all done automatically. This should free up the cadence so we can add and tweak them much more freely.

Contributions welcome.