Какие из этих имен являются именами файлов, а какие папками

Обновлено: 22.11.2024

Все файлы должны быть загружены в папки "_files", расположенные в самом верху каждой папки. Каждая родительская папка на сайте содержит одну папку.

Почему так важно, куда загружаются файлы? Связывание файлов друг с другом не только является хорошей практикой, но и помогает поддерживать чистоту системы веб-сайта. Чем он чище, тем лучше он работает и быстрее загружается.

Имена файлов

Следуйте этим правилам при именовании файлов:

Может содержать только буквы, цифры, тире, знаки подчеркивания и одну точку (для отделения расширения от имени файла);
Все должны быть строчными;
Не может содержать пробелов;
Не может содержать никаких специальных символов (кроме тире, подчеркивания и одной точки);
Должен описывать, что представляет собой файл.

ПРИМЕРЫ. Фотография, на которой изображен студент, сидящий за партой, должна называться «student-sitting-at-desk.jpg», а PDF-файл с повесткой дня заседания комитета должен называться «committee-meeting-agenda-20180630.pdf». " или что-то подобное.

Типы файлов

Никакие файлы нельзя загружать в обычную папку. Вместо этого все файлы (например, PDF-файлы, изображения и т. д.) должны быть загружены в специальные папки (названные "_files"), расположенные внутри каждой обычной папки.

Эти типы файлов можно загружать в папку "_files":

.jpg
Используется для фотографий и других изображений без большого количества текста.
.jpg
То же, что и выше, но с другим названием
.bmp
Вообще почти не используется
.jpg
В основном используется для логотипов и клипартов; фон может быть прозрачным, чтобы сливаться с фоном
.jpg
В основном используется для логотипов; фон может быть прозрачным, чтобы сливаться с фоном
.doc
Файл Microsoft Word
.docx
То же, что и выше, но с другим названием
.ppt
Файл Microsoft PowerPoint
.pptx
То же, что и выше, но с другим названием
.pdf
Файл Adobe PDF

ПРИМЕЧАНИЕ. Иногда бывает сложно определить фактический тип файла, с которым вы работаете, потому что велика вероятность того, что вы не видите расширения файлов (например, .jpg и .pdf). Чтобы свести к минимуму путаницу, мы рекомендуем обновить настройки ПК с Windows, чтобы отображались расширения файлов.

Соглашения об именах – это правила, позволяющие логично и логично давать названия электронным и физическим папкам, документам и записям. Это гарантирует, что правильные записи могут быть своевременно обнаружены, идентифицированы и извлечены из файловой системы, а также сохранены в соответствующем безопасном месте. В идеале лучше всего думать о том, как назвать и структурировать создаваемые вами документы и каталоги, в начале проекта.

Принципы соглашений об именах могут в равной степени применяться к электронным и физическим файлам/папкам/материалам.

Преимущества соглашений об именах

Последовательное, логичное и предсказуемое присвоение записям имен позволит с первого взгляда отличить похожие записи друг от друга, что облегчит хранение и извлечение данных. Благодаря согласованности и применению логических стандартов мы выигрываем от безопасного хранения и возможности находить информацию и получать к ней доступ.

Идентифицируемость файла

Хорошая практика требует, чтобы вся информация (файлы, наборы данных, документы или записи) была идентифицируемой и отслеживаемой. Этого можно добиться, следуя передовой практике, применяя ссылки ко всем документам/файлам.

Ссылки на документы/файлы будут включать:

Имя файла или полный путь к файлу, включая имя файла
Имя/роль автора(ов) файла или составителя(ей)
Дата создания, редактирования или события, являющегося предметом документа/файла
Номер версии, если применимо.

Удалите пробелы из имен файлов или используйте знаки препинания, такие как символы подчеркивания и дефисы, для разделения слов, например. «AHRC_TechnicalApp_Response20120925.docx» или «AHRC-TechnicalApp-Response20120925.docx», а не «что мы получили от спонсоров по поводу данных.docx»

Предлагаемые соглашения об именах файлов и папок

Имена файлов и папок должны быть короткими, но осмысленными.
Избегайте ненужных повторов и повторяющихся слов в именах файлов и путях к файлам.
Используйте для разделения слов заглавные буквы, а не пробелы.
При включении числа в имя файла всегда указывайте его двузначным числом, а не единицей, например 01, 02 … 99, если только это не год или другое число, состоящее более чем из двух цифр.
При использовании даты в имени файла всегда указывайте дату «сзади вперед» и используйте четыре цифры года, две цифры месяца и две цифры дня: ГГГГММДД или ГГГГММ, или ГГГГ, или ГГГГ-ГГГГ.
При включении личного имени в имя файла сначала укажите фамилию, а затем инициалы.
Избегайте использования общих слов, таких как "черновик" или "буква", в начале имен файлов, если только это не упростит поиск записи.
Упорядочить элементы в имени файла наиболее подходящим образом для извлечения записи.
Имена файлов записей, относящихся к повторяющимся событиям, должны включать дату и описание события, за исключением случаев, когда включение любого из этих элементов несовместимо с правилом 2.
Имена файлов корреспонденции должны включать имя корреспондента, указание темы, дату корреспонденции, а также входящую или исходящую корреспонденцию, за исключением случаев, когда включение любого из этих элементов несовместимо с правилом 2.
Имя файла вложения электронной почты должно включать имя корреспондента, указание темы, дату переписки, «вложение» и указание количества вложений, отправленных с сопроводительным письмом, за исключением случаев, когда включение любого из этих элементов было бы несовместимо с правилом 2.
Номер версии записи должен быть указан в имени файла путем включения «d», за которым следует номер версии, и, где применимо, «d», указывающий на «черновую версию».
Избегайте использования не буквенно-цифровых символов в именах файлов.

Эти соглашения взяты из работы Эдинбургского университета в рамках проекта управления записями AAPS и получили широкое распространение в качестве передовой практики.

Включите даты в формате ГГГГММДД. Их будет легко найти, и они будут отображаться в хронологическом порядке.
Не используйте чрезмерно длинные имена папок и файлов — могут возникнуть проблемы при резервном копировании, восстановлении или копировании данных.

Сделать имена файлов и каталогов строчными. Используйте дефисы, а не символы подчеркивания, для разделения слов, например, query-data.html . Используйте только стандартные буквенно-цифровые символы ASCII в именах файлов и каталогов.

Не используйте общие имена страниц, такие как document1.html .

Исключения для согласованности

Если вы добавляете в каталог, где все остальное уже использует знаки подчеркивания, и изменить все на дефисы невозможно, можно использовать символы подчеркивания, чтобы сохранить согласованность.

Например, если в каталоге уже есть урок_1.jd , урок_2.jd и урок_3.jd , можно добавить новый файл как урок_4.jd вместо урока-4.jd . Однако во всех остальных случаях используйте дефисы.

Иногда допустимо: избегание_cliches.jd

Не рекомендуется: избегайтеcliches.jd

Не рекомендуется: избегайтеCliches.jd

Не рекомендуется: избегать-clichés.jd

Другие исключения

Некоторое несоответствие в именах файлов — это нормально, если этого нельзя избежать другим способом. Например, иногда инструменты, создающие справочную документацию, создают имена файлов на основе различных требований к стилю или на основе дизайна и соглашений об именах самого продукта или API. В таких случаях можно сделать исключения для этих файлов.

Ссылка на файлы

В следующих разделах обсуждается, как ссылаться на файлы.

Ссылка на имена файлов

При обращении к конкретному файлу сделайте следующее:

Использовать кодовый шрифт.
Включите слово файл после имени файла. Дополнительные сведения см. в разделе Грамматическая обработка элементов кода.
Используйте точное написание имени файла, даже если оно не соответствует правилам именования.
Если образец файла включен на страницу, следуйте рекомендациям по образцам кода и предваряйте образец кода вступительным предложением или абзацем, содержащим имя файла.

