Add all blocks to the readme table #63
Conversation
README.md
Outdated
| @@ -64,11 +64,47 @@ At the core of n2y are a set of python classes that represent the various parts | |||
|
|
|||
| | Notion Object Type | Description | | |||
| | --- | --- | | |||
| | Block | A bit of content within a Page | | |||
There was a problem hiding this comment.
@sHermanGriffiths this table, which includes the Notion Object Types, should not include all of the individual block types. There is a table further down in the readme for the block types that contains some of the block types already.
Also, the descriptions should be empty unless there is something non-obvious about the behavior. Thus, comments like "A notion block of an image" should be omitted. This was the intent of the GitHub issue that stated "Only add information that is not obvious; e.g., if an paragraph block just makes a paragraph in markdown, we don't need to add any comment about it.". I think this will make the table more useful if it only contains the non-obvious stuff.
There was a problem hiding this comment.
See https://github.com/innolitics/n2y/pull/63/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R136 for the table all of this should be added to.
README.md
Outdated
| | VideoBlock | A block that houses a video | | ||
| | PdfBlock | A block that houses a PDF | | ||
| | ChildrenPassThroughBlock | A block that passes along the children of it's parent | | ||
| | ColumnBlock | A block that apears on the page as a column | |
There was a problem hiding this comment.
The description of the ColumnBlock should explain how we convert the column blocks into markdown. In particular, we ignore the columns and just display the content in each column one after the other in the markdown, since there is no way to support columns in markdown. This is a good example of the non-obvious sort of content that should go into this table.
There was a problem hiding this comment.
@sHermanGriffiths I think there was some confusion regarding the tasks in #25
Please read the issue more carefully next time, as I believe some of the instructions you didn't follow seem pretty clear.
sHermanGriffiths
force-pushed
the
issue25
branch
from
0d14896
to
a6cca07
Compare
README.md
Outdated
| @@ -99,27 +99,36 @@ Here are the default block classes that can be extended: | |||
|
|
|||
| | Class Name | Noteworthy Behavior | | |||
| | --- | --- | | |||
| | BookmarkBlock | | | |||
| | BookmarkBlock | Converts visual bookmark into plain text link in markdown, using the caption as the link text. | | |||
| | BreadcrumbBlock | Ignore | | |||
There was a problem hiding this comment.
| | BreadcrumbBlock | Ignore | | |
| | BreadcrumbBlock | These blocks are ignored | |
README.md
Outdated
| | ColumnBlock | | | ||
| | ColumnListBlock | Columns are flattened and displayed sequentially. | | ||
| | ToggleBlock | Convert toggles into a details and summary tag. | | ||
| | VideoBlock | Acts the same way ass the Image block | |
There was a problem hiding this comment.
| | VideoBlock | Acts the same way ass the Image block | | |
| | VideoBlock | Acts the same way as the Image block | |
README.md
Outdated
| | ToggleBlock | Convert the toggles into a bulleted list. | | ||
| | ColumnBlock | | | ||
| | ColumnListBlock | Columns are flattened and displayed sequentially. | | ||
| | ToggleBlock | Convert toggles into a details and summary tag. | |
There was a problem hiding this comment.
I think the current default functionality for the ToggleBlock is appropriate. Users can use a plugin if they want to produced details and summary tags. Keep in mind we are often exporting to non-HTML formats, like PDF or Word documents.
README.md
Outdated
| | SyncedBlock | Transcribe the contents of the synced block at the time it was constructed | | ||
| | TableBlock | | | ||
| | TableOfContentsBlock | transcribes the contenets of the Table of contents block into page links | | ||
| | TemplateBlock | Ignore | |
README.md
Outdated
| | RowBlock | | | ||
| | SyncedBlock | Transcribe the contents of the synced block at the time it was constructed | | ||
| | TableBlock | | | ||
| | TableOfContentsBlock | transcribes the contenets of the Table of contents block into page links | |
There was a problem hiding this comment.
I think we can ignore the table of contents blocks for now.
README.md
Outdated
| | NumberedListItemBlock | | | ||
| | ParagraphBlock | | | ||
| | PdfBlock | Acts the same way ass the Image block | |
There was a problem hiding this comment.
| | PdfBlock | Acts the same way ass the Image block | | |
| | PdfBlock | Acts the same way as the Image block | |
| | HeadingOneBlock | | | ||
| | HeadingTwoBlock | | | ||
| | HeadingThreeBlock | | | ||
| | ImageBlock | It uses the URL for external images, but downloads uploaded images to the `MEDIA_ROOT` and replaces the path with a relative url based off of `MEDIA_URL`. The "caption" is used for the alt text. | | ||
| | FileBlock | Acts the same way as the ImageBlock, except that in the documents it only ever shows the URL. | | ||
| | LinkToPageBlock | Transcribes the block into a plain text link | |
README.md
Outdated
| | BulletedListItemBlock | | | ||
| | CalloutBlock | The content of the callout block is extracted, but the emoji and background color are ignored. | | ||
| | ChildPageBlock | | | ||
| | FencedCodeBlock | | | ||
| | ChildDatabaseBlock | Converts database to markdown in different file in directory and writes a relative link to the markdown| |
There was a problem hiding this comment.
The difficulty with exporting the child database to markdown is that there's no way to represent a database as a single markdown file. Depending on the selected output format, a database is either a single YAML file or many markdown files.
For now, I propose we just ignore child databases.
README.md
Outdated
| | ChildPageBlock | | | ||
| | FencedCodeBlock | | | ||
| | ChildDatabaseBlock | Converts database to markdown in different file in directory and writes a relative link to the markdown| | ||
| | ChildPageBlock | Converts Child Page to markdown. | |
There was a problem hiding this comment.
Depending on the selected output format Command-line argument, we may or many not be exporting the child pages into markdown. In fact, currently, we don't ever export child page objects. In the future, we will have a recursive export format option that will recursively go through a page and export everything.
There was a problem hiding this comment.
For now, I propose we just ignore child pages. In the future, I think the solution you have outlined is a good one.
No description provided.