mabuseif commited on
Commit
4442026
·
verified ·
1 Parent(s): 9ca3799

Update app.py

Browse files
Files changed (1) hide show
  1. app.py +18 -13
app.py CHANGED
@@ -86,7 +86,7 @@ def load_css():
86
 
87
  .rendered-citation {
88
  margin: 0.5rem 0;
89
- font-size: 1.4rem; /* Increased font size for generated citations */
90
  }
91
  </style>
92
  """, unsafe_allow_html=True)
@@ -198,7 +198,7 @@ st.markdown("""
198
  with st.expander("About SCC and Example Citation"):
199
  st.markdown("""
200
  <div class="info-card">
201
- <p>The Smart Context Citation (SCC) style is a modern referencing system designed to enhance transparency and integrity in academic citations, particularly in the era of generative AI. It integrates context directly into citations, uses cryptographic hashes for verification, and eliminates the need for traditional reference lists.</p>
202
  <h4>Key Features</h4>
203
  <ul>
204
  <li><strong>Inline Citations:</strong> Uses author-year format, either &quot;Author (Year)&quot; or &quot;(Author, Year)&quot;, hyperlinked to the source with a text fragment.</li>
@@ -206,12 +206,12 @@ with st.expander("About SCC and Example Citation"):
206
  <li><strong>Benefits:</strong> Promotes digital fluency, ensures source traceability, prevents fabrication, and simplifies referencing.</li>
207
  </ul>
208
  <h4>Technical Legitimacy</h4>
209
- <p>The SCC style leverages the <a href="https://wicg.github.io/scroll-to-text-fragment/" target="_blank">W3C Text Fragments specification</a>, enabling precise linking to specific text within web pages. This ensures citations are contextually accurate and verifiable, aligning with modern web standards.</p>
210
  <h4>Example Citation</h4>
211
  <p><strong>Inputs:</strong></p>
212
  <ul>
213
  <li><strong>Username:</strong> Majed</li>
214
- <li><strong>Task Name:</strong> Trees on Buildings Design</li>
215
  <li><strong>Author:</strong> Abuseif et al.</li>
216
  <li><strong>Year:</strong> 2023</li>
217
  <li><strong>URL:</strong> https://www.sciencedirect.com/science/article/pii/S2772411523000046</li>
@@ -221,7 +221,7 @@ with st.expander("About SCC and Example Citation"):
221
  <ul>
222
  <li><strong>Citation (Start of Text):</strong> <span style="font-size: 1.2rem;">Abuseif et al. (2023)</span> (hyperlinked to <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=A%20proposed%20design%20framework%20for%20green%20roof%20settings%20in%20general%20and%20trees%20on%20buildings%20in%20particular</code>)</li>
223
  <li><strong>Citation (End of Text):</strong> <span style="font-size: 1.2rem;">(Abuseif et al., 2023)</span> (hyperlinked to <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=A%20proposed%20design%20framework%20for%20green%20roof%20settings%20in%20general%20and%20trees%20on%20buildings%20in%20particular</code>)</li>
224
- <li><strong>SCC Index:</strong> <span style="font-size: 0.85rem;">Abuseif et al. (2023). 7825af167ba0b749651a9b21459c51aa693925f04ad5ee40c07656f9096c6e5f</span> (hyperlinked to <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=Majed%252525E2%25252580%25252594Trees%252520on%252520Buildings%252520Design%252525E2%25252580%252525942025-08-06%252525E2%25252580%2525259419:42:28</code>)</li>
225
  </ul>
226
  </div>
227
  """, unsafe_allow_html=True)
@@ -237,7 +237,7 @@ with st.expander("SCC Style Guidelines"):
237
  <li><strong>Enter User Information:</strong>
238
  <ul>
239
  <li><strong>Username:</strong> Your unique identifier (e.g., Majed).</li>
240
- <li><strong>Task Name:</strong> The project or assignment name (e.g., Trees on Buildings Design).</li>
241
  </ul>
242
  </li>
243
  <li><strong>Enter Citation Information:</strong>
@@ -245,7 +245,7 @@ with st.expander("SCC Style Guidelines"):
245
  <li><strong>Author(s) Name:</strong> The author(s) of the source (e.g., Abuseif et al.).</li>
246
  <li><strong>Publication Year:</strong> The year of publication (e.g., 2023).</li>
