logseq / docs

Logseq documentation
https://docs.logseq.com
MIT License
124 stars 90 forks source link

Document the missing Logseq properties #79

Open Bad3r opened 1 year ago

Bad3r commented 1 year ago

Document the missing Logseq properties.

Legend

Source: property.cljs

Property                 Description                                                                                                                                                        
collapsed               specifies whether a block is collapsed.                                                                                                               (1) (block)  
id                     specifies a block ID.                                                                                                                                 (1) (block)  
created-at             deprecated property that defines the created date/time stamps in Unix time.                               (1) (block)  
updated-at             deprecated property that defines the updated date/time stamps in Unix time. previously last-modified-at  (1) (block)
query-table             marks a query to be shown as the table view.                                                                                                         (1) (block)  
query-properties       properties user has chosen to see in query table.                                                                                                     (N) (block)  
query-sort-by           property by which to sort query table.                                                                                                               (1) (block)  
query-sort-desc         property sort direction. boolean where true is descending                                                                                             (1) (block)  
custom-id                                                                                                                                                                     (1) (block)  
background-color                                                                                                                                                             (1) (block)  
ls-type                                                                                                                                                                                    
hl-page                                                                                                                                                                                    
hl-stamp                                                                                                                                                                                  
hl-color                                                                                                                                                                                  
logseq.macro-name                                                                                                                                                             (1)          
logseq.macro-arguments                                                                                                                                                       (n)          
logseq.tldraw.page                                                                                                                                                                        
logseq.tldraw.shape                                                                                                                                                                        
logseq-cldwalker commented 1 year ago

@Bad3r Adding the missing ones to https://docs.logseq.com/#/page/built-in%20properties would be great! Still prefer we keep the existing tree structure until we have tables that have the ability to filter. One day 🙏

Bad3r commented 1 year ago

@Bad3r Adding the missing ones to https://docs.logseq.com/#/page/built-in%20properties would be great! Still prefer we keep the existing tree structure until we have tables that have the ability to filter. One day 🙏

I will be more than happy to submit a PR. Unfortunately I do not really know what these properties are used for. I could make an educated guess based on the src though.

Bad3r commented 1 year ago
logseq-cldwalker commented 1 year ago

Would recommend only doing the ones you have high confidence in and I can fill in the others when I have time

On Fri, 10 Feb 2023 at 15:47, Bad3r @.***> wrote:

  • custom-id
    • what is this used for and how is it different from :id
  • background-color
    • The block background color
  • ls-type
    • what does ls stand for? Logseq i.e. does this mean markdown or org-mode?
  • hl-page, hl-stamp, and hl-color
    • what does hl stand for? highlight?
  • when is macro-name and macro-arguments used?
  • I don't understand tldraw.page and tldraw.shape

— Reply to this email directly, view it on GitHub https://github.com/logseq/docs/issues/79#issuecomment-1426327505, or unsubscribe https://github.com/notifications/unsubscribe-auth/AXFVC5YRUIAMYZEKIYFNU3TWW2SP5ANCNFSM6AAAAAAUXRIZL4 . You are receiving this because you commented.Message ID: @.***>

lef-est commented 1 year ago

file and file-path should be there under "editable properties" too. ( https://docs.logseq.com/#/page/64146616-a5ab-4fed-bdea-52438cce9aba)

It should be able to answer questions like https://discuss.logseq.com/t/what-causes-the-file-property-to-appear/16145

Bad3r commented 1 year ago

@logseq-cldwalker should this list/page now include the new tablesV2 properties? it seems like many were added recently and they are documented in the table feature page.

logseq-cldwalker commented 1 year ago

Good point. I've pushed an update to link to table props from built-in

On Wed, 31 May 2023 at 17:35, Bad3r @.***> wrote:

@logseq-cldwalker https://github.com/logseq-cldwalker should this list/page now include the new tablesV2 properties? it seems like many were added recently and they are documented in the table feature page.

— Reply to this email directly, view it on GitHub https://github.com/logseq/docs/issues/79#issuecomment-1570994737, or unsubscribe https://github.com/notifications/unsubscribe-auth/AXFVC56H2KXZ7WW6MQ4UOMLXI62SRANCNFSM6AAAAAAUXRIZL4 . You are receiving this because you were mentioned.Message ID: @.***>