Рекомендуется: в следующем файле build.sh измените значения по умолчанию для всех параметров:

Обратитесь к взаимодействию с файлами

При взаимодействии с файлами и типами файлов не используйте типы файлов в качестве глагола.

Рекомендуется: распаковать ZIP-файл.

Не рекомендуется: разархивируйте ZIP-файл.

См. типы файлов

Когда вы обсуждаете тип файла, используйте официальное название типа. (Имя типа файла часто пишется заглавными буквами, потому что многие имена типов файлов являются аббревиатурами или инициализмами.) Не используйте расширение имени файла для общего обозначения типа файла.

Рекомендуется: файл PNG

Не рекомендуется: файл .jpg

Рекомендуется: файл Bash

Не рекомендуется: файл .sh

В следующей таблице перечислены некоторые примеры расширений имен файлов и имена соответствующих типов файлов, которые можно использовать.

Расширение	Имя типа файла
.adoc	Файл AsciiDoc
.csv	CSV-файл
.exe	исполняемый файл
.jpg	GIF-файл
.img	файл образа диска< /td>
.jar	JAR-файл
.jpg , .jpg	Файл JPEG
.json	Файл JSON
.md	Файл уценки
.pdf	Файл PDF
.jpg	Файл PNG
. ps	Файл PowerShell
.py	Файл Python
. sh	Bash-файл
.sql	SQL-файл
. svg	SVG-файл
.tar	tar-файл
. txt	текстовый файл
.yaml	файл YAML
. zip	архив

Если не указано иное, содержимое этой страницы предоставляется по лицензии Creative Commons Attribution 4.0, а образцы кода — по лицензии Apache 2.0. Подробнее см. в Правилах сайта Google Developers. Java является зарегистрированным товарным знаком Oracle и/или ее дочерних компаний.

Grant-proposal-henry-edits-finalfinal.doc
Grant-proposal-final-Julia_edits_v4.doc
FINAL_proposal_Aug2016_kct-updated.doc

Это всего лишь один небольшой пример недостатка управления информацией, который может вызвать массу ненужных разочарований. Чем более организованно мы управляем информацией, будь то документы, электронные таблицы или мультимедиа, тем эффективнее и действеннее мы можем быть в нашей правозащитной деятельности. Вот почему соглашения об именах файлов так важны.

Соглашение об именах файлов — это систематический метод присвоения имен файлам, который облегчает их последующее извлечение. Согласованное и описательное соглашение позволит вам:

Узнавать содержимое файла, не открывая его
Находить и идентифицировать файлы, даже если они больше не находятся в исходной папке.
Легкий просмотр длинных списков файлов для инвентаризации или проверки их отсутствия.
Управлять файлами стало проще, даже если все они хранятся в одной центральной папке или каталоге.

Разработка соглашения об именах файлов

Имя файла может состоять из ряда описательных элементов, таких как ключевые слова, даты, идентификационные номера и т. д. Чтобы разработать соглашение об именовании файлов, вы должны решить, какие типы элементов следует включать и в каком порядке.< /p>

Например, соглашение об именах файлов может включать следующие компоненты в следующем порядке: [ГГММДД]_[Проект]_[Местоположение]_[Событие].xxx

Примеры имен файлов, основанные на этом примерном соглашении, могут быть такими:

160301_HRC_Geneva_launch.jpg
151208_Uwazi_Madrid_inception.pdf
160219_OHCHR_Tunis_meeting.jpg

Ниже приведены некоторые рекомендации по созданию собственного соглашения об именах файлов.

1. Подумайте, как вы хотите сортировать и извлекать файлы

Как вы хотите сортировать и извлекать файлы? Ответ на этот вопрос поможет определить некоторые важные компоненты вашего соглашения об именах файлов. Имейте в виду, что сортировка файлов выполняется слева направо.

