docs.mybb.com icon indicating copy to clipboard operation
docs.mybb.com copied to clipboard

Table Documentation

Open dragonexpert opened this issue 7 years ago • 15 comments

Broke down all the tables to show the columns and what they are used for.

dragonexpert avatar Feb 12 '18 18:02 dragonexpert

This is a big one! I wonder if it might make sense to make the table names bold and differentiate the column names from the descriptions somehow - perhaps by making the column name italic, or maybe by using a HTML table to show each table?

euantorano avatar Feb 12 '18 18:02 euantorano

So maybe The table name on top. Then th for column name, column type, description? If so, it would be best to build a script to do that as it would take a lot longer to do manually.

dragonexpert avatar Feb 12 '18 20:02 dragonexpert

Yeah, something like that I’d say. A script would definitely be the best approach in my opinion as ideally the column type definitions would include all supported DBMS (MySQL, Postgres, SQLite).

On 12 Feb 2018, at 20:10, dragonexpert [email protected] wrote:

So maybe The table name on top. Then th for column name, column type, description? If so, it would be best to build a script to do that as it would take a lot longer to do manually.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or mute the thread.

euantorano avatar Feb 12 '18 21:02 euantorano

Here is a preview of what I have: http://superlatios.com/forums/totable.html I think we should assign a fixed width for each table though. Just let me know what to put so I can generate it.

dragonexpert avatar Feb 12 '18 22:02 dragonexpert

looks pretty good, @dragonexpert. I agree with you on a fixed width.

andrewjs18 avatar Feb 18 '18 22:02 andrewjs18

Do you think 1000px would be sufficient? @euantorano @andrewjs18

dragonexpert avatar Feb 18 '18 22:02 dragonexpert

probably would be fine...most people use a resolution above 1024 these days anyways.

andrewjs18 avatar Feb 18 '18 22:02 andrewjs18

I'll generate the tables with a fixed width tomorrow then and update the PR.

dragonexpert avatar Feb 18 '18 22:02 dragonexpert

We should probably try to get this merged. @andrewjs18 @euantorano @justinsoltesz ?

Ben-MyBB avatar May 31 '18 19:05 Ben-MyBB

Yep, we should. I'm not sure how up to date this PR is, but we could merge it and update it I guess.

euantorano avatar May 31 '18 19:05 euantorano

bump, @dragonexpert

andrewjs18 avatar Aug 19 '18 20:08 andrewjs18

@dragonexpert any chance you could update this one?

Ben-MyBB avatar May 03 '20 21:05 Ben-MyBB

@yuliu is there any chance you can check the content here?

Ben-MyBB avatar May 18 '20 20:05 Ben-MyBB

@yuliu is there any chance you can check the content here?

Sure I'll take a look in this weekend. But what if the content is out of date? Database changes exist in recent version updates.

yuliu avatar May 19 '20 04:05 yuliu

It probably is out of date, but we can always merge then update or update the PR directly (it appears to be open to maintainers supplying changes directly).

euantorano avatar May 23 '20 21:05 euantorano