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

Current state of work on CLUS, January of 2018 #34

Open
KZiemian opened this issue Jan 3, 2018 · 0 comments
Open

Current state of work on CLUS, January of 2018 #34

KZiemian opened this issue Jan 3, 2018 · 0 comments

Comments

@KZiemian
Copy link
Collaborator

KZiemian commented Jan 3, 2018

This is best description of CLUS collaboration plans about CCLDoc add-ons that I can write. By no mean they is canonical list, I just collected and organized things about I talk and heard from wiser than me in CLUS matters folks. Also I don't know how realistic some points are or how much work to do it will be needed trying to realized it. I still try to fully understand my thread of work.

If someone need more information try contact community of CLUS on freenode #lisp, or Discord #clus-general. You can also read paper staying CLUS reason to be and aims. Unfortunately this paper is much outdated https://github.com/phoe/clus-data/blob/master/paper.pdf.

IMPORTANT
Statement of CLUS community now is: Content is a king! So now we are interested with creating web pages that have good CL content, giving it good look is not issue now. Because I have little idea how make web page look good, I decide do disregard this issue totally.

What we need to do with CCLDoc.

Create new tags for things like variable references, glossary entries, code blocks, diffrent kinds of result values, etc.
EXAMPLE
We want write something like
"Function {:cl:functions:some-function}"
which will expand to proper hyperlink to page with some-function.
We want create functions
(load-graph *SOMETHING*)
(output-graph *SOMETHING* "somewhere")
which creates not single HTML, but bunch of HTML pages hyper-linked with each others. This is connected with previous point, we want that all new defined tags expand in proper hyperlinks in this step.
To make former works, we need to define new class, call it GRAPH-DOCUMENT for now, that is related to class DOCUMENT in some not precised now way.
What we are doing now. There are two threads.

Create some proof of concept CCLDoc file (probably "Function GENSYM") that will used desired tags, which after we need to create.
a) Dig up into CCLDoc code enough to make creation of all add-ons possible.
b) Create documentation of code that we understand as side effect of point a).
Unfortunately I now only person that works on second thread. Time will show what I can do in current situation.

If English of this post is bad, give me a sign, I try to correct it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant