Help:Wiki-Dev: Difference between revisions

From GRS Documentation Wiki
No edit summary
 
(43 intermediate revisions by the same user not shown)
Line 1: Line 1:
=TODOs=
=TODOs=
* [[User:Andre Castro|Andre Castro]] ([[User talk:Andre Castro|talk]]) 12:00, 12 March 2024 (CET) logo
* [[User:Andre Castro|Andre Castro]] ([[User talk:Andre Castro|talk]]) 14:03, 12 March 2024 (CET) [[:Category:Computational_Resource]] form+template
* [[User:Andre Castro|Andre Castro]] ([[User talk:Andre Castro|talk]]) 12:00, 12 March 2024 (CET) VRLab, Delft Blue
* [[User:Andre Castro|Andre Castro]] ([[User talk:Andre Castro|talk]]) 14:03, 12 March 2024 (CET) Project
 


=Data Structures=
=Data Structures=
Line 8: Line 7:
==Guiding principals of Data Structures==
==Guiding principals of Data Structures==


Leave more administrative content to the department's sharepoint (rule of thumb: anything the secretaries might need to read/edit, should be on sharepoint). (TODO: add link to sharepoint)
'''Leave more administrative content to the department's sharepoint (rule of thumb: anything the secretaries might need to read/edit, should be on sharepoint). (TODO: add link to sharepoint)'''


A semantic wiki instance  might look like it has sections, but in essence it is all based on different "categories" of pages. For the most part, it is a flat page hierarchy (NO Subpages).  
A semantic wiki instance  might look like it has sections, but in essence it is all based on different "categories" of pages. For the most part, it is a flat page hierarchy (NO Subpages).  