Начните имя файла с самого важного параметра. Это позволит вам организовать файлы в алфавитном или хронологическом порядке по этому параметру без необходимости выполнять какой-либо поиск. Например, если основным способом доступа к файлу судебного дела является его номер, то он должен быть первым элементом в вашем соглашении об именовании файлов: когда вы сортируете свои документы в файловом менеджере, вы сначала увидите их по номеру дела.
Для дат используйте ГГГГ-ММ-ДД (или ГГГГММДД, или ГГММДД, или ГГММ). Чтобы обеспечить сортировку файлов в правильном хронологическом порядке, наиболее значимые компоненты даты и времени должны отображаться первыми, а затем наименее значимые компоненты. Если все остальные слова в имени файла совпадают, это соглашение позволит нам сортировать по году, затем по месяцу, а затем по дате. В некоторых соглашениях дата указывается перед каждым именем файла, потому что это наиболее логичный способ извлечения файлов для их команды.
Отметить разные версии одного и того же файла. Если файл будет поддерживаться с течением времени, используйте условное обозначение v1, v2, v3 и т. д., чтобы обозначить его место в последовательности версий. Вы можете отделить букву «v» от типа контента символом подчеркивания («_») или дефисом («-»). По мере создания и обновления версий меняйте версию, но сохраняйте имя файла прежним.
Не забывайте нули, если вам нужны порядковые номера. Если будет более девяти файлов с одинаковыми именами (например, в случае версии или в серии фотографий), убедитесь, что вы настроили номера следующим образом: 01, 02, 03, … Это позволит отсортировать их в хронологическом порядке. То же самое, если файлов более 99, это должно быть 001, …060, …099, …100

2. Используйте соответствующие компоненты в именах файлов, чтобы предоставить описание и контекст

Имена файлов должны содержать основные элементы каждого файла в зависимости от того, что подходит для ваших нужд поиска. Имена файлов должны существовать дольше человека, который первоначально назвал файл, поэтому подумайте, какая информация будет полезна кому-то через 15 лет.Потенциальные компоненты для правозащитных организаций включают:

Название организации
Программа или тема
Тип документа
Географический охват
Дата или период
Язык документа
Тип содержания, например "счет" или "отчет"

Имейте в виду, что вы, скорее всего, захотите использовать согласованные сокращения для этих компонентов, чтобы имена файлов были короткими.

3. Держите имя файла разумной длины

Длинные имена файлов плохо работают с некоторыми типами программного обеспечения, поэтому лучше делать их короткими. Для этого вы можете рассмотреть следующее:

Сокращение года до двух чисел вместо четырех.
Сокращение компонентов имени файла (например, используйте «inv» вместо «invoice» или «fr» вместо «francais»)
Используйте как можно меньше слов, чтобы передать подлинность документа.

4. Избегайте специальных символов и пробелов

Подчеркивание (например, file_name.xxx)
Дефисы (например, имя-файла.xxx)
Без разделения (например, имя файла.xxx)
Верблюжий регистр, когда первая буква каждого раздела текста пишется с большой буквы (например, FileName.xxx)

5. Задокументируйте свое соглашение об именах файлов и привлеките других пользователей

Важно записать правила именования файлов, чтобы они оставались согласованными. Если кто-то, кроме вас, дает имена файлам, то вдвойне важно документировать соглашение и хранить его в легкодоступном месте. Вы можете включить эту документацию в файл readme.txt в основной общей папке.

Вот два примера задокументированных соглашений об именах файлов от наших партнеров: один от Африканской комиссии по правам человека и народов (ACHPR), а другой от Международной комиссии юристов (ICJ).

Помимо текстовых файлов, вы также можете провести небольшое внутреннее обучение, чтобы объяснить, почему так важно использовать новое соглашение об именах файлов и как оно работает, или создать видео, в котором рассматриваются ключевые моменты соглашения.< /p>

Дополнительные ресурсы

Библиотеки Стэнфордского университета предлагают два иллюстративных тематических исследования для дальнейшего изучения соглашений об именах файлов:

Читайте также: