No, the more people break it the better!
zetsu#1#1 by zetsu (@zetsu, 0) on 2024-10-22
Didn't mean to break it, sorry for that XD
hahahhaha yes it was unintentional. Thanks for the info
OK, I've release a fix that will prevent the header newline issues from happening again on server and it also gives a local warning: github.com/ourbigbook/ourbigbook/commit/dc85cf067b926a73f4b17704afcfc29f75b164ea
Also consider:
npm install --save ourbigbook@latest
to get these local conversion updates and a few others I've added recently.
Thanks a lot once again for this report! Local to web upload is hard to get right, and I've had many issues myself, but I try to fix this with high priority, and new users stress it in different ways which is great.
A tip, during web upload, ourbigbook first splits the headers to separate files under out/web, so looking there can help understand what went wrong. But not something I want users to ever have to worry about of course, the goal is that if it converts locally without error, it should upload without error.
OK awesome!
Both of these issues will soon start giving a much clearer and early local error since: github.com/ourbigbook/ourbigbook/commit/c12a72172de22dd356e8b4cb3a9d5fe67c0555f9 which I had recently implemented I just haven't released it yet, I'll ping it when I do for npm update.
Your files have to be really huge before being in a single file starts becoming a problem, so don't worry too much about it.
Previously cirosantilli.com was one humongous README.adoc, but it reached a point where the HTML was too slow to load lol.
That was part of the motivation of ourbigbook. But when you reach that point, ourbigbook makes the transition to multifile will be as seamless as it can be.
BTW you might want to use the {parent= syntax rather than header levels.
= My h1

= My h2
{parent=My h1}

= My h3
{parent=My h2}
This allows you to move chunks around very easily (within the same file, or to other files), without having to change a billion header levels each time.
Don't mind the escape characters on the {scope}. This was not supposed to be written like that
I got it to work! There were two problems: First:
== Glass
\{scope\}
Random text here
I solved this by adding a new line after the {scope}
Then:
Random text here
=== Sub title
This gave me an error of: Headers are not allowed in OBB Web Articles. Fixed it by adding a new line again.
I do not work with \Include because I had trouble figuring out how to do that. I will try it in the future again hahahha. Now it's a big monolithic mess
You could also consider pushing your local source to a public github repo to make it easier to inspect. Also a good idea to backup it in git anyways.
Hmm can you give a bit more of the error logs and perhaps local source? Also double check that every file is reachable from the README.bigb via \\Include (I'm going to add a local check for this soon).
Now I have got this error:
parentId did not match any known parent: "@pioyi/glass"
Glass is the new article. Weird because I didn't have the same problem with starch
OK, I understood the problem now by inspecting the server DB. The root problem is that you uploaded something like (by accident or due to another ourbigbook bug):
= asdf $$

$$ qwer
which the server incorrectly accepted, such syntax should not be allowed.
When, the web_delete things is what happens when you delete an ID locally, but the server still contains it, so it deletes it from the server, which means: 1) mark as unlisted 2) make the body empty (remove all sub-ids like images) thus leaving you with:
= asdf $$
which is an unclosed string literal thus the error message.
I've now tried to clean that up from the DB, and I'll make sure that the offending syntax is forbidden both locally and on server (I've been adding several such checks in recent patches and I'll add this in as well, I was not aware of it).
Can you try ourbigbook --web again and see if it got fixed?
Some logs for my own reference:
                                                                                                                       path                                                                                                                       
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 @pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental-sulfur-the-overall-reaction-can-be-descibed-as-follows-2-h-2s-plus-so-2-3s-plus-2h-20.bigb
(1 row)

ourbigbook::DATABASE=> select "titleSource" from "File" where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
                                                                                                 titleSource                                                                                                  
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 Claus processCreated by the german chemist Carl Friedrich Claus, it makes it possible to convert hydrogen sulfide (from natural gas) to elemental sulfur.The overall reaction can be descibed as follows: $$
(1 row)

ourbigbook::DATABASE=> select "bodySource" from "File" where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
                                                                     bodySource                                                                      
-----------------------------------------------------------------------------------------------------------------------------------------------------
 2 H_2S + SO_2 -> 3S + 2H_20.                                                                                                                       +
 $$                                                                                                                                                 +
                                                                                                                                                    +
 The Claus' process served as a better replacement of the Frasch process, which obtained elemental sulfur from naturally found deposits underground.+
 
(1 row)

ourbigbook::DATABASE=> 
And how I tried to fix it:
ourbigbook::DATABASE=> update "File" set "bodySource" = '' where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
UPDATE 1
ourbigbook::DATABASE=> update "File" set "titleSource" = 'claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental-sulfur-the-overall-reaction-can-be-descibed-as-follows-2-h-2s-plus-so-2-3s-plus-2h-20' where "path" LIKE '@pioyi/claus-processcreated-by-the-german-chemist-carl-friedrich-claus-it-makes-it-possible-to-convert-hydrogen-sulfide-from-natural-gas-to-elemental%';
UPDATE 1
ourbigbook::DATABASE=> 
E.g. I dump all kinds of important metadata on title2 like: ourbigbook.com/cirosantilli/list-of-chemical-elements#helium with source: ourbigbook.com/go/source/cirosantilli/helium
These are things that would be really cool to have as a more structured metadat like Wikipedia does via Wikidata, but I'm staying off the structured data for now, though tempted.
Relevant information: If I delete the whole h4 or comment it out, the same error occurs. So it has to do with the already loaded text. That's very weird. The error doesn't seem to occur if I change other old parts of the text.
Awesome! Good reminder that I need to add comment editing as well 😂
And as usual, feel free to write about anything you want and at any quality level, including quick drafts or self notes. There is no moderation and nor algorithmic downside for crap content of any kind.
Thank you, no worries! Trying to study some organic chemistry so I write something of value here
I fixed the random logout issues at: github.com/ourbigbook/ourbigbook/commit/1175ae40cec5acc7297d4ffb450644966fcd01bb Let me know if you encounter any further problems with it.
BTW I've added the following to docs.ourbigbook.com/ourbigbook-com-content-license I hope this is a reasonable clause given that I'm putting years of my life into this project. I understand it could put some people off, and I don't intend to ever relicense anything lightly, as it would be an instant reputational hit. This had been on the back of my mind for a while, but after seeing your contributions I've decided to do it now before more content gets added. It does not affect any of the pre-existing content.
Starting from August 22 2024, users also automatically grant to the OurBigBook Project a non-exclusive license to relicense their content. This could be used for example to:
  • sell the content to companies that do not wish to comply with the CC By-SA license, e.g. for LLM training. We will try to avoid ever doing this as much as possible since it goes against the vision of the project for open knowledge. But it could one day be the difference between life and death of the project, so we'd like to keep that door open just in case.
  • add a new license to content on the website which we feel might better serve all users
Any such relicensing does not affect the original CC BY-SA 4.0 license nor your ownership of the content. It only adds new licenses on top of it. This way the content remains free no matter what.
Pinned article: ourbigbook/introduction-to-the-ourbigbook-project
Welcome to the OurBigBook Project! Our goal is to create the perfect publishing platform for STEM subjects, and get university-level students to write the best free STEM tutorials ever.
Everyone is welcome to create an account and play with the site: ourbigbook.com/go/register. We belive that students themselves can write amazing tutorials, but teachers are welcome too. You can write about anything you want, it doesn't have to be STEM or even educational. Silly test content is very welcome and you won't be penalized in any way. Just keep it legal!
Video 1.
Intro to OurBigBook
. Source.
We have two killer features:
  1. topics: topics group articles by different users with the same title, e.g. here is the topic for the "Fundamental Theorem of Calculus" ourbigbook.com/go/topic/fundamental-theorem-of-calculus
    Articles of different users are sorted by upvote within each article page. This feature is a bit like:
    • a Wikipedia where each user can have their own version of each article
    • a Q&A website like Stack Overflow, where multiple people can give their views on a given topic, and the best ones are sorted by upvote. Except you don't need to wait for someone to ask first, and any topic goes, no matter how narrow or broad
    This feature makes it possible for readers to find better explanations of any topic created by other writers. And it allows writers to create an explanation in a place that readers might actually find it.
    Figure 1.
    Screenshot of the "Derivative" topic page
    . View it live at: ourbigbook.com/go/topic/derivative
    Video 2.
    OurBigBook Web topics demo
    . Source.
  2. local editing: you can store all your personal knowledge base content locally in a plaintext markup format that can be edited locally and published either:
    • to OurBigBook.com to get awesome multi-user features like topics and likes
    • as HTML files to a static website, which you can host yourself for free on many external providers like GitHub Pages, and remain in full control
    This way you can be sure that even if OurBigBook.com were to go down one day (which we have no plans to do as it is quite cheap to host!), your content will still be perfectly readable as a static site.
    Figure 5. . You can also edit articles on the Web editor without installing anything locally.
    Video 3.
    Edit locally and publish demo
    . Source. This shows editing OurBigBook Markup and publishing it using the Visual Studio Code extension.
    Video 4.
    OurBigBook Visual Studio Code extension editing and navigation demo
    . Source.
  3. https://raw.githubusercontent.com/ourbigbook/ourbigbook-media/master/feature/x/hilbert-space-arrow.png
  4. Infinitely deep tables of contents:
    Figure 6.
    Dynamic article tree with infinitely deep table of contents
    .
    Descendant pages can also show up as toplevel e.g.: ourbigbook.com/cirosantilli/chordate-subclade
All our software is open source and hosted at: github.com/ourbigbook/ourbigbook
Further documentation can be found at: docs.ourbigbook.com
Feel free to reach our to us for any help or suggestions: docs.ourbigbook.com/#contact