Warning
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:BotanyBox/doc: Difference between revisions

From PsychonautWiki Archive
Jump to navigation Jump to search
← Older edit
>PJosepherum
mNo edit summary
>White
Grammatics
 
(6 intermediate revisions by 4 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:PJosepherum|PJosepherum]], or comment on the template's [[Template_Talk:SubstanceBox|discussion]] page.</big>'''
<big>'''An example of the template with all features enabled is available at [[Template:BotanyBox/Example]]. Please direct any queries to [[User:Apx|Apx]], or comment on the template's [[Template_Talk:?BotanyBox|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.
To standardise the format of the botanical index, we have created a modular template structure which should cover most use cases. For each table created, please create a subpage of [[Template:BotanyBox]] using the same tile as the substance article for simplicity. The template's wiki markup code can be found at [[Template:BotanyBox/Example]]. View source and copy the entire text over to the newly created subpage.


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.
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.
Line 8: Line 8:
===Table Properties===
===Table Properties===
<pre>
<pre>
     |MaterialTable_MaxWidth=auto
     |BotanyTable_MaxWidth=300px
     |MaterialTable_Title={{PAGENAME}}
     |BotanyTable_Title={{PAGENAME}}
</pre>
</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 '''BotanyTable_MaxWidth''' to a reasonable value, maybe a few pixels wider than the largest image included. If left blank, the table will default to 300px wide.
 
The '''BotanyTable_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>
<pre>
     |ModuleSource=true
     |ModuleSource=true
     |ModuleCombination=true
     |ModuleTaxonomicalNomenclature=true
     |ModuleStructure=true
     |ModuleCommonNomenclature=true
     |ModuleNomenclature=true
     |ModuleActiveConstituents=true
     |ModuleROA=true
     |ModuleInactiveConstituents=false
</pre>
</pre>


Line 27: Line 29:
===Source===
===Source===
<pre>
<pre>
     |PhotoImageFile=
     |PhotoImageFile=File:Cannabis_Plant.jpg
     |PhotoImageWidth=
     |PhotoImageWidth=250px
     |PhotoImageCaption=
     |PhotoImageCaption=Photo caption
</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.
 
===Combination===
<pre>
    |CombinationImage1_Caption=
    |CombinationImage1_File=
    |CombinationImage1_Width=
 
    |CombinationImage2_Caption=
    |CombinationImage2_File=
    |CombinationImage2_Width=
 
    |CombinationImage3_Caption=
    |CombinationImage3_File=
    |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.
 
===Structure===
<pre>
    |MolecularStructureCaption=
    |SkeletalImageFile=
    |SkeletalImageWidth=
    |3DImageFile=
    |3DImageWidth=
</pre>
</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.


===Nomenclature===
===Nomenclature===
<pre>
<pre>
     |NameCommon=
     |NameTaxonomy̜Kingdom=Plantae
     |NameSubstitution=
     |NameTaxonomy̜Unranked1=Angiosperms
     |NameSystematic=
     |NameTaxonomyUnranked2=Eudicots
    |NameTaxonomyUnranked3=Rosids
    |NameTaxonomyOrder=Rosales
    |NameTaxonomyFamily=Cannabaceae
    |NameTaxonomyGenus=Cannabis
    |NameTaxonomySpecies=Sativa & Indica
    |Synonyms=Cannabis sativa
    |NamesCommon=Weed, Cannabis, Sativa, Indica
</pre>
</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 full specification of the species described. 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.


For example:
===(In)active Constituents===
*'''NameCommon''' = ''O-Acetylpsilocybin'', ''4-AcO-DMT''
*'''NameSubstitution''' = ''4-Acetoxy-Dimethyltryptamine''
*'''NameSystematic''' = ''2-(1H-indol-3-yl)-N,N-dimethylethanamine''
 
===Dosage/Duration per ROA===
<pre>
<pre>
     |SmokedROA=false
     |ActiveConstituents=THC, CBD, etc
    |SmokedROA_Collapsed=true
     |InactiveConstituents=
    |SmokedROA_Caption='''WARNING:''' Always start with lower doses due to differences between individual body weight, tolerance, metabolism, and personal sensitivity.
    |SmokedROA_Bioavailability=
    |SmokedROA_Threshold=< x mg
    |SmokedROA_Light=x - x mg
    |SmokedROA_Common=x - x mg
    |SmokedROA_Strong=x - x mg
    |SmokedROA_Heavy= >  mg
    |SmokedROA_TimelineFile=
    |SmokedROA_TimelineWidth=
    |SmokedROA_Duration=x - x hours
    |SmokedROA_Onset=x minutes
    |SmokedROA_Comeup=x minutes
    |SmokedROA_Peak=x hours
    |SmokedROA_Offset=x hours
     |SmokedROA_Afterglow=x hours
</pre>
</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.
Please add links to substance articles where available.


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 =.
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; 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.
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; 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;
*Inhaled
*Smoked
*Oral
*Sublingual
*Buccal
*Insufflated
*Rectal
*Transdermal
*Subcutaneous
*Intramuscular
*Intravenous
==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.


==Subpages==
==Subpages==
Line 128: Line 64:


==See also==
==See also==
[[Template:SubstanceBox]]
*[[Template:MycologyBox]]
*[[Template:SubstanceBox]]
*[[Template:BookBox]]

Latest revision as of 11:48, 23 March 2017

About

An example of the template with all features enabled is available at Template:BotanyBox/Example. Please direct any queries to Apx, or comment on the template's discussion page.

To standardise the format of the botanical index, we have created a modular template structure which should cover most use cases. For each table created, please create a subpage of Template:BotanyBox using the same tile as the substance article for simplicity. The template's wiki markup code can be found at Template:BotanyBox/Example. View source and copy the entire text over to the newly created subpage.

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

    |BotanyTable_MaxWidth=300px
    |BotanyTable_Title={{PAGENAME}}

These properties define the table's properties. If you find that the table is unnecessarily wide, please set BotanyTable_MaxWidth to a reasonable value, maybe a few pixels wider than the largest image included. If left blank, the table will default to 300px wide. 

The BotanyTable_Title property can usually be left as is, except when the article's title is not a sufficient heading for the table.

Modules

    |ModuleSource=true
    |ModuleTaxonomicalNomenclature=true
    |ModuleCommonNomenclature=true
    |ModuleActiveConstituents=true
    |ModuleInactiveConstituents=false

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

    |PhotoImageFile=File:Cannabis_Plant.jpg
    |PhotoImageWidth=250px
    |PhotoImageCaption=Photo caption

Nomenclature

    |NameTaxonomy̜Kingdom=Plantae
    |NameTaxonomy̜Unranked1=Angiosperms
    |NameTaxonomyUnranked2=Eudicots
    |NameTaxonomyUnranked3=Rosids
    |NameTaxonomyOrder=Rosales
    |NameTaxonomyFamily=Cannabaceae
    |NameTaxonomyGenus=Cannabis
    |NameTaxonomySpecies=Sativa & Indica
    |Synonyms=Cannabis sativa
    |NamesCommon=Weed, Cannabis, Sativa, Indica

The nomenclature module is intended for full specification of the species described. 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.

(In)active Constituents

    |ActiveConstituents=THC, CBD, etc
    |InactiveConstituents=

Please add links to substance articles where available.

All fields are now optional. For ease of modification, please keep the entire template structure intact, removing only the values following =.

Subpages

See also

Retrieved from "http://psy.st/w/index.php?title=Template:BotanyBox/doc&oldid=82927"