247
  <li><strong>Source URL:</strong> The full URL of the source, without text fragments (e.g., https://www.sciencedirect.com/science/article/pii/S2772411523000046).</li>
248
- <li><strong>Annotated Text:</strong> The quoted or paraphrased text from the source (e.g., A proposed design framework for green roof settings in general and trees on buildings in particular).</li>
249
  </ul>
250
  </li>
251
  <li><strong>Generate Citation:</strong> Click the &quot;Generate Citation&quot; button.</li>
@@ -253,12 +253,17 @@ with st.expander("SCC Style Guidelines"):
253
  <ul>
254
  <li><strong>Citation (Start of Text):</strong> Use &quot;Author (Year)&quot; for the start of a sentence (e.g., Abuseif et al. (2023)).</li>
255
  <li><strong>Citation (End of Text):</strong> Use &quot;(Author, Year)&quot; for in-text citations (e.g., (Abuseif et al., 2023)).</li>
256
- <li><strong>SCC Index:</strong> Copy the index link (e.g., Abuseif et al. (2023). 7825af167ba0b749651a9b21459c51aa693925f04ad5ee40c07656f9096c6e5f) for verification.</li>
257
- <li>Right-click each link to copy the &quot;Link Address&quot; for verification.</li>
258
  </ul>
259
  </li>
260
  </ol>
261
- <h4>Verifying Citations</h4>
 
 
 
 
 
262
  <ol>
263
  <li><strong>Access the Tool:</strong> Open the &quot;Verify Citation&quot; tab.</li>
264
  <li><strong>Enter Citation Information:</strong>
@@ -269,7 +274,7 @@ with st.expander("SCC Style Guidelines"):
269
  </li>
270
  <li><strong>Enter SCC Index Information:</strong>
271
  <ul>
272
- <li><strong>SCC Index Text:</strong> Paste the index text (e.g., Abuseif et al. (2023). 7825af167ba0b749651a9b21459c51aa693925f04ad5ee40c07656f9096c6e5f).</li>
273
  <li><strong>SCC Index URL:</strong> Paste the hyperlink URL from the index (right-click and select &quot;Copy Link Address&quot;).</li>
274
  </ul>
275
  </li>
@@ -295,7 +300,7 @@ with tabs[0]:
295
  with col1:
296
  username = st.text_input("Username", help="Your username for tracking purposes", placeholder="e.g., Majed")
297
  with col2:
298
- task_name = st.text_input("Task Name", help="The name of the task or project", placeholder="e.g., Trees on Buildings Design")
299
 
300
  # Citation Info Section
301
  st.subheader("Citation Info")
@@ -309,7 +314,7 @@ with tabs[0]:
309
  with col5:
310
  source_url = st.text_input("Source URL", help="The full URL of the source", placeholder="https://www.sciencedirect.com/science/article/pii/S2772411523000046")
311
  with col6:
312
- annotated_text = st.text_input("Annotated Text", help="The text quoted or paraphrased from the source", placeholder="e.g., A proposed design framework for green roof settings...")
313
 
314
  # Live date and time display
315
  st.markdown("### Current Date and Time")
 
86
 
87
  .rendered-citation {
88
  margin: 0.5rem 0;
89
+ font-size: 1.4rem;
90
  }
91
  </style>
92
  """, unsafe_allow_html=True)
 
198
  with st.expander("About SCC and Example Citation"):
199
  st.markdown("""
200
  <div class="info-card">
201
+ <p>The Smart Context Citation (SCC) style is a modern referencing system designed to enhance transparency and integrity in academic citations, particularly in the era of generative AI. It integrates context directly into citations, uses cryptographic hashes for verification, and replaces the traditional reference list with an SCC Index that includes an Authenticated Citation Identifier (ACI).</p>
202
  <h4>Key Features</h4>
203
  <ul>
204
  <li><strong>Inline Citations:</strong> Uses author-year format, either &quot;Author (Year)&quot; or &quot;(Author, Year)&quot;, hyperlinked to the source with a text fragment.</li>
 
206
  <li><strong>Benefits:</strong> Promotes digital fluency, ensures source traceability, prevents fabrication, and simplifies referencing.</li>
207
  </ul>
208
  <h4>Technical Legitimacy</h4>
209
+ <p>The SCC style uses the W3C Text Fragments specification by Burris and Bokan (2023) to enable precise linking to specific sections of digital content. This ensures that citations are contextually accurate, verifiable, and aligned with modern digital standards. <a href="https://wicg.github.io/scroll-to-text-fragment/" target="_blank">W3C Text Fragments specification</a></p>
210
  <h4>Example Citation</h4>
211
  <p><strong>Inputs:</strong></p>
212
  <ul>
213
  <li><strong>Username:</strong> Majed</li>
214
+ <li><strong>Task Name:</strong> Design Strategies for Trees on Buildings</li>
215
  <li><strong>Author:</strong> Abuseif et al.</li>
216
  <li><strong>Year:</strong> 2023</li>
217
  <li><strong>URL:</strong> https://www.sciencedirect.com/science/article/pii/S2772411523000046</li>
 
221
  <ul>
222
  <li><strong>Citation (Start of Text):</strong> <span style="font-size: 1.2rem;">Abuseif et al. (2023)</span> (hyperlinked to <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=A%20proposed%20design%20framework%20for%20green%20roof%20settings%20in%20general%20and%20trees%20on%20buildings%20in%20particular</code>)</li>
223
  <li><strong>Citation (End of Text):</strong> <span style="font-size: 1.2rem;">(Abuseif et al., 2023)</span> (hyperlinked to <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=A%20proposed%20design%20framework%20for%20green%20roof%20settings%20in%20general%20and%20trees%20on%20buildings%20in%20particular</code>)</li>
224
+ <li><strong>SCC Index:</strong> <span style="font-size: 0.85rem;">Abuseif et al. (2023). cda7ba19e51e430107e58696758fdf79b8f016d8f27e8f8691ad713e7c8bc668</span> (hyperlinked to <code>https://www.sciencedirect.com/science/article/pii/S2772411523000046#:~:text=Majed%252525E2%25252580%25252594Design%252520Strategies%252520for%252520Trees%252520on%252520Buildings%252525E2%25252580%252525942025-08-06%252525E2%25252580%2525259420:41:11</code>)</li>
225
  </ul>
226
  </div>
227
  """, unsafe_allow_html=True)
 
237
  <li><strong>Enter User Information:</strong>
238
  <ul>
239
  <li><strong>Username:</strong> Your unique identifier (e.g., Majed).</li>
240
+ <li><strong>Task Name:</strong> The project or assignment name (e.g., Design Strategies for Trees on Buildings).</li>
241
  </ul>
242
  </li>
243
  <li><strong>Enter Citation Information:</strong>
 
245
  <li><strong>Author(s) Name:</strong> The author(s) of the source (e.g., Abuseif et al.).</li>
246
  <li><strong>Publication Year:</strong> The year of publication (e.g., 2023).</li>
247
  <li><strong>Source URL:</strong> The full URL of the source, without text fragments (e.g., https://www.sciencedirect.com/science/article/pii/S2772411523000046).</li>
248
+ <li><strong>Annotated Text:</strong> The sentence or paragraph containing the information you are referencing from the source (e.g., A proposed design framework for green roof settings in general and trees on buildings in particular).</li>
249
  </ul>
250
  </li>
251
  <li><strong>Generate Citation:</strong> Click the &quot;Generate Citation&quot; button.</li>
 
253
  <ul>
254
  <li><strong>Citation (Start of Text):</strong> Use &quot;Author (Year)&quot; for the start of a sentence (e.g., Abuseif et al. (2023)).</li>
255
  <li><strong>Citation (End of Text):</strong> Use &quot;(Author, Year)&quot; for in-text citations (e.g., (Abuseif et al., 2023)).</li>
256
+ <li><strong>SCC Index:</strong> Copy the index link (e.g., Abuseif et al. (2023). cda7ba19e51e430107e58696758fdf79b8f016d8f27e8f8691ad713e7c8bc668) for verification.</li>
257
+ <li>If you would like to test the reference before using it, click on it to check whether it is suitable and captures the information you need.</li>
258
  </ul>
259
  </li>
260
  </ol>
261
+ <h4>Using References and the SCC Index in Your Document</h4>
262
+ <ul>
263
+ <li>Paste the reference directly in the appropriate place within your document.</li>
264
+ <li>Create an SCC Index (instead of a traditional reference list), and paste the corresponding SCC Index entry for each reference you’ve used.</li>
265
+ </ul>
266
+ <h4>Verifying Citations for Markers and Reviewers</h4>
267
  <ol>
268
  <li><strong>Access the Tool:</strong> Open the &quot;Verify Citation&quot; tab.</li>
269
  <li><strong>Enter Citation Information:</strong>
 
274
  </li>
275
  <li><strong>Enter SCC Index Information:</strong>
276
  <ul>
277
+ <li><strong>SCC Index Text:</strong> Paste the index text (e.g., Abuseif et al. (2023). cda7ba19e51e430107e58696758fdf79b8f016d8f27e8f8691ad713e7c8bc668).</li>
278
  <li><strong>SCC Index URL:</strong> Paste the hyperlink URL from the index (right-click and select &quot;Copy Link Address&quot;).</li>
279
  </ul>
280
  </li>
 
300
  with col1:
301
  username = st.text_input("Username", help="Your username for tracking purposes", placeholder="e.g., Majed")
302
  with col2:
303
+ task_name = st.text_input("Task Name", help="The name of the task or project", placeholder="e.g., Design Strategies for Trees on Buildings")
304
 
305
  # Citation Info Section
306
  st.subheader("Citation Info")
 
314
  with col5:
315
  source_url = st.text_input("Source URL", help="The full URL of the source", placeholder="https://www.sciencedirect.com/science/article/pii/S2772411523000046")
316
  with col6:
317
+ annotated_text = st.text_input("Annotated Text", help="The sentence or paragraph containing the information you are referencing from the source", placeholder="e.g., A proposed design framework for green roof settings...")
318
 
319
  # Live date and time display
320
  st.markdown("### Current Date and Time")