This is an unofficial archive of PsychonautWiki as of 2025-08-11T15:14:44Z. Content on this page may be outdated, incomplete, or inaccurate. Please refer to the original page for the most up-to-date information.
Template:SubstanceBox/document: Difference between revisions
>PJosepherum Created page with "==About== In an attempt to standardise the format of the substance index, we have created a modular template structure which should cover most use cases. For each table create..." |
>Catharsis m Catharsis moved page Template:SubstanceBox/doc to Template:SubstanceBox/document: Moved for distinction between "document" and DOC, the drug. Hopefully won't break anything |
||
| (28 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
==About== | ==About== | ||
'''<big>An example of the template with all features enabled is available at [[Template:SubstanceBox/Example]]. Please direct any queries to [[User:Apx|Apx]], or comment on the template's [[Template_Talk:SubstanceBox|discussion]] page.</big>''' | |||
In an attempt to standardise the format of the substance index, we have created a modular template structure which should cover most use cases. For each table created, please create a subpage on [[Template:SubstanceBox]] using the same tile as the substance article for simplicity. The template's wiki markup code can be found at [[Template:SubstanceBox/SourceCode]]. View source and copy the entire text over to the newly created subpage. | In an attempt to standardise the format of the substance index, we have created a modular template structure which should cover most use cases. For each table created, please create a subpage on [[Template:SubstanceBox]] using the same tile as the substance article for simplicity. The template's wiki markup code can be found at [[Template:SubstanceBox/SourceCode]]. View source and copy the entire text over to the newly created subpage. | ||
You may omit almost any value, | You may omit almost any value; however, please do not remove entire fields from the list as this may break compatibility. Any images referenced must also specify their width in pixels. | ||
===Table Properties=== | ===Table Properties=== | ||
< | <pre> | ||
|MaterialTable_MaxWidth=auto | |MaterialTable_MaxWidth=auto | ||
|MaterialTable_Title={{PAGENAME}}</ | |MaterialTable_Title={{PAGENAME}} | ||
</pre> | |||
These properties define the table's properties. If you find that the table is unnecessarily wide, please set '''MaterialTable_MaxWidth''' to a reasonable value, maybe a few pixels wider than the largest image included. The '''MaterialTable_Title''' property can usually be left as is, except when the article's title is not a sufficient heading for the table. | These properties define the table's properties. If you find that the table is unnecessarily wide, please set '''MaterialTable_MaxWidth''' to a reasonable value, maybe a few pixels wider than the largest image included. The '''MaterialTable_Title''' property can usually be left as is, except when the article's title is not a sufficient heading for the table. | ||
===Modules=== | ===Modules=== | ||
< | <pre> | ||
|ModuleSource=true | |ModuleSource=true | ||
|ModuleCombination=true | |ModuleCombination=true | ||
|ModuleStructure=true | |ModuleStructure=true | ||
|ModuleNomenclature=true | |ModuleNomenclature=true | ||
|ModuleROA=true</ | |ModuleROA=true | ||
</pre> | |||
There are several optional modules included in the template, as explained below. Please set any unused modules to false, but do not remove the field as this may break compatibility. | There are several optional modules included in the template, as explained below. Please set any unused modules to false, but do not remove the field as this may break compatibility. | ||
===Source=== | ===Source=== | ||
< | <pre> | ||
|PhotoImageFile= | |PhotoImageFile= | ||
|PhotoImageWidth= | |PhotoImageWidth= | ||
|PhotoImageCaption=</ | |PhotoImageCaption= | ||
</pre> | |||
The ''source'' module creates an image thumbnail and caption for use on articles which describe herbs, plants and combinations of substances. Please [[Special:Upload|upload]] only licenced photos of acceptable quality, and include a link to the source. Do not omit any fields if this module is used. | The ''source'' module creates an image thumbnail and caption for use on articles which describe herbs, plants and combinations of substances. Please [[Special:Upload|upload]] only licenced photos of acceptable quality, and include a link to the source. Do not omit any fields if this module is used. | ||
===Combination=== | ===Combination=== | ||
< | <pre> | ||
|CombinationImage1_Caption= | |CombinationImage1_Caption= | ||
|CombinationImage1_File= | |CombinationImage1_File= | ||
| Line 43: | Line 46: | ||
|CombinationImage3_Caption= | |CombinationImage3_Caption= | ||
|CombinationImage3_File= | |CombinationImage3_File= | ||
|CombinationImage3_Width=</ | |CombinationImage3_Width= | ||
</pre> | |||
The ''combination'' module is intended for materials which contain multiple active ingredients such as plants, herbs, OTC medication, and breakdowns of drug combinations. Up to three images can be presented in this module, all with optional captions. You must include the image's width in pixels for it to render correctly. If three images is insufficient, please contact [[User:PJosepherum|PJosepherum]]. Do not remove any unused fields from the list as this may break compatibility. | The ''combination'' module is intended for materials which contain multiple active ingredients such as plants, herbs, OTC medication, and breakdowns of drug combinations. Up to three images can be presented in this module, all with optional captions. You must include the image's width in pixels for it to render correctly. If three images is insufficient, please contact [[User:PJosepherum|PJosepherum]]. Do not remove any unused fields from the list as this may break compatibility. | ||
===Structure=== | ===Structure=== | ||
< | <pre> | ||
|MolecularStructureCaption= | |MolecularStructureCaption= | ||
|SkeletalImageFile= | |SkeletalImageFile= | ||
|SkeletalImageWidth= | |SkeletalImageWidth= | ||
|3DImageFile= | |3DImageFile= | ||
|3DImageWidth=</ | |3DImageWidth= | ||
</pre> | |||
The structure module allows for a skeletal diagram and 3D image, both of which are optional. '''MolecularStructureCaption''' is intended to indicate factors such as chirality of the active enantiomer, or any other comments. Please specify the image width in pixels if included. | The structure module allows for a skeletal diagram and 3D image, both of which are optional. '''MolecularStructureCaption''' is intended to indicate factors such as chirality of the active enantiomer, or any other comments. Please specify the image width in pixels if included. | ||
===Nomenclature=== | ===Nomenclature=== | ||
< | <pre> | ||
|NameCommon= | |NameCommon= | ||
|NameSubstitution= | |NameSubstitution= | ||
|NameSystematic=</ | |NameSystematic= | ||
</pre> | |||
The ''nomenclature'' module is intended for single molecules only. All fields are optional, any values that are omitted will simply not appear in the table. '''NameCommon''' can be set as a comma separated list to specify multiple names. Please verify the substitution and systemic names if used. | The ''nomenclature'' module is intended for single molecules only. All fields are optional, any values that are omitted will simply not appear in the table. '''NameCommon''' can be set as a comma separated list to specify multiple names. Please verify the substitution and systemic names if used. | ||
| Line 69: | Line 75: | ||
*'''NameSubstitution''' = ''4-Acetoxy-Dimethyltryptamine'' | *'''NameSubstitution''' = ''4-Acetoxy-Dimethyltryptamine'' | ||
*'''NameSystematic''' = ''2-(1H-indol-3-yl)-N,N-dimethylethanamine'' | *'''NameSystematic''' = ''2-(1H-indol-3-yl)-N,N-dimethylethanamine'' | ||
===ClassMembership=== | |||
<pre> | |||
|ChemicalClass= | |||
|EffectClass= | |||
</pre> | |||
The ''ClassMembership'' module displays a substance's chemical classification and the classification of its most obvious effect. | |||
For example: | |||
*'''ChemicalClass''' = ''[[Tryptamine]]'' | |||
*'''EffectClass''' = ''[[Psychedelic]]'' | |||
===Dosage/Duration per ROA=== | ===Dosage/Duration per ROA=== | ||
< | <pre> | ||
|SmokedROA=false | |SmokedROA=false | ||
|SmokedROA_Collapsed=true | |SmokedROA_Collapsed=true | ||
|SmokedROA_Caption= | |SmokedROA_Caption= | ||
|SmokedROA_Bioavailability= | |SmokedROA_Bioavailability= | ||
|SmokedROA_Threshold=< x mg | |SmokedROA_Threshold=< x mg | ||
| Line 85: | Line 103: | ||
|SmokedROA_Duration=x - x hours | |SmokedROA_Duration=x - x hours | ||
|SmokedROA_Onset=x minutes | |SmokedROA_Onset=x minutes | ||
|SmokedROA_Comeup=x minutes | |||
|SmokedROA_Peak=x hours | |SmokedROA_Peak=x hours | ||
|SmokedROA_Offset=x hours | |SmokedROA_Offset=x hours | ||
| | |SmokedROA_After Effects=x hours | ||
</pre> | |||
This isn't perfect and really I should translate the whole thing into a LUA module, but for now we have this nice looking expandable dosage/duration table for all likely routes of administration. | This isn't perfect and really I should translate the whole thing into a LUA module, but for now we have this nice looking expandable dosage/duration table for all likely routes of administration. | ||
All fields | All fields are now [https://www.mediawiki.org/wiki/Topic:Sofq393lbv64a8gu optional]. For ease of modification, please keep the entire template structure intact, removing only the values following =. | ||
'''xxxROA_Collapsed''' is set to ''true'' by default, | '''xxxROA_Collapsed''' is set to ''true'' by default; however, this should be disabled for the first ROA, or the most popular; whichever feels right. | ||
The '''xxxROA_Caption''' is standard but can be customised if necessary. Please assume no tolerance while sourcing dosage information. For standardisation, use angle brackets '''< >''' and tildes '''~''' for estimations rather than '''+''' or '''-''' symbols. | The '''xxxROA_Caption''' is standard but can be customised if necessary. Please assume no tolerance while sourcing dosage information. For standardisation, use angle brackets '''< >''' and tildes '''~''' for estimations rather than '''+''' or '''-''' symbols. | ||
There is a cool feature included whereby we can create a '''xxxROA_TimelineFile''' image to upload and include in the table. Erowid's are suitable, | There is a cool feature included whereby we can create a '''xxxROA_TimelineFile''' image to upload and include in the table. Erowid's are suitable; however, we would like to generate them at a later date in a consistent format. Any images included must have widths specified. | ||
Do your best judgement with durations. Since they will vary amongst subjects, feel free to denote estimations again using angle brackets '''< >''', tildes '''~''', or a dash '''-'''. Any value omitted will not appear in the table, | Do your best judgement with durations. Since they will vary amongst subjects, feel free to denote estimations again using angle brackets '''< >''', tildes '''~''', or a dash '''-'''. Any value omitted will not appear in the table; however, please do not remove any of the fields from the template as this may break compatibility. | ||
The list of currently included routes of administration are as follows; | The list of currently included routes of administration are as follows; | ||
*Inhaled | |||
*Smoked | *Smoked | ||
*Oral | *Oral | ||
| Line 114: | Line 135: | ||
==Support== | ==Support== | ||
Read again from the top. If you're still confused, please contact [[User:PJosepherum|PJosepherum]] or leave a note on the [[Template_Talk:SubstanceBox|discussion]] page. | Read again from the top. If you're still confused, please contact [[User:PJosepherum|PJosepherum]] or leave a note on the [[Template_Talk:SubstanceBox|discussion]] page. | ||
==Subpages== | |||
{{Special:PrefixIndex/Template:SubstanceBox/}} | |||
==See also== | |||
[[Template:BotanyBox]] | |||