[SMW Help:Classification](https://www.semantic-mediawiki.org/wiki/Help:Classification) provides good info on using Categories and Properties to classify wiki pages.
==Categories<ref>More on Mediawiki Categories at https://www.mediawiki.org/wiki/Help:Categories/en and https://www.semantic-mediawiki.org/wiki/Category</ref>==
Categories are the main way to define '''what''' kind of a thing a page refers to.
===All Categories and their Child Categories===
<categorytree mode="pages" hideprefix="never">Resource</categorytree>
===[[:Category:Person]] Namespace User:===
* [[GRS_Documentation_Wiki:User]] matches the User: namespace to the [[Form:User]]
* [[Property:isMemberOfSection]]
* [[Property:participatesInProject]]
[[Form:User]] [[Template:User]]
===[[:Category:Section]]===
* [[Property:hasHead]]
* [[Property:hasDescriptiveTitle]]
[[Form:Section]] [[Template:Section]]


TODO:
* Section overview
* Section Members section




===[[:Category:Lab]]===
===[[:Category:Resource]]===
What is the VRLab - A lab


====Sub category:[[:Category:Computational_Resource]]====
Sub categories
** [[:Category:HPC]]
** [[:Category:Server]]


Properties:
* [[Property:computationResourceType]]
* [[Property:hasDescription]]
* [[Property:hasIPAddress]]
* [[Property:hasOperatingSystem]]
* [[Property:hasPrincipalInvestigator]]
* [[Property:hasProject]]
* [[Property:hasSection]]
* [[Property:hasSoftware]]
* [[Property:hasURL]]


===[[:Category:Tutorials]]===
===[[:Category:Tutorial]]===
Properties
* [[Property:relatesTo]]  ie. relatesTo::VRLab  
* [[Property:relatesTo]]  ie. relatesTo::VRLab  
* [[Property:hasDate]]
* [[Property:hasDate]]
[[Form:Tutorial]]
[[Template:Tutorial]]
==Instruments==
==[[:Category:Instrument]]==
===[[:Category:instrumenttype]]===
* [[Form:Instrument]]
* [[Template:Instrument]]
Properties
* [[Property:hasPID]]
* [[Property:hasImage]]
* [[Property:hasSerialNumber]]
* [[Property:hasPrincipalInvestigator]]
* [[Property:hasProject]]
* [[Property:hasSection]]
examples:
* [[CLARA-35]]
* [[CLARA-94]]
===[[:Category:InstrumentModel]]===
* [[Form:InstrumentModel]]
* [[Template:InstrumentModel]]
Properties
* [[Property:hasManufacturer]]
* [[Property:hasManual]]
* [[Property:hasImage]]
'''Question:''' how to use the form InstrumentModel in the Category Page
TODO:
* Ruisdael instruments to this wiki
* log subobjects???
* replace [[:Category:instrumenttype]] with [[:Category:Instrument]] ?
* create hostPC/instrumentPC pages, members of [[:Category:InstrumentPC]]
** with [[Property:connectedTo]] -> Instrument page
==Files (metadata)==
* [[Form:FileDescription]]
* [[Template:FileDescription]]
* [[Property:pertainsTo]]
* [[Property:hasDate]]
* [[Property:hasDescription]]
==[[:Category:Project]]==
* [[Form:Project]]
* [[Template:Project]]
* [[Property:hasSection]]
* [[Property:fromDate]]
* [[Property:toDate]]
* [[Property:hasPrincipalInvestigator]]
* [[Property:hasParticipant]]
* [[Property:hasStatus]]
* [[Property:hasDescription]]
==[[:Category:InstrumentPC]]==
TODO




Line 56: Line 164:
    
    
7. **Technical Wiki Documentation** (CORE)
7. **Technical Wiki Documentation** (CORE)
=Notes & References=
<references />

Latest revision as of 11:11, 22 April 2024

TODOs

Data Structures

Guiding principals of Data Structures

Leave more administrative content to the department's sharepoint (rule of thumb: anything the secretaries might need to read/edit, should be on sharepoint). (TODO: add link to sharepoint)

A semantic wiki instance might look like it has sections, but in essence it is all based on different "categories" of pages. For the most part, it is a flat page hierarchy (NO Subpages).

[SMW Help:Classification](https://www.semantic-mediawiki.org/wiki/Help:Classification) provides good info on using Categories and Properties to classify wiki pages.

Categories[1]

Categories are the main way to define what kind of a thing a page refers to.


All Categories and their Child Categories

Category:Person Namespace User:

Form:User Template:User

Category:Section

Form:Section Template:Section

TODO:

  • Section overview
  • Section Members section


Category:Resource

Sub category:Category:Computational_Resource

Sub categories

Properties:

Category:Tutorial

Properties

Form:Tutorial Template:Tutorial

Instruments

Category:Instrument

Category:instrumenttype

Properties

examples:

Category:InstrumentModel

Properties

Question: how to use the form InstrumentModel in the Category Page


TODO:


Files (metadata)


Category:Project

Category:InstrumentPC

TODO



Marc's suggestions

1. **General announcements and recent updates section**: (CORE)

2. **Research section**: (CORE)

  - Research projects (planned, ongoing and closed) including descriptions, objectives, team members
  - Research resources (infrastructure, hardware, methodologies, best practices, data management, full list to be defined..)

Andre Castro (talk) 16:52, 7 March 2024 (CET) It does not make sense that hardware is subdued to Research resources. As there might be hardware, like some tools, that are not Research resources.

3. **Education Section**: (CORE)

  - CORE: Information on student project supervision (Bachelor, Master, PhD), grading rubrics, graduation ceremonies
  - Optional: Information about BsC and MSc programs in which GRS is involved
  - Optional: Course inventory with course code, content description and teaching teams
  - Optional: Resources for teaching, assessment tools, academic support services etc..

4. **Administrative Section**: (CORE)

  - CORE: Departmental policies, procedures, and guidelines related to HR, finance, facilities, and safety.
  - CORE: Contact information for departmental administrators, IT support, and other key personnel.
  - Optional: Guidelines for collaboration with industry partners, startups, or government agencies.
  - Optional: Forms and templates for travel requests, expense reports, equipment procurement, and event planning.

5. **Valorization, Outreach and Knowledge transfer Section**: (OPTIONAL)

  - Optional: Case studies or success stories highlighting the department's impact on industry, society, or policy.
  - Optional: Resources for intellectual property management, technology transfer, and commercialization strategies.

6. **Collaboration Tools**: (OPTIONAL)

  - Optional: List of people, with affiliation, expertise, roles/responsibilities and contact information
  - Optional: Discussion forums for brainstorming ideas, seeking feedback, and proposing improvements to the Wiki
  

7. **Technical Wiki Documentation** (CORE)

Notes & References