12 posts tagged with "beginning"

Finally, I can announe that the beta version is out!

This is what I updated since last time:

• Parsed again all the specification to account for missing/overwritten pages because of similarly named items.
• Added glossary definition tooltips everywhere I could (programatically, we can add more by hand by identifying any place missing a definition).
• Added all the links of "See Also" and any time something is referenced in the text of the specification, the link for that item should now be working.
• Added a lot of code blocks for example sections to provide syntax highlighting. Not all of the code in the reference is inside a code block, but most of them are. The rest most be parsed manually.

Enjoy!

Definitions Tooltip​

I made a react component tooltip for definitions to show you the definition of a term in place instead of a having to navigate to the glossary page. In addition, the same tooltip will link to the proper dictionary item if it exists, and if not, to the glossary page of the term. We still need to add the component all around, but this should make the functionality of the page much better. Here's an example: See the "forms" word in section 6.1.1.1 of Loops

Dictionary Pages​

There are a bunch of dictionary pages that did not get split correctly, so instead of showing up as a different page, they are part of another page. I've been checking them manually (a lot of work) and have made a list of about half the chapters. The rest need to be checked. I hope to make a script to help splitting a lot of these pages. Please help identifying the pages in the missing chapters as they are marked.

Code Blocks Indented​

Good news, now the code blocks look even better! I indented them using the emacs indentation so it follows the conventional indentation. Changes made to 414 files :D

Enjoy!

Glossary Improved​

The glossary has now:

• Been split into multiple pages, one per letter
• The legend and introduction have their page
• A lot of the text was fixed for formatting issues, this was the bulk of the work

Finally, we are at Alpha, version 1.0 is out!​

As of today, 2023/12/06 the Alpha version of the technical reference is out.

These are a few of the improvements since last time:

• Complete Specification Update: There were parts of the spec missing because of an issue of files getting truncated before they were converted into markdown. I have now recovered the truncated parts, parsed them, and added them to the specification
• A large amount of code now shows up in code blocks with syntax highlighting.
• A lot of symbols like →, ≡, and a few others are now properly displayed
• The Index, Figures, and Credits were parsed to be displayed properly per the original
• The search index was updated to account for the new content
• A bunch of formatting issues for the markdown to be displayed properly

What Alpha version means​

• Now we are finally open to contributions of examples and added explanation
  • Contribution stubs were added at the end of Dictionary Items type pages see for example progn
• The main text is unlikely to change much except for:
  • Minor formatting issues
  • Maybe there are still some symbols that are not rendering properly
  • Code Blocks for syntax highlighting in the non dictionary type pages have not yet been added
  • Tables have to be formatted
• Therefore we are open to other contributions that are more meaningful in terms of content and development, please see our To Do Page for how you can contribute!

Dicionary Sections​

As of now, 2023/12/03, all the dicionary pages have been broken up into their particular directories with a page per entry.

However there are still a few that need to be manually fixed because of problems with parsing the text with regex for certain exceptions.

Nevertheless, this improves the search results dramatically! The reference should now be much easier to use!

I also added a Dicionary Item's To Do Page for adding specific examples.

Cheers!

Search for the Technical Reference​

Search for the Technical Reference has now been implemented! Please try it with Ctrl+K or CMD-K and enjoy! 😄

Home Page Updates​

We also updated the Home Page content.

Code Blocks​

The current status is that for some reason replacing the code with lisp formatted code blocks was failing due to regex issues.

Here are the lisp highlighted code blocks. Edit: removed link.

If you find any code that is not highlighted, please find the appropiate code block and replace it in the code!

So finally, first version is out!

However, this is a work in progress.

These are the changes that are needed for it to reach a version 1.0:

1. Fix all the markdown titles for the right side panel navigation bar. For some reason during the parsing, some of the titles got messed up in the navigation bar. The titles in the actual content are repeated. The second one must also be removed. Edit: 2023/11/26
2. Need to link up all italics to the actual page in the reference.
3. Need to fix the tables in all the files. Idea: Could find each table in the original TeX files and parse those and replace the text in the current markdown since the original is hopefully structured.
4. Need to parse and find every bit of lisp code and wrap it in the proprer ``` backquote wrappers with the lisp syntax for pretty print. See #3, could try to see if the original TeX marked code blocks and use those with text replace.
5. Make sure everything else is good!
6. Change the _category_.json files to display position of chapters in sidebar correctly... Edit: 2023/11/27
7. Change the _category_.json contents to use double quotes instead of single quotes... Edit: 2023/11/27
8. Add search plugin
9. "beach": "The description of each operator should probably be on a separate page, because for the language reference, more material will be added there"

However, with that said, the project is actually ready for contributions!

How The Project is Structured​

The idea here was to separate the files with the original dpANS3r text from the community additions. Therefore, to add examples or any content, just create a new file. Please name it relevant to the section you will add it to, and then just import it in that section like all the other files are imported.

So instead of writing the examples in the dpANS3r itself, it will be a new file examples.md where you can write anything you want. Then you would import it wherever relevant.

Please note that because react doesn't seem to allow using numbers in component names, I had to convert all numbers to letters. A=0, B=1, etc...

The mission of Common Lisp Docs and this website in particular is to provide Common Lisp Documentation.

The Docs in this Website are aimed to be a User Guide.

This website Common Lisp Reference is meant to be the reference.

We will hopefully soon come up with a tutorials website and more!

We aim to make this website as comprehensive as websites for other languages.

Adding some sample code below...

(format T "Hello World!")

    (defun my-sqr (x)
        (* x x))