Fossil SCM

Doc touchups in /chat. No code changes.

stephan 2024-08-09 10:32 trunk
Commit 714142737069ca13064df7dfe6d983bb1b7b0c36d8fc9d043f5bd2bdec197e28
1 file changed +9 -4
--- src/fossil.page.chat.js
+++ src/fossil.page.chat.js
@@ -65,10 +65,14 @@
6565
/* This can inadvertently influence our flexbox layouts, so move
6666
it out of the way. */
6767
D.append(document.body,dbg);
6868
}
6969
})();
70
+ /* Returns a list of DOM elements which "frame" the chat UI. These
71
+ elements are considered to _not_ be part of the chat UI and that
72
+ info is used for sizing the chat UI. In chat-only mode, these are
73
+ the elements that get hidden. */
7074
const GetFramingElements = function() {
7175
return document.querySelectorAll([
7276
"body > header",
7377
"body > nav.mainmenu",
7478
"body > footer",
@@ -711,11 +715,11 @@
711715
representations. It requires a server round-trip to collect the
712716
plain-text form but caches it for subsequent toggles.
713717
714718
Expects the ID of a currently-loaded message or a
715719
message-widget DOM elment from which it can extract an id.
716
- This is an aync operation the first time it's passed a given
720
+ This is an async operation the first time it's passed a given
717721
message and synchronous on subsequent calls for that
718722
message. It is a no-op if id does not resolve to a loaded
719723
message.
720724
*/
721725
cs.toggleTextMode = function(id){
@@ -783,11 +787,11 @@
783787
Chat.ajaxEnd();
784788
}
785789
});
786790
return true;
787791
};
788
-
792
+
789793
/** Given a .message-row element, this function returns whethe the
790794
current user may, at least hypothetically, delete the message
791795
globally. A user may always delete a local copy of a
792796
post. The server may trump this, e.g. if the login has been
793797
cancelled after this page was loaded.
@@ -1814,12 +1818,13 @@
18141818
if(!Chat.e.activeUserListWrapper.classList.contains('collapsed')){
18151819
Chat.animate(optAu.theList,'anim-flip-v');
18161820
}
18171821
}, false);
18181822
}/*namedOptions.activeUsers additional setup*/
1819
- /* Settings menu entries... the most frequently-needed ones "should"
1820
- (arguably) be closer to the start of this list. */
1823
+ /* Settings menu entries... they are presented in the order listed
1824
+ here, so the most frequently-needed ones "should" (arguably) be
1825
+ closer to the start of this list. */
18211826
/**
18221827
Settings ops structure:
18231828
18241829
label: string for the UI
18251830
18261831
--- src/fossil.page.chat.js
+++ src/fossil.page.chat.js
@@ -65,10 +65,14 @@
65 /* This can inadvertently influence our flexbox layouts, so move
66 it out of the way. */
67 D.append(document.body,dbg);
68 }
69 })();
 
 
 
 
70 const GetFramingElements = function() {
71 return document.querySelectorAll([
72 "body > header",
73 "body > nav.mainmenu",
74 "body > footer",
@@ -711,11 +715,11 @@
711 representations. It requires a server round-trip to collect the
712 plain-text form but caches it for subsequent toggles.
713
714 Expects the ID of a currently-loaded message or a
715 message-widget DOM elment from which it can extract an id.
716 This is an aync operation the first time it's passed a given
717 message and synchronous on subsequent calls for that
718 message. It is a no-op if id does not resolve to a loaded
719 message.
720 */
721 cs.toggleTextMode = function(id){
@@ -783,11 +787,11 @@
783 Chat.ajaxEnd();
784 }
785 });
786 return true;
787 };
788
789 /** Given a .message-row element, this function returns whethe the
790 current user may, at least hypothetically, delete the message
791 globally. A user may always delete a local copy of a
792 post. The server may trump this, e.g. if the login has been
793 cancelled after this page was loaded.
@@ -1814,12 +1818,13 @@
1814 if(!Chat.e.activeUserListWrapper.classList.contains('collapsed')){
1815 Chat.animate(optAu.theList,'anim-flip-v');
1816 }
1817 }, false);
1818 }/*namedOptions.activeUsers additional setup*/
1819 /* Settings menu entries... the most frequently-needed ones "should"
1820 (arguably) be closer to the start of this list. */
 
1821 /**
1822 Settings ops structure:
1823
1824 label: string for the UI
1825
1826
--- src/fossil.page.chat.js
+++ src/fossil.page.chat.js
@@ -65,10 +65,14 @@
65 /* This can inadvertently influence our flexbox layouts, so move
66 it out of the way. */
67 D.append(document.body,dbg);
68 }
69 })();
70 /* Returns a list of DOM elements which "frame" the chat UI. These
71 elements are considered to _not_ be part of the chat UI and that
72 info is used for sizing the chat UI. In chat-only mode, these are
73 the elements that get hidden. */
74 const GetFramingElements = function() {
75 return document.querySelectorAll([
76 "body > header",
77 "body > nav.mainmenu",
78 "body > footer",
@@ -711,11 +715,11 @@
715 representations. It requires a server round-trip to collect the
716 plain-text form but caches it for subsequent toggles.
717
718 Expects the ID of a currently-loaded message or a
719 message-widget DOM elment from which it can extract an id.
720 This is an async operation the first time it's passed a given
721 message and synchronous on subsequent calls for that
722 message. It is a no-op if id does not resolve to a loaded
723 message.
724 */
725 cs.toggleTextMode = function(id){
@@ -783,11 +787,11 @@
787 Chat.ajaxEnd();
788 }
789 });
790 return true;
791 };
792
793 /** Given a .message-row element, this function returns whethe the
794 current user may, at least hypothetically, delete the message
795 globally. A user may always delete a local copy of a
796 post. The server may trump this, e.g. if the login has been
797 cancelled after this page was loaded.
@@ -1814,12 +1818,13 @@
1818 if(!Chat.e.activeUserListWrapper.classList.contains('collapsed')){
1819 Chat.animate(optAu.theList,'anim-flip-v');
1820 }
1821 }, false);
1822 }/*namedOptions.activeUsers additional setup*/
1823 /* Settings menu entries... they are presented in the order listed
1824 here, so the most frequently-needed ones "should" (arguably) be
1825 closer to the start of this list. */
1826 /**
1827 Settings ops structure:
1828
1829 label: string for the UI
1830
1831

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button